Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Action: Add new actions to the bottom of the panel and auto scroll #26864

Merged
merged 2 commits into from
Apr 17, 2024
Merged

Action: Add new actions to the bottom of the panel and auto scroll #26864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a189bb
Add new actions to the bottom of the panel and auto scroll
kasperpeulen Apr 17, 2024
a3565f2
Address review
kasperpeulen Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 43 additions & 32 deletions code/addons/actions/src/components/ActionLogger/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
import type { FC, PropsWithChildren } from 'react';
import React, { Fragment } from 'react';
import { styled, withTheme } from '@storybook/theming';
import type { ElementRef, ReactNode } from 'react';
import React, { forwardRef, Fragment, useEffect, useRef } from 'react';
import type { Theme } from '@storybook/theming';
import { styled, withTheme } from '@storybook/theming';

import { Inspector } from 'react-inspector';
import { ActionBar, ScrollArea } from '@storybook/components';

import { Action, InspectorContainer, Counter } from './style';
import { Action, Counter, InspectorContainer } from './style';
import type { ActionDisplay } from '../../models';

const UnstyledWrapped: FC<PropsWithChildren<{ className?: string }>> = ({
children,
className,
}) => (
<ScrollArea horizontal vertical className={className}>
{children}
</ScrollArea>
const UnstyledWrapped = forwardRef<HTMLDivElement, { children: ReactNode; className?: string }>(
({ children, className }, ref) => (
<ScrollArea ref={ref} horizontal vertical className={className}>
{children}
</ScrollArea>
)
Comment on lines +12 to +17
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I know you just lightly changed the code, but this UnstyledWrapped component looks unnecessary to me, I feel like all of this can just be written directly in the ActionLogger JSX.

);
UnstyledWrapped.displayName = 'UnstyledWrapped';

export const Wrapper = styled(UnstyledWrapped)({
margin: 0,
padding: '10px 5px 20px',
Expand All @@ -39,24 +40,34 @@ interface ActionLoggerProps {
onClear: () => void;
}

export const ActionLogger = ({ actions, onClear }: ActionLoggerProps) => (
<Fragment>
<Wrapper>
{actions.map((action: ActionDisplay) => (
<Action key={action.id}>
{action.count > 1 && <Counter>{action.count}</Counter>}
<InspectorContainer>
<ThemedInspector
sortObjectKeys
showNonenumerable={false}
name={action.data.name}
data={action.data.args || action.data}
/>
</InspectorContainer>
</Action>
))}
</Wrapper>

<ActionBar actionItems={[{ title: 'Clear', onClick: onClear }]} />
</Fragment>
);
export const ActionLogger = ({ actions, onClear }: ActionLoggerProps) => {
const wrapperRef = useRef<ElementRef<typeof Wrapper>>(null);
const wrapper = wrapperRef.current;
const wasAtBottom = wrapper && wrapper.scrollHeight - wrapper.scrollTop === wrapper.clientHeight;

useEffect(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's put a comment here explaining what this whole thing does and why.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

// Scroll to bottom, when the action panel was already scrolled down
if (wasAtBottom) wrapperRef.current.scrollTop = wrapperRef.current.scrollHeight;
}, [wasAtBottom, actions.length]);

return (
<Fragment>
<Wrapper ref={wrapperRef}>
{actions.map((action: ActionDisplay) => (
<Action key={action.id}>
{action.count > 1 && <Counter>{action.count}</Counter>}
<InspectorContainer>
<ThemedInspector
sortObjectKeys
showNonenumerable={false}
name={action.data.name}
data={action.data.args || action.data}
/>
</InspectorContainer>
</Action>
))}
</Wrapper>
<ActionBar actionItems={[{ title: 'Clear', onClick: onClear }]} />
</Fragment>
);
};
4 changes: 2 additions & 2 deletions code/addons/actions/src/containers/ActionLogger/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ export default class ActionLogger extends Component<ActionLoggerProps, ActionLog
addAction = (action: ActionDisplay) => {
this.setState((prevState: ActionLoggerState) => {
const actions = [...prevState.actions];
const previous = actions.length && actions[0];
const previous = actions.length && actions[actions.length - 1];
if (previous && safeDeepEqual(previous.data, action.data)) {
previous.count++;
} else {
action.count = 1;
actions.unshift(action);
actions.push(action);
}
return { actions: actions.slice(0, action.options.limit) };
});
Expand Down
65 changes: 32 additions & 33 deletions code/ui/components/src/components/ScrollArea/ScrollArea.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, { forwardRef } from 'react';
import { styled } from '@storybook/theming';
import * as ScrollAreaPrimitive from '@radix-ui/react-scroll-area';

Expand Down Expand Up @@ -75,36 +75,35 @@ const ScrollAreaThumb = styled(ScrollAreaPrimitive.Thumb)(({ theme }) => ({
},
}));

export const ScrollArea = ({
children,
horizontal = false,
vertical = false,
offset = 2,
scrollbarSize = 6,
className,
}: ScrollAreaProps) => (
<ScrollAreaRoot scrollbarsize={scrollbarSize} offset={offset} className={className}>
<ScrollAreaViewport>{children}</ScrollAreaViewport>
{horizontal && (
<ScrollAreaScrollbar
orientation="horizontal"
offset={offset}
horizontal={horizontal.toString()}
vertical={vertical.toString()}
>
<ScrollAreaThumb />
</ScrollAreaScrollbar>
)}
{vertical && (
<ScrollAreaScrollbar
orientation="vertical"
offset={offset}
horizontal={horizontal.toString()}
vertical={vertical.toString()}
>
<ScrollAreaThumb />
</ScrollAreaScrollbar>
)}
{horizontal && vertical && <ScrollAreaPrimitive.Corner />}
</ScrollAreaRoot>
export const ScrollArea = forwardRef<HTMLDivElement, ScrollAreaProps>(
(
{ children, horizontal = false, vertical = false, offset = 2, scrollbarSize = 6, className },
ref
) => (
<ScrollAreaRoot scrollbarsize={scrollbarSize} offset={offset} className={className}>
<ScrollAreaViewport ref={ref}>{children}</ScrollAreaViewport>
{horizontal && (
<ScrollAreaScrollbar
orientation="horizontal"
offset={offset}
horizontal={horizontal.toString()}
vertical={vertical.toString()}
>
<ScrollAreaThumb />
</ScrollAreaScrollbar>
)}
{vertical && (
<ScrollAreaScrollbar
orientation="vertical"
offset={offset}
horizontal={horizontal.toString()}
vertical={vertical.toString()}
>
<ScrollAreaThumb />
</ScrollAreaScrollbar>
)}
{horizontal && vertical && <ScrollAreaPrimitive.Corner />}
</ScrollAreaRoot>
)
);
ScrollArea.displayName = 'ScrollArea';