amis2/docs/zh-CN/components/form/editor.md
2022-05-31 15:05:54 +08:00

7.0 KiB
Executable File
Raw Blame History

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

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

基本用法

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "编辑器"
        }
    ]
}

支持的语言

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

batccoffeescriptcppcsharpcssdockerfilefsharpgohandlebarshtmlinijavajavascriptjsonlessluamarkdownmsdaxobjective-cphpplaintextpostiatspowershellpugpythonrrazorrubysbscssshellsolsqlswifttypescriptvbxmlyaml

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "JSON编辑器",
            "language": "json"
        }
    ]
}

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

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

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "json-editor",
            "name": "editor",
            "label": "JSON编辑器"
        }
    ]
}

只读模式

使用 disabled: true

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "json-editor",
            "name": "editor",
            "disabled": true,
            "label": "JSON编辑器"
        }
    ]
}

全屏模式

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

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "支持全屏模式的编辑器",
            "allowFullscreen": true
        }
    ]
}

编辑器展现控制

通过 options 来控制编辑器展现,比如下面的配置可以关闭行号

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "编辑器",
            "options": {
                "lineNumbers": "off"
            }
        }
    ]
}

编辑器自定义开发

amis 的编辑器是基于 monaco 开发的,如果想进行深度定制,比如自动完成功能,可以通过自定义 editorDidMount 属性来获取到 monaco 实例,它有两种写法,一种是在 JS 中直接用函数,示例如下:

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "editor",
            "name": "editor",
            "label": "编辑器",
            "language": "myLan",
            "editorDidMount": (editor, monaco) => {
                // editor 是 monaco 实例monaco 是全局的名称空间
                const dispose = monaco.languages.registerCompletionItemProvider('myLan', {
                    /// 其他细节参考 monaco 手册
                });

                // 如果返回一个函数,这个函数会在编辑器组件卸载的时候调用,主要用于清理资源
                return dispose;
            }
        }
    ]
}

属性表

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

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

事件表

当前组件会对外派发以下事件,可以通过onEvent来监听这些事件,并通过actions来配置执行的动作,在actions中可以通过event.data.xxx事件参数变量来获取事件产生的数据,详细请查看事件动作

事件名称 事件参数 说明
focus event.data.value: string 当前代码 输入框获取焦点时触发
blur event.data.value: string 当前代码 输入框失去焦点时触发

动作表

当前组件对外暴露以下特性动作,其他组件可以通过指定actionType: 动作名称componentId: 该组件id来触发这些动作,动作配置可以通过args: {动作配置项名称: xxx}来配置具体的参数,详细请查看事件动作

动作名称 动作配置 说明
clear - 清空
reset - 将值重置为resetValue,若没有配置resetValue,则清空
focus - 获取焦点
setValue value: string 更新的值 更新数据