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.

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

Already on GitHub? Sign in to your account

UI: Fix ArgsTable empty state on docs #23688

Merged
merged 7 commits into from
Aug 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 3 additions & 13 deletions code/ui/blocks/src/blocks/DocsPage.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import type { Meta, StoryObj } from '@storybook/react';
import { within } from '@storybook/testing-library';
import { DocsPage } from './DocsPage';

const meta = {
component: DocsPage,
parameters: {
docsStyles: true,
chromatic: {
disableSnapshot: true,
},
},
} satisfies Meta<typeof DocsPage>;

Expand All @@ -17,20 +19,8 @@ export const Default: Story = {
parameters: {
relativeCsfPaths: ['../examples/Button.stories'],
},
play: async ({ canvasElement }) => {
// This play function's sole purpose is to add a "chromatic ignore" region to a flaky row.
const canvas = within(canvasElement);
const sizeCell = await canvas.findByText('How large should the button be?');
const sizeRow = sizeCell.parentElement?.parentElement?.parentElement;
if (sizeRow?.nodeName === 'TR') {
sizeRow.setAttribute('data-chromatic', 'ignore');
} else {
throw new Error('the DOM structure changed, please update this test');
}
},
};
export const SingleStory: Story = {
...Default,
parameters: {
relativeCsfPaths: ['../examples/DocsPageParameters.stories'],
},
Expand Down
3 changes: 2 additions & 1 deletion code/ui/blocks/src/components/ArgsTable/ArgsTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,8 @@ export const ArgsTable: FC<ArgsTableProps> = (props) => {
const hasNoUngrouped = groups.ungrouped.length === 0;
const hasNoSections = Object.entries(groups.sections).length === 0;
const hasNoUngroupedSubsections = Object.entries(groups.ungroupedSubsections).length === 0;
if (hasNoUngrouped && hasNoSections && hasNoUngroupedSubsections) return <Empty />;
if (hasNoUngrouped && hasNoSections && hasNoUngroupedSubsections)
return <Empty inAddonPanel={inAddonPanel} />;

let colSpan = 1;
if (updateArgs) colSpan += 1;
Expand Down
82 changes: 54 additions & 28 deletions code/ui/blocks/src/components/ArgsTable/Empty.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@ import React, { useEffect, useState } from 'react';
import { styled } from '@storybook/theming';
import { Icon, Link } from '@storybook/components/experimental';

const Wrapper = styled.div({
height: '100%',
interface EmptyProps {
inAddonPanel?: boolean;
}

const Wrapper = styled.div<{ inAddonPanel?: boolean }>(({ inAddonPanel, theme }) => ({
height: inAddonPanel ? '100%' : 'auto',
display: 'flex',
border: inAddonPanel ? 'none' : `1px solid ${theme.appBorderColor}`,
borderRadius: inAddonPanel ? 0 : theme.appBorderRadius,
padding: inAddonPanel ? 0 : 40,
alignItems: 'center',
justifyContent: 'center',
flexDirection: 'column',
gap: 15,
});
background: theme.background.content,
boxShadow: 'rgba(0, 0, 0, 0.10) 0 1px 3px 0',
}));

const Content = styled.div({
display: 'flex',
Expand Down Expand Up @@ -45,16 +54,16 @@ const Divider = styled.div(({ theme }) => ({
}));

const VideoIcon = styled.div(({ theme }) => ({
width: 24,
height: 18,
width: 22,
height: 16,
borderRadius: theme.appBorderRadius,
border: `1px solid ${theme.color.secondary}`,
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}));

export const Empty: FC = () => {
export const Empty: FC<EmptyProps> = ({ inAddonPanel }) => {
const [isLoading, setIsLoading] = useState(true);

// We are adding a small delay to avoid flickering when the story is loading.
Expand All @@ -71,35 +80,52 @@ export const Empty: FC = () => {
if (isLoading) return null;

return (
<Wrapper>
<Wrapper inAddonPanel={inAddonPanel}>
<Content>
<Title>Interactive story playground</Title>
<Title>
{inAddonPanel
? 'Interactive story playground'
: "Args table with interactive controls couldn't be auto-generated"}
</Title>
<Description>
Controls give you an easy to use interface to test your components. Set your story args
and you&apos;ll see controls appearing here automatically.
</Description>
</Content>
<Links>
<Link
href="https://youtu.be/0gOfS6K0x0E"
target="_blank"
icon={
<VideoIcon>
<Icon.Play size={10} />
</VideoIcon>
}
withArrow
>
Watch 5m video
</Link>
<Divider />
<Link
href="https://storybook.js.org/docs/react/essentials/controls"
target="_blank"
withArrow
>
Read docs
</Link>
{inAddonPanel && (
<>
<Link
href="https://youtu.be/0gOfS6K0x0E"
target="_blank"
icon={
<VideoIcon>
<Icon.Play size={8} />
</VideoIcon>
}
withArrow
>
Watch 5m video
</Link>
<Divider />
<Link
href="https://storybook.js.org/docs/react/essentials/controls"
target="_blank"
withArrow
>
Read docs
</Link>
</>
)}
{!inAddonPanel && (
<Link
href="https://storybook.js.org/docs/react/essentials/controls"
target="_blank"
withArrow
>
Learn how to set that up
</Link>
)}
</Links>
</Wrapper>
);
Expand Down
6 changes: 3 additions & 3 deletions code/ui/components/src/new/Link/Link.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ const StyledLink = styled.a<Omit<LinkProps, 'children'>>(({ theme, variant = 'pr
display: 'inline-flex',
gap: 4,
alignItems: 'center',
fontSize: theme.typography.size.s2 - 1,
transition: 'all 150ms ease-out',
textDecoration: 'none',
lineHeight: 1,
Expand Down Expand Up @@ -70,8 +69,9 @@ const StyledLink = styled.a<Omit<LinkProps, 'children'>>(({ theme, variant = 'pr
},
}));

const StyledLeft = styled.span({
const StyledLeft = styled.span(({ theme }) => ({
display: 'inline-flex',
gap: 6,
alignItems: 'center',
});
fontSize: theme.typography.size.s2 - 1,
}));