Skip to content

Docs: Ensure CodePanel hooks are called within component #33162

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
valentinpalkovic merged 2 commits into from
Dec 9, 2025
Merged

Docs: Ensure CodePanel hooks are called within component #33162

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c11393
Ensure CodePanel hooks are called within component
mrginglymus Nov 25, 2025
4102998
Merge branch 'next' into sb-manager-code-fix
valentinpalkovic Dec 1, 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
96 changes: 53 additions & 43 deletions code/addons/docs/src/manager.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,58 @@ import {
import type { SourceParameters } from './blocks/blocks';
import { Source } from './blocks/components/Source';

const CodePanel = ({
active,
lastEvent,
currentStoryId,
}: {
active: boolean | undefined;
lastEvent: any | undefined;

@mrginglymus mrginglymus Nov 25, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I did try to type this, then I noticed that where it is emitted, format is not actually set....

storybook/code/core/src/preview-api/modules/preview-web/emitTransformCode.ts

Lines 22 to 26 in 809c130

addons.getChannel().emit(SNIPPET_RENDERED, {
id,
source: result,
args: unmappedArgs,
});

currentStoryId: string | undefined;
}) => {
const [codeSnippet, setSourceCode] = useState<{
source: string | undefined;
format: SyntaxHighlighterFormatTypes | undefined;
}>({
source: lastEvent?.source,
format: lastEvent?.format ?? undefined,
});

const parameter = useParameter(PARAM_KEY, {
source: { code: '' } as SourceParameters,
theme: 'dark',
});

useEffect(() => {
setSourceCode({
source: undefined,
format: undefined,
});
}, [currentStoryId]);

useChannel({
[SNIPPET_RENDERED]: ({ source, format }) => {
setSourceCode({ source, format });
},
});

const theme = useTheme();
const isDark = theme.base !== 'light';

return (
<AddonPanel active={!!active}>
<SourceStyles>
<Source
{...parameter.source}
code={parameter.source?.code || codeSnippet.source || parameter.source?.originalSource}
format={codeSnippet.format}
dark={isDark}
/>
</SourceStyles>
</AddonPanel>
);
};

addons.register(ADDON_ID, (api) => {
addons.add(PANEL_ID, {
title: 'Code',
Expand All @@ -40,49 +92,7 @@ addons.register(ADDON_ID, (api) => {

const lastEvent = channel?.last(SNIPPET_RENDERED)?.[0];

const [codeSnippet, setSourceCode] = useState<{
source: string | undefined;
format: SyntaxHighlighterFormatTypes | undefined;
}>({
source: lastEvent?.source,
format: lastEvent?.format ?? undefined,
});

const parameter = useParameter(PARAM_KEY, {
source: { code: '' } as SourceParameters,
theme: 'dark',
});

useEffect(() => {
setSourceCode({
source: undefined,
format: undefined,
});
}, [currentStory?.id]);

useChannel({
[SNIPPET_RENDERED]: ({ source, format }) => {
setSourceCode({ source, format });
},
});

const theme = useTheme();
const isDark = theme.base !== 'light';

return (
<AddonPanel active={!!active}>
<SourceStyles>
<Source
{...parameter.source}
code={
parameter.source?.code || codeSnippet.source || parameter.source?.originalSource
}
format={codeSnippet.format}
dark={isDark}
/>
</SourceStyles>
</AddonPanel>
);
return <CodePanel currentStoryId={currentStory?.id} lastEvent={lastEvent} active={active} />;
},
});
});
Expand Down