amis/docs/components/form/rich-text.md

117 lines
4.1 KiB
Markdown
Raw Normal View History

2020-07-28 10:03:53 +08:00
---
title: Rich-Text 富文本编辑器
2020-07-29 16:20:21 +08:00
description:
2020-07-28 10:03:53 +08:00
type: 0
group: null
menuName: Rich-Text
2020-07-29 16:20:21 +08:00
icon:
2020-07-28 10:03:53 +08:00
order: 47
---
2020-07-29 16:20:21 +08:00
2020-09-11 12:58:20 +08:00
目前富文本编辑器基于两个库:[froala](https://froala.com/) 和 [tinymce](https://github.com/tinymce/tinymce),默认使用 tinymce。
2020-07-28 10:03:53 +08:00
## 基本用法
```schema:height="600" scope="body"
{
"type": "form",
"api": "https://houtai.baidu.com/api/mock2/form/saveForm",
"controls": [
{
"type": "rich-text",
"name": "rich",
"label": "Rich Text"
}
]
}
```
### tinymce 自定义配置
2020-10-19 14:26:38 +08:00
可以设置 options 属性来自定义编辑器的展现,详细配置项请参考[官方文档](https://www.tiny.cloud/docs/general-configuration-guide/basic-setup/)。
注意在下面的编辑器里修改 JSON 配置后不会实时生效。
```schema:height="320" scope="body"
{
"type": "form",
"api": "https://houtai.baidu.com/api/mock2/form/saveForm",
"controls": [
{
"type": "rich-text",
"name": "rich",
"options": {
"menubar": false,
"height": 200,
"plugins": [
"advlist autolink lists link image charmap print preview anchor",
"searchreplace visualblocks code fullscreen",
"insertdatetime media table paste code help wordcount"
],
"toolbar ": "undo redo | formatselect | bold italic backcolor | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | removeformat | help"
}
}
]
}
```
2020-09-11 12:58:20 +08:00
## 使用 froala 编辑器
只需要加一行 `"vendor": "froala"` 配置就行froala 是付费产品,需要设置 [richTextToken](../../start/getting-started#richtexttoken-string) 才能去掉水印。
```schema:height="430" scope="body"
{
"type": "form",
"api": "https://houtai.baidu.com/api/mock2/form/saveForm",
"controls": [
{
"type": "rich-text",
"vendor": "froala",
"name": "rich",
"label": "Rich Text"
}
]
}
```
### froala buttons 配置项
froala 可以通过设置 buttons 参数来控制显示哪些按钮,默认是这些:
2020-07-28 10:03:53 +08:00
2020-09-11 12:58:20 +08:00
```json
2020-07-28 10:03:53 +08:00
[
2020-09-11 12:58:20 +08:00
"paragraphFormat",
"quote",
"color",
"|",
"bold",
"italic",
"underline",
"strikeThrough",
"|",
"formatOL",
"formatUL",
"align",
"|",
"insertLink",
"insertImage",
"insertTable",
"|",
"undo",
"redo",
"html"
]
2020-07-28 10:03:53 +08:00
```
## 属性表
当做选择器表单项使用时,除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外,还支持下面一些配置
2020-09-11 12:58:20 +08:00
| 属性名 | 类型 | 默认值 | 说明 |
| --------- | ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| saveAsUbb | `boolean` | | 是否保存为 ubb 格式 |
| reciever | [API](../../types/api) | | 默认的图片保存 API |
| size | `string` | | 框的大小,可设置为 `md` 或者 `lg` |
| options | `object` | | 需要参考 [tinymce](https://www.tiny.cloud/docs/configure/integration-and-setup/) 或 [froala](https://www.froala.com/wysiwyg-editor/docs/options) 的文档 |
| buttons | `Array<string>` | | froala 专用配置显示的按钮tinymce 可以通过前面的 options 设置 [toolbar](https://www.tiny.cloud/docs/demo/custom-toolbar-button/) 字符串 |