ngx-formly-zorro-antd 19.3.3 → 20.0.0

package/timepicker/index.d.ts

@@ -1,5 +1,164 @@
+import * as i0 from '@angular/core';
+import { TemplateRef, Type } from '@angular/core';
+import * as i2 from '@angular/common';
+import { DatePipe } from '@angular/common';
+import * as i6 from '@ngx-formly/core';
+import { FieldType, FieldTypeConfig, ConfigOption } from '@ngx-formly/core';
+import { NzFormlyFieldConfig, FormlyAttributeEvent } from 'ngx-formly-zorro-antd/common';
+import * as i4 from 'ngx-formly-zorro-antd/form-field';
+import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
+import { NzSafeAny, NzVariant } from 'ng-zorro-antd/core/types';
+import * as i3 from '@angular/forms';
+import * as i5 from 'ng-zorro-antd/time-picker';
+
 /**
- * Generated bundle index. Do not edit.
+ * @publicApi
  */
-/// <amd-module name="ngx-formly-zorro-antd/timepicker" />
-export * from './public_api';
+interface TimepickerProps extends FormlyFieldProps {
+    /**
+     * 选择框底部显示自定义的内容
+     */
+    addOn?: TemplateRef<void>;
+    /**
+     * 是否展示清除按钮
+     * @default true
+     */
+    allowEmpty?: boolean;
+    /**
+     * 自动获取焦点
+     * @default false
+     */
+    autoFocus?: boolean;
+    /**
+     * 浮层是否应带有背景板
+     * @default false
+     */
+    backdrop?: boolean;
+    /**
+     * 清除按钮的提示文案
+     * @default clear
+     */
+    clearText?: string;
+    /**
+     * 此刻按钮文本
+     * @default 此刻
+     */
+    nowText?: string;
+    /**
+     * 确认按钮文本
+     * @default 确定
+     */
+    okText?: string;
+    /**
+     * 当 [ngModel] 不存在时，可以设置面板打开时默认选中的值
+     * @default new Date()
+     */
+    defaultOpenValue?: Date;
+    /**
+     * 	禁止选择部分小时选项
+     */
+    disabledHours?: () => number[];
+    /**
+     * 禁止选择部分分钟选项
+     */
+    disabledMinutes?: (hour: number) => number[];
+    /**
+     * 禁止选择部分秒选项
+     */
+    disabledSeconds?: (hour: number, minute: number) => number[];
+    /**
+     * 展示的时间格式
+     * @default "HH:mm:ss"
+     */
+    format?: DatePipe;
+    /**
+     * 隐藏禁止选择的选项
+     * @default false
+     */
+    hideDisabledOptions?: boolean;
+    /**
+     * 小时选项间隔
+     * @default 1
+     */
+    hourStep?: number;
+    /**
+     * 分钟选项间隔
+     * @default 1
+     */
+    minuteStep?: number;
+    /**
+     * 秒选项间隔
+     * @default 1
+     */
+    secondStep?: number;
+    /**
+     * 面板是否打开，可双向绑定
+     * @default false
+     */
+    open?: boolean;
+    /**
+     * 弹出层类名
+     * @default '''
+     */
+    popupClassName?: string;
+    /**
+     * 使用12小时制，为true时format默认为h:mm:ss a
+     * @default false
+     */
+    use12Hours?: boolean;
+    /**
+     * 无边框
+     * @deprecated Will be removed in v21. It is recommended to use `variant` instead.
+     * @default false
+     */
+    borderless?: boolean;
+    /** 形态变体 */
+    variant?: NzVariant;
+    /**
+     * 为 input 标签设置只读属性（避免在移动设备上触发小键盘）
+     * @default false
+     */
+    inputReadOnly?: boolean;
+    /**
+     * 自定义的后缀图标
+     *
+     */
+    suffixIcon?: string | TemplateRef<void>;
+    /**
+     * 面板打开/关闭时的回调
+     */
+    openChange?: FormlyAttributeEvent<boolean>;
+}
+interface FormlyTimepickerFieldConfig extends NzFormlyFieldConfig<TimepickerProps> {
+    type: 'timepicker' | Type<FormlyFieldTimepicker>;
+}
+/** @private */
+declare class FormlyFieldTimepicker extends FieldType<FieldTypeConfig> {
+    defaultOptions: {
+        props: {
+            allowEmpty: boolean;
+            autoFocus: boolean;
+            backdrop: boolean;
+            borderless: boolean;
+            variant: string;
+            inputReadOnly: boolean;
+            open: boolean;
+            clearText: string;
+            defaultOpenValue: Date;
+            format: NzSafeAny;
+        };
+    };
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldTimepicker, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldTimepicker, "formly-field-timepicker", never, {}, {}, never, never, false, never>;
+}
+
+declare class FormlyNzTimepickerModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyNzTimepickerModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FormlyNzTimepickerModule, [typeof FormlyFieldTimepicker], [typeof i2.CommonModule, typeof i3.ReactiveFormsModule, typeof i4.FormlyNzFormFieldModule, typeof i5.NzTimePickerModule, typeof i6.FormlyModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FormlyNzTimepickerModule>;
+}
+
+declare function withFormlyFieldTimepicker(): ConfigOption;
+
+export { FormlyFieldTimepicker, FormlyNzTimepickerModule, withFormlyFieldTimepicker };
+export type { FormlyTimepickerFieldConfig, TimepickerProps };

package/transfer/index.d.ts

@@ -1,5 +1,164 @@
+import * as i0 from '@angular/core';
+import { OnInit, TemplateRef, Type } from '@angular/core';
+import * as i7 from '@ngx-formly/core';
+import { FieldType, FieldTypeConfig, ConfigOption } from '@ngx-formly/core';
+import { NzFormlyFieldConfig, FormlyAttributeEvent } from 'ngx-formly-zorro-antd/common';
+import * as i5 from 'ngx-formly-zorro-antd/form-field';
+import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
+import { Observable } from 'rxjs';
+import * as i6 from 'ng-zorro-antd/transfer';
+import { NzTransferComponent, TransferItem, TransferCanMove, TransferChange, TransferSearchChange, TransferSelectChange } from 'ng-zorro-antd/transfer';
+import { NgStyleInterface, NzSafeAny, OnChangeType, OnTouchedType } from 'ng-zorro-antd/core/types';
+import * as i4 from '@angular/forms';
+import { ControlValueAccessor } from '@angular/forms';
+import * as i3 from '@angular/common';
+
 /**
- * Generated bundle index. Do not edit.
+ * @publicApi
  */
-/// <amd-module name="ngx-formly-zorro-antd/transfer" />
-export * from './public_api';
+interface TransferProps extends FormlyFieldProps {
+    /**
+     * 数据源，其中若数据属性 direction: 'right' 将会被渲染到右边一栏中或使用 nzTargetKeys
+     * @default []
+     */
+    dataSource?: TransferItem[];
+    /**
+     * 标题集合，顺序从左至右
+     * @default ['', '']
+     */
+    titles?: string[];
+    /**
+     * 操作文案集合，顺序从下至上
+     * @default ['', '']
+     */
+    operations?: string[];
+    /**
+     * 两个穿梭框的自定义样式，等同 style
+     */
+    listStyle?: NgStyleInterface;
+    /**
+     * 单数单位
+     * @default 项目
+     */
+    itemUnit?: string;
+    /**
+     * 复数单位
+     * @default 项目
+     */
+    itemsUnit?: string;
+    /**
+     * 自定义渲染列表，见示例
+     * @default [null, null]
+     */
+    renderList?: Array<TemplateRef<NzSafeAny> | null> | null;
+    /**
+     * 每行数据渲染模板，见示例
+     */
+    render?: TemplateRef<NzSafeAny> | null;
+    /**
+     * 底部渲染模板，见示例
+     */
+    footer?: TemplateRef<NzSafeAny> | null;
+    /**
+     * 是否显示搜索框
+     * @default false
+     */
+    showSearch?: boolean;
+    /**
+     * 接收 inputValueoption 两个参数，当 option 符合筛选条件时，应返回 true，反之则返回 false。
+     */
+    filterOption?: (inputValue: string, item: TransferItem) => boolean;
+    /**
+     * 搜索框的默认值
+     * @default 请输入搜索内容
+     */
+    searchPlaceholder?: string;
+    /**
+     * 当列表为空时显示的内容
+     * @default 列表为空
+     */
+    notFoundContent?: string;
+    /**
+     * 穿梭时二次校验。注意： 穿梭组件内部始终只保留一份数据，二次校验过程中需取消穿梭项则直接删除该项；具体用法见示例。
+     */
+    canMove?: (arg: TransferCanMove) => Observable<TransferItem[]>;
+    /**
+     * 设置被选中的 key 集合
+     */
+    selectedKeys?: string[];
+    /**
+     * 显示在右侧框数据的 key 集合
+     */
+    targetKeys?: string[];
+    /**
+     * 选项在两栏之间转移时的回调函数
+     */
+    onChange?: (value: TransferChange) => void;
+    /**
+     * 搜索框内容时改变时的回调函数
+     */
+    searchChange?: FormlyAttributeEvent<TransferSearchChange>;
+    /**
+     * 选中项发生改变时的回调函数
+     */
+    selectChange?: FormlyAttributeEvent<TransferSelectChange>;
+    /**
+     * 返回结果格式映射
+     * @returns 默认返回 TransferItem[] 格式
+     */
+    resultMap?: (items: TransferItem[]) => NzSafeAny[];
+}
+interface FormlyTransferFieldConfig extends NzFormlyFieldConfig<TransferProps> {
+    type: 'transfer' | Type<FormlyFieldTransfer>;
+}
+/** @private */
+declare class FormlyFieldTransfer extends FieldType<FieldTypeConfig> implements OnInit {
+    defaultOptions: {
+        props: {
+            dataSource: never[];
+            titles: string[];
+            operations: string[];
+            renderList: null[];
+            noFor: boolean;
+            listStyle: {};
+        };
+    };
+    transfer: i0.Signal<NzTransferComponent>;
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldTransfer, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldTransfer, "formly-field-transfer", never, {}, {}, never, never, false, never>;
+}
+
+/** @private */
+declare class TransferComponent extends NzTransferComponent implements ControlValueAccessor {
+    transfer: i0.Signal<NzTransferComponent>;
+    resultMap: i0.InputSignal<((items: TransferItem[]) => NzSafeAny[]) | undefined>;
+    onChange: OnChangeType;
+    onTouched: OnTouchedType;
+    writeValue(obj: NzSafeAny): void;
+    registerOnChange(fn: NzSafeAny): void;
+    registerOnTouched(fn: NzSafeAny): void;
+    setDisabledState?(isDisabled: boolean): void;
+    change(value: TransferChange): void;
+    /**
+     * 选中项发生改变时的回调函数
+     */
+    selectChange(value: TransferSelectChange): void;
+    /**
+     * 搜索框内容时改变时的回调函数
+     */
+    searchChange(value: TransferSearchChange): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TransferComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TransferComponent, "formly-transfer", never, { "resultMap": { "alias": "resultMap"; "required": false; "isSignal": true; }; }, {}, never, never, false, never>;
+}
+
+declare class FormlyNzTransferModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyNzTransferModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FormlyNzTransferModule, [typeof FormlyFieldTransfer, typeof TransferComponent], [typeof i3.CommonModule, typeof i4.ReactiveFormsModule, typeof i5.FormlyNzFormFieldModule, typeof i6.NzTransferModule, typeof i7.FormlyModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FormlyNzTransferModule>;
+}
+
+declare function withFormlyFieldTransfer(): ConfigOption;
+
+export { FormlyFieldTransfer, FormlyNzTransferModule, withFormlyFieldTransfer };
+export type { FormlyTransferFieldConfig, TransferProps };

package/tree-select/index.d.ts

@@ -1,5 +1,206 @@
+import * as i0 from '@angular/core';
+import { OnInit, TemplateRef, Type } from '@angular/core';
+import * as i6 from '@ngx-formly/core';
+import { FieldType, FieldTypeConfig, ConfigOption } from '@ngx-formly/core';
+import { FormlyBoxTemplates, NzFormlyFieldConfig, NgStyleType, FormlyAttributeEvent } from 'ngx-formly-zorro-antd/common';
+import * as i4 from 'ngx-formly-zorro-antd/form-field';
+import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
+import * as i5 from 'ng-zorro-antd/tree-select';
+import { NzTreeSelectComponent, NzPlacementType } from 'ng-zorro-antd/tree-select';
+import { NzTreeNode, NzTreeNodeOptions, NzFormatEmitEvent } from 'ng-zorro-antd/tree';
+import { NzVariant } from 'ng-zorro-antd/core/types';
+import * as i2 from '@angular/common';
+import * as i3 from '@angular/forms';
+
 /**
- * Generated bundle index. Do not edit.
+ * @publicApi
  */
-/// <amd-module name="ngx-formly-zorro-antd/tree-select" />
-export * from './public_api';
+interface TreeSelectProps extends FormlyFieldProps {
+    /**
+     * 显示清除按钮
+     * @default false
+     */
+    allowClear?: boolean;
+    /**
+     * 是否展示 TreeNode title 前的图标，没有默认样式
+     * @default false
+     */
+    showIcon?: boolean;
+    /**
+     * 显示搜索框
+     * @default false
+     */
+    showSearch?: boolean;
+    /**
+     * 当下拉列表为空时显示的内容
+     */
+    notFoundContent?: string | TemplateRef<void>;
+    notFoundContentName?: string;
+    /**
+     * 下拉菜单和选择器同宽
+     * @default true
+     */
+    dropdownMatchSelectWidth?: boolean;
+    /**
+     * 下拉菜单的样式
+     */
+    dropdownStyle?: NgStyleType;
+    /**
+     * 下拉菜单的 className 属性
+     */
+    dropdownClassName?: string;
+    /**
+     * 选择框弹出的位置
+     */
+    placement?: NzPlacementType;
+    /**
+     * 支持多选（当设置 nzCheckable 时自动变为true）
+     * @default false
+     */
+    multiple?: boolean;
+    /**
+     * 搜索隐藏未匹配的节点
+     * @default false
+     */
+    hideUnMatched?: boolean;
+    /**
+     * 节点前添加 Checkbox 复选框
+     * @default false
+     */
+    checkable?: boolean;
+    /**
+     * checkable 状态下节点选择完全受控（父子节点选中状态不再关联）
+     * @default false
+     */
+    checkStrictly?: boolean;
+    /**
+     * 节点前添加展开图标
+     * @default true
+     */
+    showExpand?: boolean;
+    /**
+     * 是否展示连接线
+     * @default false
+     */
+    showLine?: boolean;
+    /**
+     * 是否异步加载(显示加载状态)
+     * @default false
+     */
+    asyncData?: boolean;
+    /**
+     * treeNodes 数据
+     * @default []
+     */
+    nodes?: NzTreeNodeOptions[];
+    /**
+     * 默认展开所有树节点
+     * @default false
+     */
+    defaultExpandAll?: boolean;
+    /**
+     * 默认展开指定的树节点
+     */
+    expandedKeys?: string[];
+    /**
+     * 	如何在输入框显示所选的节点值的方法
+     * @default (node: NzTreeNode) => node.title
+     */
+    displayWith?: (node: NzTreeNode) => string;
+    /**
+     * 最多显示多少个 tag
+     *
+     */
+    maxTagCount?: number;
+    /**
+     * 隐藏 tag 时显示的内容
+     */
+    maxTagPlaceholder?: TemplateRef<{
+        $implicit: NzTreeNode[];
+    }>;
+    maxTagPlaceholderName?: string;
+    /**
+     * 自定义节点
+     */
+    treeTemplate?: TemplateRef<{
+        $implicit: NzTreeNode;
+    }>;
+    treeTemplateName?: string;
+    /**
+     * 自定义展开图标
+     */
+    expandedIcon?: TemplateRef<{
+        $implicit: NzTreeNode;
+        origin: NzTreeNodeOptions;
+    }>;
+    expandedIconName?: string;
+    /**
+     * 虚拟滚动的总高度
+     */
+    virtualHeight?: string | null;
+    /**
+     * 虚拟滚动时每一列的高度，与 cdk itemSize 相同
+     * @default 28
+     */
+    virtualItemSize?: number;
+    /**
+     * 缓冲区最大像素高度，与 cdk maxBufferPx 相同
+     * @default 500
+     */
+    virtualMaxBufferPx?: number;
+    /**
+     * 缓冲区最小像素高度，低于该值时将加载新结构，与 cdk minBufferPx 相同
+     * @default 28
+     */
+    virtualMinBufferPx?: number;
+    /**
+     * 浮层是否应带有背景板
+     * @default false
+     */
+    backdrop?: boolean;
+    /** 形态变体 */
+    variant?: NzVariant;
+    /**
+     * 点击展开树节点图标调用
+     */
+    expandChange?: FormlyAttributeEvent<NzFormatEmitEvent>;
+}
+interface FormlyTreeSelectFieldConfig extends NzFormlyFieldConfig<TreeSelectProps> {
+    type: 'tree-select' | Type<FormlyFieldTreeSelect>;
+}
+/** @private */
+declare class FormlyFieldTreeSelect extends FieldType<FieldTypeConfig> implements OnInit {
+    defaultOptions: {
+        props: {
+            dropdownMatchSelectWidth: boolean;
+            showExpand: boolean;
+            nodes: never[];
+            displayWith: (node: NzTreeNode) => string;
+            virtualItemSize: number;
+            virtualMaxBufferPx: number;
+            virtualMinBufferPx: number;
+            variant: string;
+        };
+    };
+    treeSelect: i0.Signal<NzTreeSelectComponent>;
+    fieldTemplates: FormlyBoxTemplates | null;
+    constructor();
+    ngOnInit(): void;
+    get nzExpandedIcon(): TemplateRef<any> | undefined;
+    get nzNotFoundContent(): TemplateRef<any> | undefined;
+    get nzMaxTagPlaceholder(): TemplateRef<any> | undefined;
+    get nzTreeTemplate(): TemplateRef<any> | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldTreeSelect, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldTreeSelect, "formly-field-treeselect", never, {}, {}, never, never, false, never>;
+}
+
+declare class FormlyNzTreeSelectModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyNzTreeSelectModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FormlyNzTreeSelectModule, [typeof FormlyFieldTreeSelect], [typeof i2.CommonModule, typeof i3.ReactiveFormsModule, typeof i4.FormlyNzFormFieldModule, typeof i5.NzTreeSelectModule, typeof i6.FormlyModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FormlyNzTreeSelectModule>;
+}
+
+declare function withFormlyFieldTreeSelect(): ConfigOption;
+
+export { FormlyFieldTreeSelect, FormlyNzTreeSelectModule, withFormlyFieldTreeSelect };
+export type { FormlyTreeSelectFieldConfig, TreeSelectProps };

package/types/index.d.ts

@@ -1,5 +1,26 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="ngx-formly-zorro-antd/types" />
-export * from './public_api';
+export { FormlyButtonFieldConfig } from 'ngx-formly-zorro-antd/button';
+export { FormlyCardFieldConfig } from 'ngx-formly-zorro-antd/card';
+export { FormlyCardWrapperConfig } from 'ngx-formly-zorro-antd/card-wrapper';
+export { FormlyCascaderFieldConfig } from 'ngx-formly-zorro-antd/cascader';
+export { FormlyCheckboxFieldConfig } from 'ngx-formly-zorro-antd/checkbox';
+export { FormlyDatepickerFieldConfig } from 'ngx-formly-zorro-antd/datepicker';
+export { FormlyFlexFieldConfig } from 'ngx-formly-zorro-antd/flex';
+export { FormlyGridFieldConfig } from 'ngx-formly-zorro-antd/grid';
+export { FormlyInputFieldConfig } from 'ngx-formly-zorro-antd/input';
+export { FormlyInputGroupFieldConfig } from 'ngx-formly-zorro-antd/input-group';
+export { FormlyInputNumberFieldConfig } from 'ngx-formly-zorro-antd/input-number';
+export { FormlyInputOtpFieldConfig } from 'ngx-formly-zorro-antd/input-otp';
+export { FormlyRadioFieldConfig } from 'ngx-formly-zorro-antd/radio';
+export { FormlyRateFieldConfig } from 'ngx-formly-zorro-antd/rate';
+export { FormlyRefTemplateFieldConfig } from 'ngx-formly-zorro-antd/ref-template';
+export { FormlySelectFieldConfig } from 'ngx-formly-zorro-antd/select';
+export { FormlySlideFieldConfig } from 'ngx-formly-zorro-antd/slider';
+export { FormlySpaceFieldConfig } from 'ngx-formly-zorro-antd/space';
+export { FormlySwitchFieldConfig } from 'ngx-formly-zorro-antd/switch';
+export { FormlyTabsWrapperConfig } from 'ngx-formly-zorro-antd/tabs';
+export { FormlyTextValueFieldConfig } from 'ngx-formly-zorro-antd/text-value';
+export { FormlyTextareaFieldConfig } from 'ngx-formly-zorro-antd/textarea';
+export { FormlyTimepickerFieldConfig } from 'ngx-formly-zorro-antd/timepicker';
+export { FormlyTransferFieldConfig } from 'ngx-formly-zorro-antd/transfer';
+export { FormlyTreeSelectFieldConfig } from 'ngx-formly-zorro-antd/tree-select';
+export { FormlyUploadFieldConfig } from 'ngx-formly-zorro-antd/upload';