amis2/docs/zh-CN/components/form/editor.md
2021-07-28 12:20:21 +08:00

4.0 KiB
Executable File
Raw Blame History

title description type group menuName icon order
Editor 编辑器 0 null Editor 19

用于实现代码编辑,如果要实现富文本编辑请使用 Rich-Text

基本用法

{
    "type": "form",
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "编辑器"
        }
    ]
}

支持的语言

可以设置language配置高亮的语言,支持的语言有:

batccoffeescriptcppcsharpcssdockerfilefsharpgohandlebarshtmlinijavajavascriptjsonlessluamarkdownmsdaxobjective-cphpplaintextpostiatspowershellpugpythonrrazorrubysbscssshellsolsqlswifttypescriptvbxmlyaml

{
    "type": "form",
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "JSON编辑器",
            "language": "json"
        }
    ]
}

因为性能原因,上面的例子不支持实时修改 language 生效

当然你也可以使用xxx-editor这种形式,例如"type": "json-editor"

{
    "type": "form",
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "body": [
        {
            "type": "json-editor",
            "name": "editor",
            "label": "JSON编辑器"
        }
    ]
}

只读模式

使用 disabled: true

全屏模式

设置allowFullscreen属性为true,显示编辑器的全屏模式开关,开关开启后编辑器进入全屏模式。

{
    "type": "form",
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "支持全屏模式的编辑器",
            "allowFullscreen": true
        }
    ]
}

属性表

除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置

属性名 类型 默认值 说明
language string javascript 编辑器高亮的语言,支持通过 ${xxx} 变量获取
size string md 编辑器高度,取值可以是 mdlgxlxxl
allowFullscreen boolean false 是否显示全屏模式开关
options object monaco 编辑器的其它配置,比如是否显示行号等,请参考这里,不过无法设置 readOnly只读模式需要使用 disabled: true