文档
- 开始使用
- 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富文本

日期

输入或选择日期的控件。

注意事项

格式化分为：数据格式化表示表单数据和显示格式化显示数据（等同 nzFormat 值）
所有 数据格式化 单位，参考 date-fns format（国内镜像：moment format）
指定 schema.format 则必须遵守 RFC3339 时间格式，否则都视为格式错误，默认的数据格式化规则：
- date-time 默认 yyyy-MM-DDTHH:mm:ssZ，注意这里采用的是 type="datetime-local" 因此会涉及到时区问题
- date、full-date 默认 yyyy-MM-dd
- time、full-time 默认 HH:mm:ss
- 非标准：week 默认 yyyy-ww
- 非标准：month 默认 yyyy-MM
不指定 schema.format 根据 schema.type 值按以下规则处理（允许通过全局配置替换）数据格式化：
- string 默认 yyyy-MM-dd HH:mm:ss
- number 默认 T 13位Unix Timestamp

代码演示

基础样例

最简单的用法。

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

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

@Component({
  selector: 'form-date-simple',
  template: ` <sf [schema]="schema" (formSubmit)="submit($event)" (formChange)="change($event)" /> `,
  standalone: true,
  imports: [YelonFormModule]
})
export class FormDateSimpleComponent {
  private readonly msg = inject(NzMessageService);
  schema: SFSchema = {
    properties: {
      datetime: {
        type: 'string',
        format: 'date-time'
      },
      date: {
        type: 'string',
        format: 'date'
      },
      date_number: {
        type: 'number',
        ui: { widget: 'date' } as SFDateWidgetSchema
      },
      year: {
        type: 'number',
        ui: { widget: 'date', mode: 'year', format: 'yyyy' } as SFDateWidgetSchema
      },
      month: {
        type: 'string',
        format: 'month'
      },
      week: {
        type: 'string',
        format: 'week'
      },
      range: {
        type: 'string',
        ui: { widget: 'date', mode: 'range' } as SFDateWidgetSchema
      },
      start: {
        type: 'string',
        ui: { widget: 'date', end: 'end' } as SFDateWidgetSchema
      },
      end: {
        type: 'string',
        ui: { widget: 'date', end: 'end' } as SFDateWidgetSchema
      },
      inline: {
        type: 'string',
        ui: { widget: 'date', inline: true } as SFDateWidgetSchema
      }
    }
  };

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

  change(value: {}): void {
    console.log('change', value);
  }
}

范围

一个简单的开始与结束日期，注意： end 依然需要定义对应的Schema，但会强制隐藏状态。

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

import { subWeeks } from 'date-fns';

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

@Component({
  selector: 'form-date-range',
  template: ` <sf [schema]="schema" (formSubmit)="submit($event)" /> `,
  standalone: true,
  imports: [YelonFormModule]
})
export class FormDateRangeComponent {
  private readonly msg = inject(NzMessageService);
  schema: SFSchema = {
    properties: {
      start: {
        type: 'string',
        ui: { widget: 'date', end: 'end', separator: '到' } as SFDateWidgetSchema,
        default: new Date()
      },
      end: {
        type: 'string',
        default: subWeeks(new Date(), 6)
      },
      startWeek: {
        type: 'string',
        ui: { widget: 'date', rangeMode: 'week', end: 'endWeek' } as SFDateWidgetSchema,
        default: new Date()
      },
      endWeek: {
        type: 'string',
        default: subWeeks(new Date(), 6)
      },
      startMonth: {
        type: 'string',
        ui: { widget: 'date', rangeMode: 'month', end: 'endMonth' } as SFDateWidgetSchema,
        default: new Date()
      },
      endMonth: {
        type: 'string',
        default: subWeeks(new Date(), 6)
      },
      startYear: {
        type: 'string',
        ui: { widget: 'date', rangeMode: 'year', end: 'endYear' } as SFDateWidgetSchema,
        default: new Date()
      },
      endYear: {
        type: 'string',
        default: subWeeks(new Date(), 6)
      }
    },
    required: ['start']
  };

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

API

schema属性

成员	说明	类型	默认值
`[readOnly]`	禁用状态	`boolean`	-
`[format]`	数据格式类型	`string`	-

ui属性

参数	说明	类型	默认值
`[mode]`	渲染模式	`date,week,month,year`	`date`
`[rangeMode]`	范围选择器的选择模式	`date,week,month,year`	`date`
`[size]`	大小，等同 `nzSize`	`default,large,small`	-
`[placeholder]`	在文字框中显示提示讯息	`string`	-
`[format]`	数据格式化	`string`	-
`[displayFormat]`	显示格式化，（等同 nzFormat 值）	`string`	`yyyy-MM-dd HH:mm:ss`
`[end]`	日期范围所对应的结束值 `key`	`string`	-
`[allowClear]`	是否显示清除按钮	`boolean`	`true`
`[className]`	选择器 className	`string`	-
`[locale]`	国际化配置	`object`	-
`[popupStyle]`	额外的弹出日历样式	`object`	-
`[dropdownClassName]`	额外的弹出日历 className	`string`	-
`[onOpenChange]`	弹出日历和关闭日历的回调	`(status: boolean) => void`	-
`[disabledDate]`	不可选择的日期	`(current: Date) => boolean`	-
`[disabledTime]`	不可选择的时间	`(current: Date) => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }`	-
`[renderExtraFooter]`	在面板中添加额外的页脚	`string`	-
`[showTime]`	增加时间选择功能，`object` 类型为 TimePickerOptions	`object,boolean`	`true`
`[showToday]`	是否展示“今天”按钮	`boolean`	`true`
`[inputReadOnly]`	为 input 标签设置只读属性（避免在移动设备上触发小键盘）	`boolean`	`false`
`[inline]`	内联模式	`boolean`	`false`
`[separator]`	分隔符	`string, TemplateRef`	`'~'`
`[showWeekNumber]`	是否在每一行显示周数（仅日期选择器支持。周选择器始终显示周数）	`boolean`	`false`
`[onOk]`	点击确定按钮的回调	`(data: Date \| Date[]) => void`	-
`[change]`	时间发生变化的回调	`(data: Date \| Date[]) => void`	-

custom 自定义 radio 单选框

日期

注意事项

代码演示

API

schema属性

ui属性

ng-yunzai

相关资源

社区

鸣谢