CodeBlock
A code-block with automatic syntax highlighting, filename and copy button.
Usage
Code blocks are rendered by the ProseCode component of Nuxt Content and syntax highlighting is done underneath by Shikiji.
By default for syntax highlighting, material-theme-lighter and material-theme-palenight VSCode themes are used for light & dark mode respectively. You can change this in your nuxt.config.ts through the content.highlight key.
Nuxt UI Pro overrides the ProseCode component to add some extra features like a copy button, a filename and automatic icons.
export default defineNuxtConfig({
extends: ['@nuxt/ui-pro'],
modules: ['@nuxt/ui']
})
```ts
export default defineNuxtConfig({
extends: ['@nuxt/ui-pro'],
modules: ['@nuxt/ui']
})
```
Name
When using a CodeBlock, you can specify a filename that will be displayed on top of the code block.
export default defineNuxtConfig({
extends: ['@nuxt/ui-pro'],
modules: ['@nuxt/ui']
})
```ts [nuxt.config.ts]
export default defineNuxtConfig({
extends: ['@nuxt/ui-pro'],
modules: ['@nuxt/ui']
})
```
Icon
When specifying a filename, an icon will be automatically displayed based on the extension or the name.
Some icons are already defined by default, but you can add more in your app.config.ts through the ui.content.prose.code.icon key:
export default defineAppConfig({
ui: {
content: {
prose: {
code: {
icon: {
terminal: 'i-ph-terminal-window-duotone'
}
}
}
}
}
})
Here is the default mapping:
{
'package.json': 'vscode-icons:file-type-node',
'tsconfig.json': 'vscode-icons:file-type-tsconfig',
'.npmrc': 'vscode-icons:file-type-npm',
'.editorconfig': 'vscode-icons:file-type-editorconfig',
'.eslintrc': 'vscode-icons:file-type-eslint',
'.eslintrc.cjs': 'vscode-icons:file-type-eslint',
'.eslintignore': 'vscode-icons:file-type-eslint',
'.gitignore': 'vscode-icons:file-type-git',
'yarn.lock': 'vscode-icons:file-type-yarn',
'.env': 'vscode-icons:file-type-dotenv',
'.env.example': 'vscode-icons:file-type-dotenv',
'.vscode/settings.json': 'vscode-icons:file-type-vscode',
'.nuxtrc': 'vscode-icons:file-type-nuxt',
'.nuxtignore': 'vscode-icons:file-type-nuxt',
'nuxt.config.ts': 'vscode-icons:file-type-nuxt',
'tailwind.config.ts': 'vscode-icons:file-type-tailwind',
ts: 'vscode-icons:file-type-typescript',
tsx: 'vscode-icons:file-type-typescript',
mjs: 'vscode-icons:file-type-js',
cjs: 'vscode-icons:file-type-js',
js: 'vscode-icons:file-type-js',
jsx: 'vscode-icons:file-type-js',
md: 'vscode-icons:file-type-markdown',
ico: 'vscode-icons:file-type-favicon',
npm: 'vscode-icons:file-type-npm',
pnpm: 'vscode-icons:file-type-pnpm',
npx: 'vscode-icons:file-type-npm',
yarn: 'vscode-icons:file-type-yarn',
bun: 'vscode-icons:file-type-bun',
yml: 'vscode-icons:file-type-yaml',
terminal: 'i-heroicons-command-line'
}
Copy
Every code block has a copy button that will copy the code to your clipboard. You can change the icon in your app.config.ts through the ui.content.prose.code.button.icon key:
export default defineAppConfig({
ui: {
content: {
prose: {
code: {
button: {
icon: {
copy: 'i-ph-copy-duotone',
copied: 'i-ph-check-square-duotone'
}
}
}
}
}
}
})