Skip to content

docs: hide mode and theme props, unhide children props #3181

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: hide mode and theme props, unhide children props #3181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
34c229e
add prop filter and show children
aresnik11 Oct 8, 2025
521807b
story fixes
aresnik11 Oct 8, 2025
498e647
Merge branch 'main' into ajr-sb-react-docgen-updates
aresnik11 Oct 17, 2025
34f47af
fix as props
aresnik11 Oct 17, 2025
e67e225
Merge branch 'ajr-sb-react-docgen-updates' of github.com:Codecademy/g…
aresnik11 Oct 17, 2025
ecca9c4
clean up
aresnik11 Oct 17, 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
15 changes: 15 additions & 0 deletions packages/styleguide/.storybook/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,21 @@ const config: StorybookConfig = {

typescript: {
reactDocgen: 'react-docgen-typescript',
reactDocgenTypescriptOptions: {
skipChildrenPropWithoutDoc: false,
shouldRemoveUndefinedFromOptional: true,
propFilter: (prop) => {
// Return false if fileName contains node_modules
if (prop.parent && /node_modules/.test(prop.parent.fileName)) {
return false;
}
// Return false if prop name is mode or theme
if (['mode', 'theme'].includes(prop.name)) {
return false;
}
return true;
},
},
},

webpackFinal(config) {
Expand Down
11 changes: 5 additions & 6 deletions packages/styleguide/src/lib/Atoms/Buttons/CTAButton/CTAButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,17 @@ const meta: Meta<typeof CTAButton> = {
href: {
description: 'If defined, component will use an anchor tag',
},
mode: {
control: {
type: 'select',
options: ['dark', 'light'],
},
},
size: {
control: {
type: 'select',
options: ['normal', 'small', 'large'],
},
},
as: {
table: {
disable: true,
},
},
},
};

Expand Down
11 changes: 5 additions & 6 deletions packages/styleguide/src/lib/Atoms/Buttons/FillButton/FillButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ const meta: Meta<typeof FillButton> = {
href: {
description: 'If defined, component will use an anchor tag',
},
mode: {
control: {
type: 'select',
options: ['dark', 'light'],
},
},
size: {
control: {
type: 'select',
Expand All @@ -30,6 +24,11 @@ const meta: Meta<typeof FillButton> = {
options: [SearchIcon],
},
},
as: {
table: {
disable: true,
},
},
},
};

Expand Down
11 changes: 5 additions & 6 deletions packages/styleguide/src/lib/Atoms/Buttons/IconButton/IconButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@ const meta: Meta<typeof IconButton> = {
href: {
description: 'If defined, component will use an anchor tag',
},
mode: {
control: {
type: 'select',
options: ['dark', 'light'],
},
},
size: {
control: {
type: 'select',
Expand All @@ -35,6 +29,11 @@ const meta: Meta<typeof IconButton> = {
options: Object.keys(icons),
mapping: icons,
},
as: {
table: {
disable: true,
},
},
},
};

Expand Down
11 changes: 5 additions & 6 deletions packages/styleguide/src/lib/Atoms/Buttons/StrokeButton/StrokeButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ const meta: Meta<typeof StrokeButton> = {
href: {
description: 'If defined, component will use an anchor tag',
},
mode: {
control: {
type: 'select',
options: ['dark', 'light'],
},
},
size: {
control: {
type: 'select',
Expand All @@ -30,6 +24,11 @@ const meta: Meta<typeof StrokeButton> = {
options: [SearchIcon],
},
},
as: {
table: {
disable: true,
},
},
},
};

Expand Down
11 changes: 5 additions & 6 deletions packages/styleguide/src/lib/Atoms/Buttons/TextButton/TextButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ const meta: Meta<typeof TextButton> = {
href: {
description: 'If defined, component will use an anchor tag',
},
mode: {
control: {
type: 'select',
options: ['dark', 'light'],
},
},
size: {
control: {
type: 'select',
Expand All @@ -30,6 +24,11 @@ const meta: Meta<typeof TextButton> = {
options: [SearchIcon],
},
},
as: {
table: {
disable: true,
},
},
},
};

Expand Down
1 change: 1 addition & 0 deletions packages/styleguide/src/lib/Atoms/RadialProgress/RadialProgress.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const meta: Meta<typeof RadialProgress> = {
strokeWidth: 10,
value: 30,
size: 120,
children: '',
},
};

Expand Down
1 change: 0 additions & 1 deletion packages/styleguide/src/lib/Layouts/Boxes/Box/Box.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ type Story = StoryObj<typeof Box>;

export const Default: Story = {
args: {
as: 'div',
children: 'Hello work, I am a box!',
},
};
Expand Down
5 changes: 5 additions & 0 deletions packages/styleguide/src/lib/Organisms/ConnectedForm/SubmitButton/SubmitButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ const meta: Meta<typeof SubmitButton> = {
type: 'boolean',
},
},
as: {
table: {
disable: true,
},
},
},
};

Expand Down
Loading