文档
- 开始使用
- Schema
- 校验错误
- 自定义小部件
- 如何布局
- 常见问题
Examples
- 在线校验器
- acl ACL
- visibleIf 条件表达式
- i18n 国际化
- method 内置方法
- modal 模态框
小部件
- object 对象
- array 数组
- string 文本框
- boolean 开关
- number 数字
- select 选择器
- checkbox 多选框
- custom 自定义
- date 日期
- radio 单选框
- text 文本
- textarea 多行文本框
非内置小部件
- autocomplete 自动完成
- cascader 级联选择
- color 颜色
- mention 提及
- qr-code 二维码
- rate 评分
- segmented 分段控制器
- slider 滑动输入条
- tag 标签
- time 时间
- transfer 穿梭框
- tree-select 树选择
- upload 上传
第三方小部件
- monaco-editor Monaco Editor
- tinymce Tinymce富文本

数组

创建对象数组，只对 schema.type="array" 时有效。

关于布局

数组的布局分为数组本身以及数组元素布局，arraySpan 决定每个数组元素占栅格数值。

Schema 内嵌 UI 风格：

const schema: SFSchema = {
  properties: {
    list: {
      type: 'array',
      items: {
        type: 'object',
        properties: {
          a: { type: 'string' },
          b: { type: 'number', ui: { spanLabel: 10 } }
        }
      },
      ui: { spanLabel: 5, grid: { arraySpan: 12 } }
    }
  }
};

注意： items 下所有属性都继承于 list.ui，最终 items.a 为 5 个单位、items.b 为 10 个单位。

Schema 与 UI 分开风格，假如上述 Schema 转化成 UI 写法：

const ui = {
  $list: {
    $items: {
      $b: { spanLabel: 10 }
    },
    spanLabel: 5,
    grid: { arraySpan: 12 }
  }
};

代码演示

基础样例

最简单的用法。

import { Component, inject } from '@angular/core';

import { YelonFormModule, SFArrayWidgetSchema, SFSchema } from '@yelon/form';
import { NzMessageService } from 'ng-zorro-antd/message';

@Component({
  selector: 'form-array-simple',
  template: ` <sf [schema]="schema" (formSubmit)="submit($event)" /> `,
  standalone: true,
  imports: [YelonFormModule]
})
export class FormArraySimpleComponent {
  private readonly msg = inject(NzMessageService);
  schema: SFSchema = {
    properties: {
      product: {
        type: 'array',
        title: '产品清单',
        maxItems: 4,
        items: {
          type: 'object',
          properties: {
            name: {
              type: 'string',
              title: '名称'
            },
            price: {
              type: 'number',
              title: '单价',
              minimum: 1
            }
          },
          required: ['name', 'price']
        },
        ui: { grid: { arraySpan: 12 } } as SFArrayWidgetSchema
      }
    }
  };

  submit(value: {}): void {
    this.msg.success(JSON.stringify(value));
  }
}

不规则布局

灵活使用 ui 来复杂不规则布局。

import { Component, inject } from '@angular/core';

import { YelonFormModule, SFArrayWidgetSchema, SFSchema } from '@yelon/form';
import { NzMessageService } from 'ng-zorro-antd/message';

@Component({
  selector: 'form-array-irregular',
  template: ` <sf [schema]="schema" (formSubmit)="submit($event)" /> `,
  standalone: true,
  imports: [YelonFormModule]
})
export class FormArrayIrregularComponent {
  private readonly msg = inject(NzMessageService);
  schema: SFSchema = {
    properties: {
      title: { type: 'string' },
      market: { type: 'number' },
      price: { type: 'number' },
      skus: {
        type: 'array',
        title: 'Skus',
        maxItems: 4,
        default: [{}],
        items: {
          type: 'object',
          properties: {
            name: {
              type: 'string',
              title: '名称'
            },
            price: {
              type: 'number',
              title: '单价',
              minimum: 1
            },
            stock: {
              type: 'number',
              minimum: 1
            },
            desc: {
              type: 'string',
              ui: {
                grid: { span: 24 } // 单独设置desc元素在当前数组表单所占格数，24表示整行
              }
            }
          },
          required: ['name', 'price', 'stock'],
          ui: {
            grid: { span: 12 } // 针对数组内部表单统一设置，12表示一行两个
          }
        },
        ui: {
          grid: {
            span: 24, // 单独设置Sku元素在整个表单所占格数，24表示整行
            arraySpan: 12 // 设置数组每个索引所占格数，12表示一行两个
          }
        } as SFArrayWidgetSchema
      },
      desc: {
        type: 'string',
        ui: { grid: { span: 24 } }
      }
    },
    required: ['title', 'market', 'price'],
    ui: {
      spanLabelFixed: 100,
      grid: { span: 8 }
    }
  };

  submit(value: {}): void {
    this.msg.success(JSON.stringify(value));
  }
}

API

schema属性

参数	说明	类型	默认值
`[items]`	数组元素类型描述	`SFSchema`	-
`[minItems]`	约束数组最小的元素个数	`number`	-
`[maxItems]`	约束数组最大的元素个数	`number`	-
`[uniqueItems]`	约束数组每个元素都不相同	`boolean`	-

ui属性

参数	说明	类型	默认值
`[addTitle]`	添加按钮文本	`string`	`添加`
`[addType]`	添加按钮类型，等同 `nzType`	`string`	`dashed`
`[removable]`	是否包含移除按钮	`boolean`	`true`
`[removeTitle]`	移除按钮文本	`string`	`移除`
`[required]`	当前项是否为必填，仅影响样式	`boolean`	-
`[$items]`	数组元素类型UI描述	`SFUISchema`	-
`(add)`	添加回调，`property` 表示添加后的表单属性	`(property: FormProperty) => void`	-
`(remove)`	移除回调	`(index: number) => void`	-

object 对象 string 文本框

数组

关于布局

代码演示

API

schema属性

ui属性

ng-yunzai

相关资源

社区

鸣谢