SxCodeSnippet (代码片段)

  • Implemented

用于展示并高亮显示代码。对齐 NextUI 现有 CodeSnippet 体验,包含复制按钮与滚动区域控制。

使用场景

  • 文档与示例代码展示
  • 配置片段说明
  • 日志片段与调试输出

约束说明

  • Language 仅影响 CSS class,不包含自动语法解析。
  • Scrollable = false 时超出区域会被裁剪。

行为说明

  • 点击复制按钮会调用浏览器剪贴板 API(若被禁用则不触发)。
  • ShowLineNumbers 仅添加样式类,需配合 Prism/主题样式。

API

Parameters (参数)

状态 参数名 类型 默认值 描述
Implemented Code string "" 要展示的代码内容。
Implemented Language string "razor" 编程语言(用于语法高亮)。
Implemented ShowLineNumbers bool false 是否显示行号。
Implemented Scrollable bool true 内容超出时是否滚动。
Implemented MinHeight string? null 代码区域最小高度(CSS 值)。
Implemented MaxHeight string? null 代码区域最大高度(CSS 值)。
Implemented Id (继承) string? null 组件的物理 Id。
Implemented Class (继承) string? null 自定义 CSS 类名。
Implemented Style (继承) string? null 自定义样式。
Implemented Title (继承) string? null HTML title 属性。
Implemented Disabled (继承) bool false 禁用复制按钮。
Not Implemented Loading (继承) bool false 加载状态(未应用)。
Not Implemented TabIndex (继承) int? null TabIndex(未应用)。
Not Implemented AccessKey (继承) string? null AccessKey(未应用)。
Implemented AdditionalAttributes (继承) IEnumerable<KeyValuePair<string, object>>? null 捕获不匹配的 HTML 属性。

示例

<SxCodeSnippet Language="csharp" Code="@_sampleCode" ShowLineNumbers="true" />

参考设计 (References)