common-intellisense
Version:
109 lines (108 loc) • 3.01 kB
JSON
{
"props": [
{
"Attribute": "children",
"Type": "`ReactNode` | `ReactNode[]`",
"Description": "The content of the snippet.",
"Default": "-"
},
{
"Attribute": "size",
"Type": "`sm` | `md` | `lg`",
"Description": "The size of the snippet.",
"Default": "`md`"
},
{
"Attribute": "radius",
"Type": "`none` | `sm` | `md` | `lg`",
"Description": "The radius of the snippet.",
"Default": "`lg`"
},
{
"Attribute": "symbol",
"Type": "`string` | `ReactNode`",
"Description": "The symbol to show before the snippet.",
"Default": "`$`"
},
{
"Attribute": "timeout",
"Type": "`number`",
"Description": "he time in milliseconds to wait before resetting the clipboard.",
"Default": "`2000`"
},
{
"Attribute": "codeString",
"Type": "`string`",
"Description": "The code string to copy. if `codeString` is passed, it will be copied instead of the children.",
"Default": "-"
},
{
"Attribute": "tooltipProps",
"Type": "[TooltipProps](/docs/components/tooltip#tooltip-props)",
"Description": "The props of the tooltip.",
"Default": "-"
},
{
"Attribute": "copyIcon",
"Type": "`ReactNode`",
"Description": "The copy icon.",
"Default": "-"
},
{
"Attribute": "checkIcon",
"Type": "`ReactNode`",
"Description": "The check icon.",
"Default": "-"
},
{
"Attribute": "disableTooltip",
"Type": "`boolean`",
"Description": "Whether to disable the tooltip.",
"Default": "`false`"
},
{
"Attribute": "disableCopy",
"Type": "`boolean`",
"Description": "Whether to disable the copy button.",
"Default": "`false`"
},
{
"Attribute": "hideCopyButton",
"Type": "`boolean`",
"Description": "Whether to hide the copy button.",
"Default": "`false`"
},
{
"Attribute": "hideSymbol",
"Type": "`boolean`",
"Description": "Whether to hide the symbol.",
"Default": "`false`"
},
{
"Attribute": "copyButtonProps",
"Type": "[ButtonProps](/docs/components/button#button-props)",
"Description": "The props of the copy button.",
"Default": "-"
},
{
"Attribute": "disableAnimation",
"Type": "`boolean`",
"Description": "Whether to disable the animations.",
"Default": "`false`"
},
{
"Attribute": "classNames",
"Type": "`Record<\"base\"|\"content\"|\"pre\"|\"symbol\"|\"copyButton\"|\"checkIcon\", string>`",
"Description": "Allows to set custom class names for the snippet slots.",
"Default": "-"
}
],
"link": "https://nextui.org/docs/components/snippet",
"events": [
{
"Attribute": "onCopy",
"Type": "`(value: string | string[]) => void;`",
"Description": "Handler that is called when the code is copied."
}
]
}