Skip to content

feat(CodeBlockRuntime): add onRendered prop #2211

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 2 commits into from
May 27, 2025
Merged

feat(CodeBlockRuntime): add onRendered prop #2211

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8a630a
feat(CodeBlockRuntime): add onRendered prop
SoonIter May 27, 2025
26fa5e6
chore: comment
SoonIter 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
14 changes: 13 additions & 1 deletion packages/theme-default/src/components/CodeBlockRuntime/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ export interface CodeBlockRuntimeProps extends PreWithCodeButtonGroupProps {
CodeToHastOptions<BundledLanguage, BundledTheme>,
'lang' | 'theme'
>;
/**
* Callback when the code block is rendered.
* For some DOM operations, such as scroll operations.
*/
onRendered?: () => void;
}

const cssVariablesTheme = createCssVariablesTheme({
Expand All @@ -43,9 +48,10 @@ export function CodeBlockRuntime({
title,
code,
shikiOptions,
onRendered,
...otherProps
}: CodeBlockRuntimeProps) {
const [child, setChild] = useState<ReactNode>('');
const [child, setChild] = useState<ReactNode | null>(null);
const codeRef = useLatest(code);

useEffect(() => {
Expand Down Expand Up @@ -94,5 +100,11 @@ export function CodeBlockRuntime({
void highlightCode();
}, [lang, code, shikiOptions]);

useEffect(() => {
if (child) {
onRendered?.();
}
}, [child]);

return child;
}