diff --git a/docs/code/detail/options.md b/docs/code/detail/options.md index 8ecc0eae..b6795c5e 100644 --- a/docs/code/detail/options.md +++ b/docs/code/detail/options.md @@ -134,10 +134,22 @@ layout: ['code', 'preview'] 工具图标将根据数组的排列顺序来显示,如: ``` -tools: ['full', 'window'] +tools: [ + 'full', + 'window', + // 自定义扩展工具 --- 2.8.17+ + { + title: ['切换高亮主题'], + type: 'theme', + event: function(obj) { + console.log(obj); // 当前实例相关信息 + // do something + } + } +] ``` -亦可自定义值,值对应[图标](../icon/) `className` 的 `layui-icon-` 后的名称,并通过 `toolsEvent` 回调函数中处理事件。 +`type` 值对应[图标](../icon/) `className` 的 `layui-icon-` 后的名称。如图标:`layui-icon-theme`,那么 `type` 设置 `theme` 即可。 array @@ -147,12 +159,12 @@ tools: ['full', 'window'] toolsEvent 2.8+ -点击工具栏的回调函数,函数返回 `tools` 设置的名称,如: +点击工具栏的回调函数,功能同 `tools` 中的 `event`,只是需通过 `type` 属性来区分是哪个工具菜单。 ``` -toolsEvent: function(othis, type){ - console.log(othis); // 当前图标元素对象 - console.log(type); // tools 中设置的对应值 +toolsEvent: function(obj){ + console.log(obj); // 当前实例相关信息 + console.log(obj.type); // 当前实例相关信息 } ``` @@ -197,7 +209,7 @@ text: { header 2.8+ -是否开启 Code 栏头部区域 +是否开启 Code 栏头部区域。 boolean @@ -208,16 +220,6 @@ text: { -about - - -设置 Code 栏头部右上角信息。必须开启 `header` 属性后有效。 - - -string -- - - ln @@ -232,10 +234,10 @@ text: { -skin +theme 2.8.17+ -Code 容器的风格,可选值有: +Code 容器的主题风格,可选值有: - `light` 浅色模式(默认) - `dark` 深色模式 @@ -256,6 +258,84 @@ Code 容器的风格,可选值有: `true` + + + +lang 2.8.17+ + + +指定语言类型。如:`lang: 'html'` + + +string +- + + +langMarker 2.8.17+ + + +是否在代码区域右上角显示语言类型 + + +boolean + + +`false` + + + + +wordWrap 2.8.17+ + + +Code 文字是否自动换行 + + +boolean + + +`true` + + + + +highlighter 2.8.17+ + + +指定语法高亮器,可选值: + +- `hljs` : 指定 `highlight.js` 库 +- `prism` : 指定 `prism.js` 库 +- `shiki` : 指定 `shiki.js` 库 + + +string +- + + + + +[codeRender](#options.codeRender) 2.8+ + + + + +
+用于重新渲染 code,譬如代码高亮处理。 +
+ +``` +codeRender: function(code, opts){ + // 此处以 highlight.js 为例 + return hljs.highlight(code, {language: opts.lang}).value; +} +``` + +code 组件语法高亮相关示例: + +- highlight 和 prism 语法高亮示例 +- shiki 语法高亮示例 + @@ -288,7 +368,7 @@ done: function(obj){
-点击复制图标时的回调函数。 该回调一旦设定,则不再执行内置的复制操作。 +点击复制图标时的回调函数。
``` @@ -300,4 +380,4 @@ onCopy: function(code){ - \ No newline at end of file +