diff --git a/docs/package-lock.json b/docs/package-lock.json index b363acf3..7360c19a 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -15,6 +15,11 @@ "resolved": "https://registry.npmjs.org/@ctrl/tinycolor/-/tinycolor-3.4.1.tgz", "integrity": "sha512-ej5oVy6lykXsvieQtqZxCOaLT+xD4+QNarq78cIYISHmZXshCvROLudpQN3lfL8G0NL7plMSSK+zlyvCaIJ4Iw==" }, + "@element-plus/icons": { + "version": "0.0.11", + "resolved": "https://registry.npmjs.org/@element-plus/icons/-/icons-0.0.11.tgz", + "integrity": "sha512-iKQXSxXu131Ai+I9Ymtcof9WId7kaXvB1+WRfAfpQCW7UiAMYgdNDqb/u0hgTo2Yq3MwC4MWJnNuTBEpG8r7+A==" + }, "@element-plus/icons-vue": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/@element-plus/icons-vue/-/icons-vue-1.1.4.tgz", @@ -59,11 +64,6 @@ "fastq": "^1.6.0" } }, - "@popperjs/core": { - "version": "npm:@sxzz/popperjs-es@2.11.7", - "resolved": "https://registry.npmjs.org/@sxzz/popperjs-es/-/popperjs-es-2.11.7.tgz", - "integrity": "sha512-Ccy0NlLkzr0Ex2FKvh2X+OyERHXJ88XJ1MXtsI9y9fGexlaXaVTPzBCRBwIxFkORuOb+uBqeu+RqnpgYTEZRUQ==" - }, "@types/debug": { "version": "4.1.7", "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.7.tgz", @@ -526,9 +526,9 @@ } }, "@vueuse/metadata": { - "version": "8.3.1", - "resolved": "https://registry.npmjs.org/@vueuse/metadata/-/metadata-8.3.1.tgz", - "integrity": "sha512-1aZaFL44HzXXkfN6Q7KMDOXBFKTHDClHlOJBxtN8rTBXIIScoGOrJCpxWiQ4kuVg95MzG/pHrd3P4wd8poL9XQ==" + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/@vueuse/metadata/-/metadata-8.5.0.tgz", + "integrity": "sha512-WxsD+Cd+bn+HcjpY6Dl9FJ8ywTRTT9pTwk3bCQpzEhXVYAyNczKDSahk50fCfIJKeWHhyI4B2+/ZEOxQAkUr0g==" }, "@vueuse/shared": { "version": "7.6.2", @@ -767,9 +767,9 @@ "dev": true }, "dayjs": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.11.1.tgz", - "integrity": "sha512-ER7EjqVAMkRRsxNCC5YqJ9d9VQYuWdGt7aiH2qA5R5wt8ZmWaP2dLUSIK6y/kVzLMlmh1Tvu5xUf4M/wdGJ5KA==" + "version": "1.11.2", + "resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.11.2.tgz", + "integrity": "sha512-F4LXf1OeU9hrSYRPTTj/6FbO4HTjPKXvEIC1P2kcnFurViINCVk3ZV0xAS3XVx9MkMsXbbqlK6hjseaYbgKEHw==" }, "debug": { "version": "4.3.3", @@ -805,9 +805,9 @@ "dev": true }, "element-plus": { - "version": "2.1.11", - "resolved": "https://registry.npmjs.org/element-plus/-/element-plus-2.1.11.tgz", - "integrity": "sha512-s4X0I8s787tv+9UdekBC1g7v42Fj4bucPAmu03EjbgrGrV7BJvkoBGuK52lNfu4yC76bl6Uyjesd5Fu8CMakSw==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/element-plus/-/element-plus-2.2.0.tgz", + "integrity": "sha512-zxmAFEAa1T/n09rR+NozXcWl5CjaFtqoaxhFSafag0dgc90tgEHitDXfegdFAl4ahugdNTqu9aLzngx3VhDAtA==", "requires": { "@ctrl/tinycolor": "^3.4.1", "@element-plus/icons-vue": "^1.1.4", @@ -826,20 +826,25 @@ "normalize-wheel-es": "^1.1.2" }, "dependencies": { + "@popperjs/core": { + "version": "npm:@sxzz/popperjs-es@2.11.7", + "resolved": "https://registry.npmjs.org/@sxzz/popperjs-es/-/popperjs-es-2.11.7.tgz", + "integrity": "sha512-Ccy0NlLkzr0Ex2FKvh2X+OyERHXJ88XJ1MXtsI9y9fGexlaXaVTPzBCRBwIxFkORuOb+uBqeu+RqnpgYTEZRUQ==" + }, "@vueuse/core": { - "version": "8.3.1", - "resolved": "https://registry.npmjs.org/@vueuse/core/-/core-8.3.1.tgz", - "integrity": "sha512-WiXUgVyPG9elGx3G8UV8g+zqbEJ2hYacrPICogAxDdW6hnxxcUFdF7FtvDroJ/DxWmo2pg8XNNz07ybfnZyJbw==", + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/@vueuse/core/-/core-8.5.0.tgz", + "integrity": "sha512-VEJ6sGNsPlUp0o9BGda2YISvDZbhWJSOJu5zlp2TufRGVrLcYUKr31jyFEOj6RXzG3k/H4aCYeZyjpItfU8glw==", "requires": { - "@vueuse/metadata": "8.3.1", - "@vueuse/shared": "8.3.1", + "@vueuse/metadata": "8.5.0", + "@vueuse/shared": "8.5.0", "vue-demi": "*" } }, "@vueuse/shared": { - "version": "8.3.1", - "resolved": "https://registry.npmjs.org/@vueuse/shared/-/shared-8.3.1.tgz", - "integrity": "sha512-7HKLCcxp4dtONq6QSSoavblo9riYgqzw7jhqiC0/VUYMXKzqj1G/GznOzTmY8Wi8uKKT197JqjKQ1DKt2j/0+A==", + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/@vueuse/shared/-/shared-8.5.0.tgz", + "integrity": "sha512-qKG+SZb44VvGD4dU5cQ63z4JE2Yk39hQUecR0a9sEdJA01cx+XrxAvFKJfPooxwoiqalAVw/ktWK6xbyc/jS3g==", "requires": { "vue-demi": "*" } diff --git a/docs/package.json b/docs/package.json index 493b892c..06ffb76c 100644 --- a/docs/package.json +++ b/docs/package.json @@ -7,6 +7,7 @@ "build": "vuepress build src -d dist" }, "dependencies": { + "@element-plus/icons": "0.0.11", "element-plus": "^2.2.0", "highlight.js": "^11.2.0" }, diff --git a/docs/src/.vuepress/clientAppEnhance.ts b/docs/src/.vuepress/clientAppEnhance.ts index c49b4c0e..1b560941 100644 --- a/docs/src/.vuepress/clientAppEnhance.ts +++ b/docs/src/.vuepress/clientAppEnhance.ts @@ -8,6 +8,27 @@ import DemoBlock from './demo-block.vue'; export default defineClientAppEnhance(({ app }) => { app.use(ElementPlus); - app.use(MagicForm); + app.use(MagicForm, { + request: (options: any) => new Promise((resolve) => { + if (options.url === 'select/remote') { + setTimeout(() => { + resolve({ + data: [ + { + name: 'select-1', + id: 1 + }, + { + name: 'select-2', + id: 2 + }, + ], + }); + }, 1000); + } else { + resolve({}); + } + }), + }); app.component('demo-block', DemoBlock); }); diff --git a/docs/src/.vuepress/config.ts b/docs/src/.vuepress/config.ts index 4ad2a772..b309f5f4 100644 --- a/docs/src/.vuepress/config.ts +++ b/docs/src/.vuepress/config.ts @@ -50,27 +50,56 @@ const sidebar = { ] } ], - api: [ + editorApi: [ { text: '编辑器', children: [ - '/api/editor', - '/api/model', + '/api/editor/editor', + '/api/editor/services', ] }, + ], + formApi: [ { text: '表单', children: [ - '/api/form', + '/api/form/form', + ] + }, + ], + formConfig: [ + { + text: '表单配置', + children: [ + '/api/form-config/layout', ] }, { - text: '表单配置协议', + text: 'field配置', children: [ - '/api/base-config', - '/api/field-config', + '/api/form-config/fields/cascader', + '/api/form-config/fields/checkbox', + '/api/form-config/fields/color-picker', + '/api/form-config/fields/date-picker', + '/api/form-config/fields/datetime-picker', + '/api/form-config/fields/display', + '/api/form-config/fields/hidden', + '/api/form-config/fields/number', + '/api/form-config/fields/input', + '/api/form-config/fields/link', + '/api/form-config/fields/redio', + '/api/form-config/fields/select', + '/api/form-config/fields/switch', + '/api/form-config/fields/textarea', + '/api/form-config/fields/time-picker', ] - } + }, + { + text: '联动配置', + children: [ + '/api/form-config/relate', + ] + }, ] }; @@ -104,7 +133,20 @@ export default defineUserConfig({ }, { text: 'API参考', - link: '/api/editor' + children: [ + { + text: '编辑器', + link: '/api/editor/editor' + }, + { + text: '表单', + link: '/api/form/form' + }, + { + text: '表单配置', + link: '/api/form-config/layout' + }, + ], }, { text: '查看源码', link: 'https://github.com/Tencent/tmagic-editor' @@ -119,7 +161,9 @@ export default defineUserConfig({ '/guide/': sidebar.guide, '/page/': sidebar.page, '/component/': sidebar.component, - '/api/': sidebar.api, + '/api/editor': sidebar.editorApi, + '/api/form': sidebar.formApi, + '/api/form-config': sidebar.formConfig, }, smoothScroll: false, lastUpdated: false, diff --git a/docs/src/.vuepress/demo-block.vue b/docs/src/.vuepress/demo-block.vue index 111c3270..e574dab5 100644 --- a/docs/src/.vuepress/demo-block.vue +++ b/docs/src/.vuepress/demo-block.vue @@ -20,21 +20,20 @@
- + - {{ controlText }} + {{ controlText }} @@ -187,7 +186,7 @@ .control-button { line-height: 26px; position: absolute; - top: 0; + top: 10px; right: 0; font-size: 14px; padding-left: 5px; diff --git a/docs/src/api/editor.md b/docs/src/api/editor/editor.md similarity index 100% rename from docs/src/api/editor.md rename to docs/src/api/editor/editor.md diff --git a/docs/src/api/model.md b/docs/src/api/editor/services.md similarity index 100% rename from docs/src/api/model.md rename to docs/src/api/editor/services.md diff --git a/docs/src/api/field-config.md b/docs/src/api/field-config.md deleted file mode 100644 index dbc3f080..00000000 --- a/docs/src/api/field-config.md +++ /dev/null @@ -1,1222 +0,0 @@ -# 基础组件 - -## Cascader 级联选择器 - -当一个数据集合有清晰的层级结构时,可通过级联选择器逐级查看并选择。 - -### 基础用法 - -有两种触发子菜单的方式 - - - -### 禁用选项 - -通过在数据源中设置 disabled 字段来声明该选项是禁用的 - - - - - -#### 多选 - -可通过 `multiple = true` 来开启多选模式 - - - - - -## Checkbox 多选框 -一组备选项中进行多选 - -### 基础用法 - -单独使用可以表示两种状态之间的切换。 - - - - - -### 禁用状态 - -多选框不可用状态。 - - - - - -### 多选框组 - -适用于多个勾选框绑定到同一个数组的情景,通过是否勾选来表示这一组选项中选中的项。 - - - - - - -### Checkbox Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| activeValue | 选中时的值 | string / number / Function | — | 1 | -| inactiveValue | 没有选中时的值 | string / number / Function | — | 0 | -| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | - -### CheckboxGroup Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | -| options | 选项 | Array | — | - | - -## ColorPicker 颜色选择器 - -用于颜色选择,支持多种格式。 - -### 基础用法 - - - - - - -## DatePicker 日期选择器 - -用于选择或输入日期 - -### 基础用法 - - - - - -### 禁用状态 - - - - -### 日期格式 - -使用`format`指定输入框的格式;使用`valueFormat`指定绑定值的格式。 - -默认情况下,组件接受并返回`Date`对象。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例: - -:::warning -请注意大小写 -::: - -| 格式 | 含义 | 备注 | 举例 | -|------|------|------|------| -| `yyyy` | 年 | | 2017 | -| `M` | 月 | 不补0 | 1 | -| `MM` | 月 | | 01 | -| `W` | 周 | 仅周选择器的 `format` 可用;不补0 | 1 | -| `WW` | 周 | 仅周选择器的 `format` 可用 | 01 | -| `d` | 日 | 不补0 | 2 | -| `dd` | 日 | | 02 | -| `H` | 小时 | 24小时制;不补0 | 3 | -| `HH` | 小时 | 24小时制 | 03 | -| `h` | 小时 | 12小时制,须和 `A` 或 `a` 使用;不补0 | 3 | -| `hh` | 小时 | 12小时制,须和 `A` 或 `a` 使用 | 03 | -| `m` | 分钟 | 不补0 | 4 | -| `mm` | 分钟 | | 04 | -| `s` | 秒 | 不补0 | 5 | -| `ss` | 秒 | | 05 | -| `timestamp` | JS时间戳 | 组件绑定值为`number`类型 | 1483326245000 | -| `[MM]` | 不需要格式化字符 | 使用方括号标识不需要格式化的字符 (如 [A] [MM]) | MM | - - - - - -### Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------------- |---------- |-------------------------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| value-format | 可选,绑定值的格式。不指定则绑定值为 Date 对象 | string | 见[日期格式](#/zh-CN/component/date-picker#ri-qi-ge-shi) | — | -| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | - - - - -## DateTimePicker 日期时间选择器 - -在同一个选择器里选择日期和时间 - -### 基础用法 - - - - - -### 禁用状态 - - - - - -### 日期格式 - -使用`format`指定输入框的格式;使用`valueFormat`指定绑定值的格式。 - -默认情况下,组件接受并返回`Date`对象。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例: - -:::warning -请注意大小写 -::: - -| 格式 | 含义 | 备注 | 举例 | -|------|------|------|------| -| `yyyy` | 年 | | 2017 | -| `M` | 月 | 不补0 | 1 | -| `MM` | 月 | | 01 | -| `W` | 周 | 仅周选择器的 `format` 可用;不补0 | 1 | -| `WW` | 周 | 仅周选择器的 `format` 可用 | 01 | -| `d` | 日 | 不补0 | 2 | -| `dd` | 日 | | 02 | -| `H` | 小时 | 24小时制;不补0 | 3 | -| `HH` | 小时 | 24小时制 | 03 | -| `h` | 小时 | 12小时制,须和 `A` 或 `a` 使用;不补0 | 3 | -| `hh` | 小时 | 12小时制,须和 `A` 或 `a` 使用 | 03 | -| `m` | 分钟 | 不补0 | 4 | -| `mm` | 分钟 | | 04 | -| `s` | 秒 | 不补0 | 5 | -| `ss` | 秒 | | 05 | -| `A` | AM/PM | 仅 `format` 可用,大写 | AM | -| `a` | am/pm | 仅 `format` 可用,小写 | am | -| `timestamp` | JS时间戳 | 仅 `valueFormat` 可用;组件绑定值为`number`类型 | 1483326245000 | -| `[MM]` | 不需要格式化字符 | 使用方括号标识不需要格式化的字符 (如 [A] [MM]) | MM | - - - - - -### Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------------- |---------- |-------------------------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| format | 显示在输入框中的格式 | string | 见[日期格式](#/zh-CN/component/date-picker#ri-qi-ge-shi) | yyyy-MM-dd HH:mm:ss | -| value-format | 可选,绑定值的格式。不指定则绑定值为 Date 对象 | string | 见[日期格式](#/zh-CN/component/date-picker#ri-qi-ge-shi) | — | -| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | - -## Display 只读文本 - -用于显示,不可编辑 - -### TS 定义 - -```typescript -interface Display extends FormItem { - type: 'display'; -} -``` - -点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 - -### 基础用法 - - - - - - -### Input Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | - -## Hidden 隐藏域 - -改值体现于最终提交的表单中,用于例如编辑记录的id这种场景中 - -### TS 定义 - -```typescript -interface Hidden extends FormItem { - type: 'hidden'; -} -``` - -点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 - -### 基础用法 - - - - - - -### Input Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | - -## InputNumber 计数器 - -仅允许输入标准的数字值,可定义范围 - -### 基础用法 - - - - - -### 禁用状态 - - - - - -### 步数 - -允许定义递增递减的步数控制 - - - - - - -### Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|----------|-------------- |----------|-------------------------------- |-------- | -| name | 绑定值 | string | — | — | -| placeholder | 输入框占位文本 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| min | 设置计数器允许的最小值 | number | — | -Infinity | -| max | 设置计数器允许的最大值 | number | — | Infinity | -| step | 计数器步长 | number | — | 1 | -| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | - -## Input 输入框 - -通过鼠标或键盘输入字符 - -### 基础用法 - - - - - - -### 禁用状态 - - - - - -### 复合型输入框 - -后置内容 - - - - - - - - - -### 过滤内容 - - - - - -### 去掉首尾空格 - - - - - -### 显示详情 - - - - - -### Input Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| placeholder | 输入框占位文本 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| tooltip | 输入时显示内容 | boolean | — | false | -| placeholder | 输入框占位文本 | string | — | — | -| trim | 是否去掉首尾空格 | boolean | — | false | -| filter | 过滤值 | string / Function | number | - | -| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | -| append | 后置内容 | string / Object | — | - | - -### append Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| type | 内容类型 | string | button | — | -| text | 文本内容 | string | — | — | -| handler | 点击操作 | Function | — | - | - -## Link 链接 - -用于显示,不可编辑 - -### TS 定义 - -```typescript -interface Link extends FormItem { - type: 'link'; - href?: string | typeof LinkHrefFunction; - css?: { - [key: string]: string | number; - }; - disabledCss?: { - [key: string]: string | number; - }; - formTitle?: string; - formWidth?: number | string; - displayText?: string | typeof LinkDisplayTextFunction; - form: FormConfig | typeof LinkFormFunction; -} -``` - -点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 - -### 基础用法 - - - - - -### 打开表单 - - - - - - -### Input Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | - -## Radio 单选框 - -在一组备选项中进行单选 - -### TS 定义 - -```typescript -interface RedioGroup extends FormItem { - type: 'redioGroup'; - options: { - value: any; - text: string; - }[]; -} -``` - -点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 - -### 基础用法 - -由于选项默认可见,不宜过多,若选项过多,建议使用 Select 选择器。 - - - - - -### 禁用状态 - -单选框不可用的状态。 - - - - - -### RadioGroup Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| options | 选项 | Array | — | - | -| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | - -## Select 选择器 - -当选项过多时,使用下拉菜单展示并选择内容。 - -### 基础用法 - -适用广泛的基础单选 - - - - - -### 有禁用选项 - - - - - -### 禁用状态 - -选择器不可用状态 - - - - - -### 基础多选 - -适用性较广的基础多选,用 Tag 展示已选项 - - - -### 分组 - -备选项进行分组展示 - - - - - -### 创建条目 - -可以创建并选中选项中不存在的条目 - - - -### 远程选项 - -通过接口请求获取选项列表 - - - - - -:::tip -如果 Select 的绑定值为对象类型,请务必指定 valueKey 作为它的唯一性标识。 -::: - -### Select Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------------- |---------- |-------------------------------- |-------- | -| name | 绑定值 | string | — | — | -| placeholder | 输入框占位文本 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| multiple | 是否多选 | boolean | — | false | -| valueKey | 作为 value 唯一标识的键名,绑定值为对象类型时必填 | string | — | value | -| allowCreate | 是否允许用户创建新条目 | boolean | — | false | -| remote | 是否为远程搜索 | boolean | — | false | -| group | 是否选择分组 | boolean | — | false | -| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | -| options | 选项 | Array | — | - | -| option | 选项 | Object | — | - | - -### options item -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------------- |---------- |-------------------------------- |-------- | -| text | | 选项的标签 | string/number/object | — | — | -| value | 选项的值 | string | — | — | -| disabled | 是否禁用 | boolean | — | false | -| label | string | — | — | — | -| options | Array | — | — | — | - -### option -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------------- |---------- |-------------------------------- |-------- | -| url | string | — | — | — | -| root | string | — | — | — | -| text | string / Function | — | — | — | -| value | string / Function | — | — | — | - -## Switch 开关 - -表示两种相互对立的状态间的切换,多用于触发「开/关」。 - -### 基本用法 - - - -### 扩展的 value 类型 - - - - - -### 禁用状态 - - - - - - -### Attributes - -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| disabled | 是否禁用 | boolean / [Function](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| active-value | switch 打开时的值 | boolean / string / number | — | true | -| inactive-value | switch 关闭时的值 | boolean / string / number | — | false | - -## Textarea 文本域 - -### 基础用法 - - - - - -### 禁用状态 - - - - - -### Input Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------- |---------- |------------- |-------- | -| name | 绑定值 | string | — | — | -| placeholder | 输入框占位文本 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | -| placeholder | 输入框占位文本 | string | — | — | -| trim | 是否去掉首尾空格 | boolean | — | false | -| filter | 过滤值 | string / Function | number | - | -| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | - -## TimePicker 时间选择器 - - 用于选择或输入日期 - -### 基础用法 - - - - - -### 禁用状态 - - - - - - -### Attributes -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -|---------- |-------------- |---------- |-------------------------------- |-------- | -| name | 绑定值 | string | — | — | -| placeholder | 输入框占位文本 | string | — | — | -| text | 表单标签 | string | — | — | -| disabled | 是否禁用 | boolean / [Function](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | diff --git a/docs/src/api/form-config/fields/cascader.md b/docs/src/api/form-config/fields/cascader.md new file mode 100644 index 00000000..d1da40b5 --- /dev/null +++ b/docs/src/api/form-config/fields/cascader.md @@ -0,0 +1,216 @@ +# Cascader 级联选择器 + +当一个数据集合有清晰的层级结构时,可通过级联选择器逐级查看并选择。 + +## 基础用法 + +有两种触发子菜单的方式 + + + +## 禁用选项 + +通过在数据源中设置 disabled 字段来声明该选项是禁用的 + + + + + +## 多选 + +可通过 `multiple = true` 来开启多选模式 + + + + diff --git a/docs/src/api/form-config/fields/checkbox.md b/docs/src/api/form-config/fields/checkbox.md new file mode 100644 index 00000000..f5e89766 --- /dev/null +++ b/docs/src/api/form-config/fields/checkbox.md @@ -0,0 +1,75 @@ +# Checkbox 多选框 +一组备选项中进行多选 + +## 基础用法 + +单独使用可以表示两种状态之间的切换。 + + + + + +## 禁用状态 + +多选框不可用状态。 + + + + + +## 多选框组 + +适用于多个勾选框绑定到同一个数组的情景,通过是否勾选来表示这一组选项中选中的项。 + + + + + + +## Checkbox Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| activeValue | 选中时的值 | string / number / Function | — | 1 | +| inactiveValue | 没有选中时的值 | string / number / Function | — | 0 | +| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | + +## CheckboxGroup Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | +| options | 选项 | Array | — | - | diff --git a/docs/src/api/form-config/fields/color-picker.md b/docs/src/api/form-config/fields/color-picker.md new file mode 100644 index 00000000..10f3b7f0 --- /dev/null +++ b/docs/src/api/form-config/fields/color-picker.md @@ -0,0 +1,17 @@ +# ColorPicker 颜色选择器 + +用于颜色选择,支持多种格式。 + +## 基础用法 + + + + diff --git a/docs/src/api/form-config/fields/date-picker.md b/docs/src/api/form-config/fields/date-picker.md new file mode 100644 index 00000000..4c31f352 --- /dev/null +++ b/docs/src/api/form-config/fields/date-picker.md @@ -0,0 +1,86 @@ +# DatePicker 日期选择器 + +用于选择或输入日期 + +## 基础用法 + + + + + +## 禁用状态 + + + + +## 日期格式 + +使用`format`指定输入框的格式;使用`valueFormat`指定绑定值的格式。 + +默认情况下,组件接受并返回`Date`对象。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例: + +:::warning +请注意大小写 +::: + +| 格式 | 含义 | 备注 | 举例 | +|------|------|------|------| +| `yyyy` | 年 | | 2017 | +| `M` | 月 | 不补0 | 1 | +| `MM` | 月 | | 01 | +| `W` | 周 | 仅周选择器的 `format` 可用;不补0 | 1 | +| `WW` | 周 | 仅周选择器的 `format` 可用 | 01 | +| `d` | 日 | 不补0 | 2 | +| `dd` | 日 | | 02 | +| `H` | 小时 | 24小时制;不补0 | 3 | +| `HH` | 小时 | 24小时制 | 03 | +| `h` | 小时 | 12小时制,须和 `A` 或 `a` 使用;不补0 | 3 | +| `hh` | 小时 | 12小时制,须和 `A` 或 `a` 使用 | 03 | +| `m` | 分钟 | 不补0 | 4 | +| `mm` | 分钟 | | 04 | +| `s` | 秒 | 不补0 | 5 | +| `ss` | 秒 | | 05 | +| `timestamp` | JS时间戳 | 组件绑定值为`number`类型 | 1483326245000 | +| `[MM]` | 不需要格式化字符 | 使用方括号标识不需要格式化的字符 (如 [A] [MM]) | MM | + + + + + +## Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| value-format | 可选,绑定值的格式。不指定则绑定值为 Date 对象 | string | 见[日期格式](#/zh-CN/component/date-picker#ri-qi-ge-shi) | — | +| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | + + + diff --git a/docs/src/api/form-config/fields/datetime-picker.md b/docs/src/api/form-config/fields/datetime-picker.md new file mode 100644 index 00000000..3ed04722 --- /dev/null +++ b/docs/src/api/form-config/fields/datetime-picker.md @@ -0,0 +1,88 @@ +# DateTimePicker 日期时间选择器 + +在同一个选择器里选择日期和时间 + +## 基础用法 + + + + + +## 禁用状态 + + + + + +## 日期格式 + +使用`format`指定输入框的格式;使用`valueFormat`指定绑定值的格式。 + +默认情况下,组件接受并返回`Date`对象。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例: + +:::warning +请注意大小写 +::: + +| 格式 | 含义 | 备注 | 举例 | +|------|------|------|------| +| `yyyy` | 年 | | 2017 | +| `M` | 月 | 不补0 | 1 | +| `MM` | 月 | | 01 | +| `W` | 周 | 仅周选择器的 `format` 可用;不补0 | 1 | +| `WW` | 周 | 仅周选择器的 `format` 可用 | 01 | +| `d` | 日 | 不补0 | 2 | +| `dd` | 日 | | 02 | +| `H` | 小时 | 24小时制;不补0 | 3 | +| `HH` | 小时 | 24小时制 | 03 | +| `h` | 小时 | 12小时制,须和 `A` 或 `a` 使用;不补0 | 3 | +| `hh` | 小时 | 12小时制,须和 `A` 或 `a` 使用 | 03 | +| `m` | 分钟 | 不补0 | 4 | +| `mm` | 分钟 | | 04 | +| `s` | 秒 | 不补0 | 5 | +| `ss` | 秒 | | 05 | +| `A` | AM/PM | 仅 `format` 可用,大写 | AM | +| `a` | am/pm | 仅 `format` 可用,小写 | am | +| `timestamp` | JS时间戳 | 仅 `valueFormat` 可用;组件绑定值为`number`类型 | 1483326245000 | +| `[MM]` | 不需要格式化字符 | 使用方括号标识不需要格式化的字符 (如 [A] [MM]) | MM | + + + + + +## Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| format | 显示在输入框中的格式 | string | 见[日期格式](#/zh-CN/component/date-picker#ri-qi-ge-shi) | yyyy-MM-dd HH:mm:ss | +| value-format | 可选,绑定值的格式。不指定则绑定值为 Date 对象 | string | 见[日期格式](#/zh-CN/component/date-picker#ri-qi-ge-shi) | — | +| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | diff --git a/docs/src/api/form-config/fields/display.md b/docs/src/api/form-config/fields/display.md new file mode 100644 index 00000000..cd7e2ee5 --- /dev/null +++ b/docs/src/api/form-config/fields/display.md @@ -0,0 +1,36 @@ + +# Display 只读文本 + +用于显示,不可编辑 + +## TS 定义 + +```typescript +interface Display extends FormItem { + type: 'display'; +} +``` + +点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 + +## 基础用法 + + + + + + +## Input Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | diff --git a/docs/src/api/form-config/fields/hidden.md b/docs/src/api/form-config/fields/hidden.md new file mode 100644 index 00000000..e84dd6e1 --- /dev/null +++ b/docs/src/api/form-config/fields/hidden.md @@ -0,0 +1,32 @@ +# Hidden 隐藏域 + +改值体现于最终提交的表单中,用于例如编辑记录的id这种场景中 + +## TS 定义 + +```typescript +interface Hidden extends FormItem { + type: 'hidden'; +} +``` + +点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 + +## 基础用法 + + + + + + +## Input Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | diff --git a/docs/src/api/form-config/fields/input.md b/docs/src/api/form-config/fields/input.md new file mode 100644 index 00000000..6fd0e90f --- /dev/null +++ b/docs/src/api/form-config/fields/input.md @@ -0,0 +1,128 @@ +# Input 输入框 + +通过鼠标或键盘输入字符 + +## 基础用法 + + + + + + +## 禁用状态 + + + + + +## 复合型输入框 + +后置内容 + + + + + + + + + +## 过滤内容 + + + + + +## 去掉首尾空格 + + + + + +## 显示详情 + + + + + +## Input Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| placeholder | 输入框占位文本 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| tooltip | 输入时显示内容 | boolean | — | false | +| placeholder | 输入框占位文本 | string | — | — | +| trim | 是否去掉首尾空格 | boolean | — | false | +| filter | 过滤值 | string / Function | number | - | +| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | +| append | 后置内容 | string / Object | — | - | + +## append Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| type | 内容类型 | string | button | — | +| text | 文本内容 | string | — | — | +| handler | 点击操作 | Function | — | - | diff --git a/docs/src/api/form-config/fields/link.md b/docs/src/api/form-config/fields/link.md new file mode 100644 index 00000000..1c7a0a35 --- /dev/null +++ b/docs/src/api/form-config/fields/link.md @@ -0,0 +1,64 @@ +# Link 链接 + +用于显示,不可编辑 + +## TS 定义 + +```typescript +interface Link extends FormItem { + type: 'link'; + href?: string | typeof LinkHrefFunction; + css?: { + [key: string]: string | number; + }; + disabledCss?: { + [key: string]: string | number; + }; + formTitle?: string; + formWidth?: number | string; + displayText?: string | typeof LinkDisplayTextFunction; + form: FormConfig | typeof LinkFormFunction; +} +``` + +点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 + +## 基础用法 + + + + + +## 打开表单 + + + + + + +## Input Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | diff --git a/docs/src/api/form-config/fields/number.md b/docs/src/api/form-config/fields/number.md new file mode 100644 index 00000000..204b403f --- /dev/null +++ b/docs/src/api/form-config/fields/number.md @@ -0,0 +1,62 @@ +# InputNumber 计数器 + +仅允许输入标准的数字值,可定义范围 + +## 基础用法 + + + + + +## 禁用状态 + + + + + +## 步数 + +允许定义递增递减的步数控制 + + + + + + +## Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|----------|-------------- |----------|-------------------------------- |-------- | +| name | 绑定值 | string | — | — | +| placeholder | 输入框占位文本 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| min | 设置计数器允许的最小值 | number | — | -Infinity | +| max | 设置计数器允许的最大值 | number | — | Infinity | +| step | 计数器步长 | number | — | 1 | +| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | diff --git a/docs/src/api/form-config/fields/redio.md b/docs/src/api/form-config/fields/redio.md new file mode 100644 index 00000000..9425b47d --- /dev/null +++ b/docs/src/api/form-config/fields/redio.md @@ -0,0 +1,67 @@ +# Radio 单选框 + +在一组备选项中进行单选 + +## TS 定义 + +```typescript +interface RedioGroup extends FormItem { + type: 'redioGroup'; + options: { + value: any; + text: string; + }[]; +} +``` + +点击查看[FormItem](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts)的定义 + +## 基础用法 + +由于选项默认可见,不宜过多,若选项过多,建议使用 Select 选择器。 + + + + + +## 禁用状态 + +单选框不可用的状态。 + + + + + +## RadioGroup Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| options | 选项 | Array | — | - | +| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | diff --git a/docs/src/api/form-config/fields/select.md b/docs/src/api/form-config/fields/select.md new file mode 100644 index 00000000..b6b7a54e --- /dev/null +++ b/docs/src/api/form-config/fields/select.md @@ -0,0 +1,200 @@ +# Select 选择器 + +当选项过多时,使用下拉菜单展示并选择内容。 + +## 基础用法 + +适用广泛的基础单选 + + + + + +## 有禁用选项 + + + + + +## 禁用状态 + +选择器不可用状态 + + + + + +## 基础多选 + +适用性较广的基础多选,用 Tag 展示已选项 + + + +## 分组 + +备选项进行分组展示 + + + + + +## 创建条目 + +可以创建并选中选项中不存在的条目 + + + +## 远程选项 + +通过接口请求获取选项列表 + + + + + +:::tip +如果 Select 的绑定值为对象类型,请务必指定 valueKey 作为它的唯一性标识。 +::: + +## Select Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| name | 绑定值 | string | — | — | +| placeholder | 输入框占位文本 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| multiple | 是否多选 | boolean | — | false | +| valueKey | 作为 value 唯一标识的键名,绑定值为对象类型时必填 | string | — | value | +| allowCreate | 是否允许用户创建新条目 | boolean | — | false | +| remote | 是否为远程搜索 | boolean | — | false | +| group | 是否选择分组 | boolean | — | false | +| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | +| options | 选项 | Array | — | - | +| option | 选项 | Object | — | - | + +## options item +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| text | | 选项的标签 | string/number/object | — | — | +| value | 选项的值 | string | — | — | +| disabled | 是否禁用 | boolean | — | false | +| label | string | — | — | — | +| options | Array | — | — | — | + +## option +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| url | string | — | — | — | +| root | string | — | — | — | +| text | string / Function | — | — | — | +| value | string / Function | — | — | — | diff --git a/docs/src/api/form-config/fields/select.md~Stashed changes b/docs/src/api/form-config/fields/select.md~Stashed changes new file mode 100644 index 00000000..0cb8f9e0 --- /dev/null +++ b/docs/src/api/form-config/fields/select.md~Stashed changes @@ -0,0 +1,200 @@ +# Select 选择器 + +当选项过多时,使用下拉菜单展示并选择内容。 + +## 基础用法 + +适用广泛的基础单选 + + + + + +## 有禁用选项 + + + + + +## 禁用状态 + +选择器不可用状态 + + + + + +## 基础多选 + +适用性较广的基础多选,用 Tag 展示已选项 + + + +## 分组 + +备选项进行分组展示 + + + + + +## 创建条目 + +可以创建并选中选项中不存在的条目 + + + +## 远程选项 + +通过接口请求获取选项列表 + + + + + +:::tip +如果 Select 的绑定值为对象类型,请务必指定 valueKey 作为它的唯一性标识。 +::: + +## Select Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| name | 绑定值 | string | — | — | +| placeholder | 输入框占位文本 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| multiple | 是否多选 | boolean | — | false | +| valueKey | 作为 value 唯一标识的键名,绑定值为对象类型时必填 | string | — | value | +| allowCreate | 是否允许用户创建新条目 | boolean | — | false | +| remote | 是否为远程搜索 | boolean | — | false | +| group | 是否选择分组 | boolean | — | false | +| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | +| options | 选项 | Array | — | - | +| option | 选项 | Object | — | - | + +## options item +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| text | | 选项的标签 | string/number/object | — | — | +| value | 选项的值 | string | — | — | +| disabled | 是否禁用 | boolean | — | false | +| label | string | — | — | — | +| options | Array | — | — | — | + +## option +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| url | string | — | — | — | +| root | string | — | — | — | +| text | string / Function | — | — | — | +| value | string / Function | — | — | — | diff --git a/docs/src/api/form-config/fields/switch.md b/docs/src/api/form-config/fields/switch.md new file mode 100644 index 00000000..db715b15 --- /dev/null +++ b/docs/src/api/form-config/fields/switch.md @@ -0,0 +1,52 @@ +# Switch 开关 + +表示两种相互对立的状态间的切换,多用于触发「开/关」。 + +## 基本用法 + + + +## 扩展的 value 类型 + + + + + +## 禁用状态 + + + + + + +## Attributes + +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| disabled | 是否禁用 | boolean / [Function](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| active-value | switch 打开时的值 | boolean / string / number | — | true | +| inactive-value | switch 关闭时的值 | boolean / string / number | — | false | diff --git a/docs/src/api/form-config/fields/textarea.md b/docs/src/api/form-config/fields/textarea.md new file mode 100644 index 00000000..44ad00f5 --- /dev/null +++ b/docs/src/api/form-config/fields/textarea.md @@ -0,0 +1,42 @@ +# Textarea 文本域 + +## 基础用法 + + + + + +## 禁用状态 + + + + + +## Input Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------- |---------- |------------- |-------- | +| name | 绑定值 | string | — | — | +| placeholder | 输入框占位文本 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | +| placeholder | 输入框占位文本 | string | — | — | +| trim | 是否去掉首尾空格 | boolean | — | false | +| filter | 过滤值 | string / Function | number | - | +| onChange | 值变化时触发的函数 | [OnChangeHandler ](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | - | diff --git a/docs/src/api/form-config/fields/time-picker.md b/docs/src/api/form-config/fields/time-picker.md new file mode 100644 index 00000000..11f1124c --- /dev/null +++ b/docs/src/api/form-config/fields/time-picker.md @@ -0,0 +1,41 @@ +# TimePicker 时间选择器 + + 用于选择或输入日期 + +## 基础用法 + + + + + +## 禁用状态 + + + + + + +## Attributes +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +|---------- |-------------- |---------- |-------------------------------- |-------- | +| name | 绑定值 | string | — | — | +| placeholder | 输入框占位文本 | string | — | — | +| text | 表单标签 | string | — | — | +| disabled | 是否禁用 | boolean / [Function](https://github.com/Tencent/tmagic-editor/blob/master/packages/form/src/schema.ts) | — | false | diff --git a/docs/src/api/base-config.md b/docs/src/api/form-config/layout.md similarity index 100% rename from docs/src/api/base-config.md rename to docs/src/api/form-config/layout.md diff --git a/docs/src/api/form-config/relate.md b/docs/src/api/form-config/relate.md new file mode 100644 index 00000000..b83608d1 --- /dev/null +++ b/docs/src/api/form-config/relate.md @@ -0,0 +1,33 @@ +# 联动 + +## 显隐 + + + +## 输入关联 + + + diff --git a/docs/src/api/form.md b/docs/src/api/form/form.md similarity index 100% rename from docs/src/api/form.md rename to docs/src/api/form/form.md