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

Feat: Storybook: Improve component organisation - Overlays Category - Issue #66275 #66657

Merged
merged 5 commits into from
Nov 12, 2024
+12 −6
Merged

Feat: Storybook: Improve component organisation - Overlays Category - Issue #66275 #66657

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ddc323
Group the overlay components in storybook
hbhalodia Nov 1, 2024
ca42f5a
Merge branch 'trunk' into feat/issue-66275-overlays
hbhalodia Nov 7, 2024
31b1e50
Fix the id for the experimental components
hbhalodia Nov 7, 2024
86c3f8e
Remove unwanted changes from the PR
hbhalodia Nov 8, 2024
95fad83
Merge branch 'trunk' into feat/issue-66275-overlays
hbhalodia Nov 8, 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
3 changes: 2 additions & 1 deletion packages/components/src/confirm-dialog/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ import { ConfirmDialog } from '../component';

const meta: Meta< typeof ConfirmDialog > = {
component: ConfirmDialog,
title: 'Components (Experimental)/ConfirmDialog',
title: 'Components (Experimental)/Overlays/ConfirmDialog',
Copy link
Member

Choose a reason for hiding this comment

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

Another thing (cc @ciampo @mirka): experimental components will fall in their own section down below, meaning they will have their own Overlays directory. Is that desired? Should we consider marking the experimental components just with badges, like CustomSelectControlV2 is marked WIP?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

experimental components will fall in their own section down below, meaning they will have their own Overlays directory

Waiting on this for confirmation.

Copy link
Member

Choose a reason for hiding this comment

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

I've been discussing this with @ciampo, and we concluded that it's a problem that can be solved separately.

In the future we may remove the "Experimental" distinction from the Storybook component list, and those categories that we're introducing will be on the top level. That being said, we could leave things as they are and ship this PR, and I've opened #66805 to discuss this separately.

id: 'components-confirmdialog',
hbhalodia marked this conversation as resolved.
Show resolved Hide resolved
argTypes: {
isOpen: {
control: { type: null },
Expand Down
3 changes: 2 additions & 1 deletion packages/components/src/dropdown/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import MenuItem from '../../menu-item';
import { DropdownContentWrapper } from '../dropdown-content-wrapper';

const meta: Meta< typeof Dropdown > = {
title: 'Components/Dropdown',
title: 'Components/Overlays/Dropdown',
id: 'components-dropdown',
component: Dropdown,
// @ts-expect-error - See https://github.com/storybookjs/storybook/issues/23170
subcomponents: { DropdownContentWrapper },
Expand Down
3 changes: 2 additions & 1 deletion packages/components/src/modal/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ import type { ModalProps } from '../types';

const meta: Meta< typeof Modal > = {
component: Modal,
title: 'Components/Modal',
title: 'Components/Overlays/Modal',
id: 'components-modal',
argTypes: {
children: {
control: { type: null },
Expand Down
3 changes: 2 additions & 1 deletion packages/components/src/popover/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ const AVAILABLE_PLACEMENTS: PopoverProps[ 'placement' ][] = [
];

const meta: Meta< typeof Popover > = {
title: 'Components/Popover',
title: 'Components/Overlays/Popover',
id: 'components-popover',
component: Popover,
argTypes: {
anchor: { control: { type: null } },
Expand Down
3 changes: 2 additions & 1 deletion packages/components/src/tooltip/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ import Tooltip from '..';
import Button from '../../button';

const meta: Meta< typeof Tooltip > = {
title: 'Components/Tooltip',
title: 'Components/Overlays/Tooltip',
id: 'components-tooltip',
component: Tooltip,
argTypes: {
children: { control: { type: null } },
Expand Down
2 changes: 2 additions & 0 deletions storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,11 @@ export const parameters = {
'Contributing Guidelines',
'Actions',
'Containers',
'Overlays',
'Utilities',
],
'Components (Experimental)',
[ 'Overlays' ],
'Icons',
],
},
Expand Down
Loading