mirror of
https://gitee.com/baidu/amis.git
synced 2024-12-15 01:11:15 +08:00
137 lines
4.4 KiB
Markdown
Executable File
137 lines
4.4 KiB
Markdown
Executable File
---
|
||
title: Editor 编辑器
|
||
description:
|
||
type: 0
|
||
group: null
|
||
menuName: Editor
|
||
icon:
|
||
order: 19
|
||
---
|
||
|
||
用于实现代码编辑，如果要实现富文本编辑请使用 [Rich-Text](./input-rich-text)。
|
||
|
||
## 基本用法
|
||
|
||
```schema: scope="body"
|
||
{
|
||
"type": "form",
|
||
"api": "/api/mock2/form/saveForm",
|
||
"body": [
|
||
{
|
||
"type": "editor",
|
||
"name": "editor",
|
||
"label": "编辑器"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 支持的语言
|
||
|
||
可以设置`language`配置高亮的语言，支持的语言有：
|
||
|
||
`bat`、 `c`、 `coffeescript`、 `cpp`、 `csharp`、 `css`、 `dockerfile`、 `fsharp`、 `go`、 `handlebars`、 `html`、 `ini`、 `java`、 `javascript`、 `json`、 `less`、 `lua`、 `markdown`、 `msdax`、 `objective-c`、 `php`、 `plaintext`、 `postiats`、 `powershell`、 `pug`、 `python`、 `r`、 `razor`、 `ruby`、 `sb`、 `scss`、`shell`、 `sol`、 `sql`、 `swift`、 `typescript`、 `vb`、 `xml`、 `yaml`
|
||
|
||
```schema: scope="body"
|
||
{
|
||
"type": "form",
|
||
"api": "/api/mock2/form/saveForm",
|
||
"body": [
|
||
{
|
||
"type": "editor",
|
||
"name": "editor",
|
||
"label": "JSON编辑器",
|
||
"language": "json"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
> 因为性能原因，上面的例子不支持实时修改 language 生效
|
||
|
||
当然你也可以使用`xxx-editor`这种形式，例如`"type": "json-editor"`
|
||
|
||
```schema: scope="body"
|
||
{
|
||
"type": "form",
|
||
"api": "/api/mock2/form/saveForm",
|
||
"body": [
|
||
{
|
||
"type": "json-editor",
|
||
"name": "editor",
|
||
"label": "JSON编辑器"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 只读模式
|
||
|
||
使用 `disabled: true`。
|
||
|
||
```schema: scope="body"
|
||
{
|
||
"type": "form",
|
||
"api": "/api/mock2/form/saveForm",
|
||
"body": [
|
||
{
|
||
"type": "json-editor",
|
||
"name": "editor",
|
||
"disabled": true,
|
||
"label": "JSON编辑器"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 全屏模式
|
||
|
||
设置`allowFullscreen`属性为`true`，显示编辑器的全屏模式开关，开关开启后编辑器进入全屏模式。
|
||
|
||
```schema: scope="body"
|
||
{
|
||
"type": "form",
|
||
"api": "/api/mock2/form/saveForm",
|
||
"body": [
|
||
{
|
||
"type": "editor",
|
||
"name": "editor",
|
||
"label": "支持全屏模式的编辑器",
|
||
"allowFullscreen": true
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 编辑器展现控制
|
||
|
||
通过 `options` 来控制编辑器展现，比如下面的配置可以关闭行号
|
||
|
||
```schema: scope="body"
|
||
{
|
||
"type": "form",
|
||
"api": "/api/mock2/form/saveForm",
|
||
"body": [
|
||
{
|
||
"type": "editor",
|
||
"name": "editor",
|
||
"label": "编辑器",
|
||
"options": {
|
||
"lineNumbers": "off"
|
||
}
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 属性表
|
||
|
||
除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置
|
||
|
||
| 属性名 | 类型 | 默认值 | 说明 |
|
||
| --------------- | --------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| language | `string` | `javascript` | 编辑器高亮的语言，支持通过 `${xxx}` 变量获取 |
|
||
| size | `string` | `md` | 编辑器高度，取值可以是 `md`、`lg`、`xl`、`xxl` |
|
||
| allowFullscreen | `boolean` | `false` | 是否显示全屏模式开关 |
|
||
| options | `object` | | monaco 编辑器的其它配置，比如是否显示行号等，请参考[这里](https://microsoft.github.io/monaco-editor/api/enums/monaco.editor.EditorOption.html)，不过无法设置 readOnly，只读模式需要使用 `disabled: true` |
|