Skip to content

chore: add storybook to document available components #6921

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

Draft
mcasimir wants to merge 20 commits into
base: main
Choose a base branch
from
Draft

chore: add storybook to document available components #6921

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
83d8548
chore: add storybook
mcasimir May 13, 2025
5066b8c
wip
mcasimir May 13, 2025
b3c4e9f
style preview
mcasimir May 13, 2025
e43b7ca
fix some of the stories
mcasimir May 13, 2025
7cccfe7
modals
mcasimir May 13, 2025
b261cf5
more docs
mcasimir May 13, 2025
18890e3
more docs
mcasimir May 13, 2025
2993bd9
convert to mdx
mcasimir May 14, 2025
cd2e10b
structure
mcasimir May 14, 2025
99b06ea
structure
mcasimir May 14, 2025
a2ce783
fix
mcasimir May 14, 2025
b0ef5b4
editor props
mcasimir May 14, 2025
9848fc4
cleanup
mcasimir May 14, 2025
92ab02c
fix virtual grid
mcasimir May 14, 2025
4b2d097
fix virtual grid
mcasimir May 14, 2025
2927b81
fix list darkmode
mcasimir May 14, 2025
14162cc
fix darkmode
mcasimir May 14, 2025
32a5234
fix empty content
mcasimir May 14, 2025
79e8107
fix document properties
mcasimir May 14, 2025
7e65f18
Merge branch 'main' into add-storybook
mcasimir May 27, 2025
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
Prev Previous commit
Next Next commit
structure
  • Loading branch information
@mcasimir
mcasimir committed May 14, 2025
commit 99b06ea21073dcde9a2142252e41d53e3ce4a060
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/accordion.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { css } from '@leafygreen-ui/emotion';
import { spacing } from '@leafygreen-ui/tokens';

<Meta
title="Components/Accordion"
title="Components/Layout/Accordion"
component={Accordion}
parameters={{
layout: 'centered',
Expand Down
33 changes: 15 additions & 18 deletions packages/compass-components/src/components/breadcrumb.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ import { Breadcrumbs } from './breadcrumb';
import { css } from '@leafygreen-ui/emotion';
import { spacing } from '@leafygreen-ui/tokens';

// eslint-disable-next-line @typescript-eslint/no-empty-function
const noop = () => {};

<Meta
title="Components/Navigation/Breadcrumb"
component={Breadcrumbs}
Expand Down Expand Up @@ -85,10 +82,10 @@ const customStyles = css({
});

const items = [
{ name: 'Home', onClick: () => noop() },
{ name: 'Databases', onClick: () => noop() },
{ name: 'myapp', onClick: () => noop() },
{ name: 'users', onClick: () => noop() },
{ name: 'Home', onClick: () => {} },
{ name: 'Databases', onClick: () => {} },
{ name: 'myapp', onClick: () => {} },
{ name: 'users', onClick: () => {} },
];

return (
Expand Down Expand Up @@ -116,13 +113,13 @@ This demonstrates the standard usage of the Breadcrumbs component.
});

const items = [
{ name: 'Home', onClick: () => noop() },
{ name: 'Databases', onClick: () => noop() },
{ name: 'myapp', onClick: () => noop() },
{ name: 'users', onClick: () => noop() },
{ name: 'Home', onClick: () => {} },
{ name: 'Databases', onClick: () => {} },
{ name: 'myapp', onClick: () => {} },
{ name: 'users', onClick: () => {} },
{
name: 'very-long-collection-name-that-should-be-truncated',
onClick: () => noop(),
onClick: () => {},
},
];

Expand Down Expand Up @@ -151,8 +148,8 @@ This demonstrates how the component handles long text in items.
});

const items = [
{ name: 'Home', onClick: () => noop() },
{ name: 'Databases', onClick: () => noop() },
{ name: 'Home', onClick: () => {} },
{ name: 'Databases', onClick: () => {} },
];

return (
Expand Down Expand Up @@ -180,10 +177,10 @@ This demonstrates how the component looks with fewer items.
});

const items = [
{ name: 'Home', onClick: () => noop() },
{ name: 'Databases', onClick: () => noop() },
{ name: 'myapp', onClick: () => noop() },
{ name: 'users', onClick: () => noop() },
{ name: 'Home', onClick: () => {} },
{ name: 'Databases', onClick: () => {} },
{ name: 'myapp', onClick: () => {} },
{ name: 'users', onClick: () => {} },
];

const customStyles = css({
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/bson-value.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
} from 'bson';

<Meta
title="Components/BSONValue"
title="Components/Data/BSONValue"
component={BSONValue}
parameters={{
layout: 'centered',
Expand Down
2 changes: 1 addition & 1 deletion ...pass-components/src/components/document-list/document-actions-group.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta, Story, Controls } from '@storybook/blocks';
import DocumentActionsGroup from './document-actions-group';

<Meta
title="Components/DocumentList/DocumentActionsGroup"
title="Components/Data/DocumentActionsGroup"
component={DocumentActionsGroup}
parameters={{ layout: 'centered' }}
/>
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/document-list/document.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import Document from './document';
import { Document as HadronDocument } from 'hadron-document';

<Meta
title="Components/DocumentList/Document"
title="Components/Data/Document"
component={Document}
parameters={{ layout: 'centered' }}
/>
Expand Down
2 changes: 1 addition & 1 deletion ...ompass-components/src/components/document-list/visible-field-toggle.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta, Story, Controls } from '@storybook/blocks';
import VisibleFieldsToggle from './visible-field-toggle';

<Meta
title="Components/DocumentList/VisibleFieldsToggle"
title="Components/Data/VisibleFieldsToggle"
component={VisibleFieldsToggle}
parameters={{ layout: 'centered' }}
/>
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/horizontal-rule.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta, Story, Controls } from '@storybook/blocks';
import { HorizontalRule } from './horizontal-rule';

<Meta
title="Components/HorizontalRule"
title="Components/Layout/HorizontalRule"
component={HorizontalRule}
parameters={{ layout: 'centered' }}
argTypes={{
Expand Down
5 changes: 4 additions & 1 deletion packages/compass-components/src/components/interactive-popover.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ import { Meta, Story, Controls } from '@storybook/addon-docs';
import { InteractivePopover } from './interactive-popover';
import { Button } from './leafygreen';

<Meta title="Components/InteractivePopover" component={InteractivePopover} />
<Meta
title="Components/Feedback/InteractivePopover"
component={InteractivePopover}
/>

# InteractivePopover

Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/keyline-card.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta, Story, Controls } from '@storybook/blocks';
import { KeylineCard } from './keyline-card';

<Meta
title="Components/KeylineCard"
title="Components/Layout/KeylineCard"
component={KeylineCard}
parameters={{ layout: 'centered' }}
argTypes={{
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/links/link.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
import { Icon } from '../leafygreen';

<Meta
title="Components/Links/Link"
title="Components/Navigation/Link"
component={Link}
parameters={{ layout: 'centered' }}
/>
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/modals/modal.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { ModalFooterButton } from './modal-footer-button';
import { Button } from '../leafygreen';

<Meta
title="Components/Modals/Modal"
title="Components/Feedback/Modal"
component={Modal}
parameters={{
layout: 'centered',
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/resize-handle.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { palette } from '@leafygreen-ui/palette';
import { Resizable } from 're-resizable';

<Meta
title="Components/ResizeHandle"
title="Components/Layout/ResizeHandle"
component={ResizeHandle}
parameters={{
layout: 'centered',
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/resizeable-sidebar.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta, Story, Controls } from '@storybook/blocks';
import ResizableSidebar, { defaultSidebarWidth } from './resizeable-sidebar';

<Meta
title="Components/ResizableSidebar"
title="Components/Layout/ResizableSidebar"
component={ResizableSidebar}
parameters={{ layout: 'centered' }}
argTypes={{
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-components/src/components/workspace-container.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { css } from '@leafygreen-ui/emotion';
import { spacing } from '@leafygreen-ui/tokens';

<Meta
title="Components/WorkspaceContainer"
title="Components/Layout/WorkspaceContainer"
component={WorkspaceContainer}
parameters={{ controls: { expanded: true } }}
argTypes={{
Expand Down
2 changes: 1 addition & 1 deletion ...ges/compass-components/src/components/workspace-tabs/workspace-tabs.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta, Story, Controls } from '@storybook/blocks';
import { WorkspaceTabs } from './workspace-tabs';

<Meta
title="Components/WorkspaceTabs"
title="Components/Navigation/WorkspaceTabs"
component={WorkspaceTabs}
parameters={{ layout: 'centered' }}
argTypes={{
Expand Down