Skip to main content

CodeHighlighter

A syntax-highlighted code block component.

VEF-specific component. Built on react-syntax-highlighter.

Basic Usage

import { CodeHighlighter } from '@vef-framework-react/components';

export default function Demo() {
return (
<CodeHighlighter language="typescript">
{`const greeting = (name: string) => \`Hello, \${name}!\`;`}
</CodeHighlighter>
);
}

With Line Numbers

<CodeHighlighter language="tsx" showLineNumbers>
{`import { Button } from '@vef-framework-react/components';

export default function Demo() {
return <Button type="primary">Click me</Button>;
}`}
</CodeHighlighter>

Highlight Specific Lines

<CodeHighlighter
language="typescript"
showLineNumbers
lineProps={[1, 3]}
>
{code}
</CodeHighlighter>

API

PropTypeDefaultDescription
childrenstringrequiredCode string to highlight
languagestring'typescript'Programming language
showLineNumbersbooleanfalseShow line numbers
startingLineNumbernumber1Starting line number
wrapLinesbooleanfalseWrap lines
wrapLongLinesbooleantrueWrap long lines instead of scrolling
classNamestringCSS class
styleCSSPropertiesInline style
customStyleCSSPropertiesStyle for the syntax highlighter container
linePropsSyntaxHighlighterProps['lineProps']Lines to highlight