Snippet
Snippet 是一个可以用来展示内联或多行代码片段的组件。
安装
以上命令仅用于单独安装。如果已全局安装,则可以跳过此步骤 @heroui/react
。
导入
用法
尺寸
颜色
变体
自定义符号
无复制按钮
您可以通过将 hideCopyButton
属性设置为 true
来隐藏复制按钮。
自定义工具提示
您可以使用 tooltipProps
属性自定义工具提示。
注意:有关
Tooltip
属性的更多信息,请访问 Tooltip 页面。
多行
自定义图标
您可以使用 copyIcon
和 checkIcon
属性自定义复制和已复制图标。
插槽
- base: 代码片段的基础插槽,它是主容器。
- content: 这是
<pre/>
插槽的包装器。 - pre: 代码片段的
<pre/>
插槽。它用于包裹代码。 - symbol: 符号包装器插槽。
- copyButton: 复制按钮插槽。
- copyIcon: 复制图标插槽。
- checkIcon: 选中图标插槽。
API
Snippet Props
属性 | 类型 | 默认值 |
children |
| |
size |
| "md" |
radius |
| "lg" |
symbol |
| "$" |
timeout |
| "2000" |
codeString |
| |
tooltipProps |
| |
copyIcon |
| |
checkIcon |
| |
disableTooltip |
| false |
disableCopy |
| false |
hideCopyButton |
| false |
hideSymbol |
| false |
copyButtonProps |
| |
disableAnimation |
| false |
classNames |
|
Snippet Events
属性 | 类型 | 默认值 |
onCopy |
|