Skip to content

docs(Storybook): migrate deprecated APIs & fix ObjectPage action bug #7103

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

Merged
merged 1 commit into from
Mar 20, 2025
Merged

docs(Storybook): migrate deprecated APIs & fix ObjectPage action bug #7103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 1 addition & 4 deletions .storybook/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,10 @@ const config: StorybookConfig = {
}
],
addons,
docs: {
autodocs: true
},
typescript: {
reactDocgen: 'react-docgen-typescript'
},
staticDirs: [isDevMode && 'images-dev', 'images'].filter(Boolean)
staticDirs: [isDevMode && 'images-dev', !isDevMode && 'images'].filter(Boolean)
};

export default config;
Expand Down
3 changes: 2 additions & 1 deletion .storybook/preview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ const preview: Preview = {
}
},
chromatic: { pauseAnimationAtEnd: true }
}
},
tags: ['autodocs']
};

export default preview;
8 changes: 5 additions & 3 deletions packages/main/src/components/ObjectPage/ObjectPage.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ type Story = StoryObj<typeof meta>;
export const Default: Story = {
render(args) {
return (
<ObjectPage {...args}>
// `onBeforeNavigate` has to be called like this, otherwise it's invoked two times for some reason.
<ObjectPage {...args} onBeforeNavigate={args.onBeforeNavigate}>
<ObjectPageSection titleText="Goals" id="goals" aria-label="Goals">
<Form layout="S1 M2 L3 XL3" labelSpan="S12 M12 L12 XL12">
<FormItem labelContent={<Label showColon>Evangelize the UI framework across the company</Label>}>
Expand Down Expand Up @@ -305,7 +306,7 @@ export const SectionWithCustomHeader: Story = {
name: 'section with custom header',
render(args) {
return (
<ObjectPage {...args}>
<ObjectPage {...args} onBeforeNavigate={args.onBeforeNavigate}>
<ObjectPageSection
titleText="Goals"
hideTitleText
Expand Down Expand Up @@ -349,7 +350,7 @@ export const FullScreenSingleSection: Story = {
name: 'with fullscreen section',
render(args) {
return (
<ObjectPage {...args} mode={ObjectPageMode.IconTabBar}>
<ObjectPage {...args} mode={ObjectPageMode.IconTabBar} onBeforeNavigate={args.onBeforeNavigate}>
<ObjectPageSection titleText="Section 1" id="section1" style={{ height: '100%' }}>
<div style={{ height: '100%', background: 'lightblue' }}>
It is recommended to only use fullscreen sections in TabBar mode, otherwise your layout will most probably
Expand Down Expand Up @@ -378,6 +379,7 @@ export const LegacyToolbarSupport: Story = {
return (
<ObjectPage
{...args}
onBeforeNavigate={args.onBeforeNavigate}
ref={objectPageRef}
titleArea={
<ObjectPageTitle
Expand Down
Loading