Snippet is a component that can be used to display inline or multiline code snippets.


npx nextui-cli@latest add snippet
The above command is for individual installation only. You may skip this step if @nextui-org/react is already installed globally.






Custom Symbol

Without Copy

You can hide the copy button by setting the hideCopyButton property to true.

Custom Tooltip

You can customize the tooltip by using the tooltipProps property.

Note: For more information about the Tooltip props, please visit the Tooltip page.


Custom Icons

You can customize the copy and copied icons by using the copyIcon and checkIcon properties.


  • base: The base slot of the snippet, it is the main container.
  • content: This is the wrapper of the <pre/> slot.
  • pre: The <pre/> slot of the snippet. It is used to wrap the code.
  • symbol: The symbol wrapper slot.
  • copyButton: The copy button slot.
  • copyIcon: The copy icon slot.
  • checkIcon: The check icon slot.


Snippet Props

childrenReactNode | ReactNode[]The content of the snippet.-
sizesm | md | lgThe size of the
radiusnone | sm | md | lgThe radius of the snippet.lg
symbolstring | ReactNodeThe symbol to show before the snippet.$
timeoutnumberhe time in milliseconds to wait before resetting the clipboard.2000
codeStringstringThe code string to copy. if codeString is passed, it will be copied instead of the children.-
tooltipPropsTooltipPropsThe props of the tooltip.-
copyIconReactNodeThe copy icon.-
checkIconReactNodeThe check icon.-
disableTooltipbooleanWhether to disable the tooltip.false
disableCopybooleanWhether to disable the copy button.false
hideCopyButtonbooleanWhether to hide the copy button.false
hideSymbolbooleanWhether to hide the symbol.false
copyButtonPropsButtonPropsThe props of the copy button.-
disableAnimationbooleanWhether to disable the animations.false
classNamesRecord<"base"|"content"|"pre"|"symbol"|"copyButton"|"checkIcon", string>Allows to set custom class names for the snippet slots.-

Snippet Events

onCopy(value: string | string[]) => void;Handler that is called when the code is copied.