代码预览组件
code
主要用于对代码区块的修饰和对应的效果预览,如 Layui 各组件文档中的示例演示。
var codeInst = layui.code(options);
options
: 基础属性配置项。#详见属性。其中 codeInst
2.8.17+ 即实例返回的对象,包含对当前实例进行重载等方法成员,如:
var codeInst = layui.code(options);
console.log(codeInst); // 查看所有成员
codeInst.config; // 当前实例配置项
codeInst.reload(options); // 重载
codeInst.reloadCode(options); // 仅重载 code
另外,属性除了在该方法中传递,也可以直接写在元素的 lay-options
属性上,如:
属性名 | 描述 | 类型 | 默认值 |
---|---|---|---|
elem |
绑定元素选择器或 DOM 对象 |
string/DOM | - |
code 2.8.18+ |
设置原始 code 值,默认取目标元素中的内容 |
string | - |
preview 2.8+ |
是否开启 Code 预览功能,可选值有:
当开启该属性时,
|
boolean string |
|
layout 2.8+ |
开启预览后的面板布局方式,值为一个数组,数组的可选成员有:
面板将根据数组的排列顺序来显示,如:
|
array | - |
style 2.8+ |
设置 Code 和预览区域的公共样式 |
string | - |
codeStyle 2.8+ |
设置 Code 区域的局部样式,优先级高于 |
string | - |
previewStyle 2.8+ |
设置预览区域的局部样式,优先级高于 |
string | - |
id 2.8+ |
设置实例的唯一索引,以便用于其他操作 |
string | - |
className 2.8+ |
追加实例面板的 |
string | - |
tools 2.8+ |
用于开启
工具图标将根据数组的排列顺序来显示,如:
|
array | - |
toolsEvent 2.8+ |
点击工具栏的回调函数,功能同
通过该函数与 |
function | - |
copy 2.8.2+ |
用于开启代码复制功能图标。若开启 |
boolean |
|
text 2.8+ |
自定义默认文本,值为一个对象,可选成员有:
|
object | - |
header 2.8+ |
是否开启 Code 栏头部区域。 |
boolean |
|
ln |
是否显示 Code 区域的行号 |
boolean |
|
theme 2.8.17+ |
Code 容器的主题风格,可选值有:
|
string | - |
encode |
是否对 code 中的 html 进行编码(转义)。 |
boolean |
|
lang 2.8.17+ |
指定语言类型。如: |
string | - |
langMarker 2.8.17+ |
是否在代码区域右上角显示语言类型 |
boolean |
|
wordWrap 2.8.17+ |
Code 文字是否自动换行 |
boolean |
|
highlighter 2.8.17+ |
设置语法高亮器,可选值:
注:对应的语法高亮器 JS 库和相关主题 CSS 需自主引入,该属性仅用于内部适配。 |
string | - |
codeRender 2.8+ |
用于重新渲染 code,譬如代码高亮处理。
code 组件语法高亮相关示例: |
||
done 2.8+ |
组件渲染完毕的回调函数,函数返回一个 object 类型参数
|
||
onCopy 2.8.2+ |
点击复制图标时的回调函数。
|
code 组件可广泛应用于技术类文档、博客等页面,可轻松适配第三方主流语法高亮器。