ngx-formly-zorro-antd 13.0.0-rc.0

package/transfer/transfer.type.d.ts

@@ -0,0 +1,118 @@
+import { TemplateRef, Type, OnInit } from '@angular/core';
+import { FieldType, FieldTypeConfig, FormlyFieldConfig } from '@ngx-formly/core';
+import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
+import { Observable } from 'rxjs';
+import { NzTransferComponent, TransferCanMove, TransferChange, TransferItem, TransferSearchChange, TransferSelectChange } from 'ng-zorro-antd/transfer';
+import type { NzSafeAny, NgStyleInterface } from 'ng-zorro-antd/core/types';
+import * as i0 from "@angular/core";
+interface TransferProps extends FormlyFieldProps {
+    /**
+     * 数据源，其中若数据属性 direction: 'right' 将会被渲染到右边一栏中或使用 nzTargetKeys
+     * @default []
+     */
+    dataSource?: TransferItem[];
+    /**
+     * 标题集合，顺序从左至右
+     * @default ['', '']
+     */
+    titles?: string[];
+    /**
+     * 操作文案集合，顺序从下至上
+     * @default ['', '']
+     */
+    operations?: string[];
+    /**
+     * 两个穿梭框的自定义样式，等同 ngStyle
+     */
+    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?: (field: FormlyFieldConfig, value: TransferSearchChange) => void;
+    /**
+     * 选中项发生改变时的回调函数
+     */
+    selectChange?: (field: FormlyFieldConfig, value: TransferSelectChange) => void;
+    /**
+     * 返回结果格式映射
+     * @returns 默认返回 TransferItem[] 格式
+     */
+    resultMap?: (items: TransferItem[]) => NzSafeAny[];
+}
+export interface FormlyTransferFieldConfig extends FormlyFieldConfig<TransferProps> {
+    type: 'transfer' | Type<FormlyFieldTransfer>;
+}
+export declare class FormlyFieldTransfer extends FieldType<FieldTypeConfig> implements OnInit {
+    defaultOptions: {
+        props: {
+            dataSource: never[];
+            titles: string[];
+            operations: string[];
+            renderList: null[];
+            listStyle: {};
+        };
+    };
+    transfer: NzTransferComponent;
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldTransfer, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldTransfer, "formly-field-transfer", never, {}, {}, never, never>;
+}
+export {};

package/tree-select/ngx-formly-zorro-antd-tree-select.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="ngx-formly-zorro-antd/tree-select" />
+export * from './public_api';

package/tree-select/package.json

@@ -0,0 +1,10 @@
+{
+  "module": "../fesm2015/ngx-formly-zorro-antd-tree-select.mjs",
+  "es2020": "../fesm2020/ngx-formly-zorro-antd-tree-select.mjs",
+  "esm2020": "../esm2020/tree-select/ngx-formly-zorro-antd-tree-select.mjs",
+  "fesm2020": "../fesm2020/ngx-formly-zorro-antd-tree-select.mjs",
+  "fesm2015": "../fesm2015/ngx-formly-zorro-antd-tree-select.mjs",
+  "typings": "ngx-formly-zorro-antd-tree-select.d.ts",
+  "sideEffects": false,
+  "name": "ngx-formly-zorro-antd/tree-select"
+}

package/tree-select/public_api.d.ts

@@ -0,0 +1,2 @@
+export { FormlyNzTreeSelectModule } from './tree-select.module';
+export { FormlyFieldTreeSelect, FormlyTreeSelectFieldConfig } from './tree-select.type';

package/tree-select/tree-select.module.d.ts

@@ -0,0 +1,12 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./tree-select.type";
+import * as i2 from "@angular/common";
+import * as i3 from "@angular/forms";
+import * as i4 from "ngx-formly-zorro-antd/form-field";
+import * as i5 from "ng-zorro-antd/tree-select";
+import * as i6 from "@ngx-formly/core";
+export declare class FormlyNzTreeSelectModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyNzTreeSelectModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FormlyNzTreeSelectModule, [typeof i1.FormlyFieldTreeSelect], [typeof i2.CommonModule, typeof i3.ReactiveFormsModule, typeof i4.FormlyNzFormFieldModule, typeof i5.NzTreeSelectModule, typeof i6.FormlyModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FormlyNzTreeSelectModule>;
+}

package/tree-select/tree-select.type.d.ts

@@ -0,0 +1,158 @@
+import { Type, TemplateRef } from '@angular/core';
+import { FieldType, FieldTypeConfig, FormlyFieldConfig } from '@ngx-formly/core';
+import type { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
+import type { NzFormatEmitEvent, NzTreeNode, NzTreeNodeOptions } from 'ng-zorro-antd/tree';
+import type { NgStyleInterface } from 'ng-zorro-antd/core/types';
+import * as i0 from "@angular/core";
+interface TreeSelectProps extends FormlyFieldProps {
+    /**
+     * 显示清除按钮
+     * @default false
+     */
+    allowClear?: boolean;
+    /**
+     * 是否展示 TreeNode title 前的图标，没有默认样式
+     * @default false
+     */
+    showIcon?: boolean;
+    /**
+     * 显示搜索框
+     * @default false
+     */
+    showSearch?: boolean;
+    /**
+     * 当下拉列表为空时显示的内容
+     */
+    notFoundContent?: string;
+    /**
+     * 下拉菜单和选择器同宽
+     * @default true
+     */
+    dropdownMatchSelectWidth?: boolean;
+    /**
+     * 下拉菜单的样式
+     */
+    dropdownStyle?: NgStyleInterface | null;
+    /**
+     * 下拉菜单的 className 属性
+     */
+    dropdownClassName?: string;
+    /**
+     * 支持多选（当设置 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[];
+    }>;
+    /**
+     * 自定义节点
+     */
+    treeTemplate?: TemplateRef<{
+        $implicit: NzTreeNode;
+    }>;
+    /**
+     * 虚拟滚动的总高度
+     */
+    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;
+    /**
+     * 点击展开树节点图标调用
+     */
+    expandChange?: (field: FormlyFieldConfig, value: NzFormatEmitEvent) => void;
+}
+export interface FormlyTreeSelectFieldConfig extends FormlyFieldConfig<TreeSelectProps> {
+    type: 'tree-select' | Type<FormlyFieldTreeSelect>;
+}
+export declare class FormlyFieldTreeSelect extends FieldType<FieldTypeConfig> {
+    defaultOptions: {
+        props: {
+            dropdownMatchSelectWidth: boolean;
+            showExpand: boolean;
+            nodes: never[];
+            displayWith: (node: NzTreeNode) => string;
+            virtualItemSize: number;
+            virtualMaxBufferPx: number;
+            virtualMinBufferPx: number;
+        };
+    };
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldTreeSelect, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldTreeSelect, "formly-field-treeselect", never, {}, {}, never, never>;
+}
+export {};

package/upload/ngx-formly-zorro-antd-upload.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="ngx-formly-zorro-antd/upload" />
+export * from './public_api';

package/upload/package.json

@@ -0,0 +1,10 @@
+{
+  "module": "../fesm2015/ngx-formly-zorro-antd-upload.mjs",
+  "es2020": "../fesm2020/ngx-formly-zorro-antd-upload.mjs",
+  "esm2020": "../esm2020/upload/ngx-formly-zorro-antd-upload.mjs",
+  "fesm2020": "../fesm2020/ngx-formly-zorro-antd-upload.mjs",
+  "fesm2015": "../fesm2015/ngx-formly-zorro-antd-upload.mjs",
+  "typings": "ngx-formly-zorro-antd-upload.d.ts",
+  "sideEffects": false,
+  "name": "ngx-formly-zorro-antd/upload"
+}

package/upload/public_api.d.ts

@@ -0,0 +1,2 @@
+export { FormlyNzUploadModule } from './upload.module';
+export { FormlyFieldUpload, FormlyUploadFieldConfig } from './upload.type';

package/upload/upload.component.d.ts

@@ -0,0 +1,27 @@
+import { ControlValueAccessor } from '@angular/forms';
+import type { OnChangeType, OnTouchedType, NzSafeAny } from 'ng-zorro-antd/core/types';
+import { NzUploadChangeParam, NzUploadComponent, NzUploadFile } from 'ng-zorro-antd/upload';
+import * as i0 from "@angular/core";
+export declare class UploadComponent extends NzUploadComponent implements ControlValueAccessor {
+    transfer: NzUploadComponent;
+    /**
+     * 按钮文本
+     * @default 点击上传
+     */
+    text?: string;
+    /**
+     * 样式名
+     */
+    className: string;
+    resultMap?: (items: NzUploadFile[]) => NzSafeAny[];
+    onChange: OnChangeType;
+    onTouched: OnTouchedType;
+    writeValue(): void;
+    registerOnChange(fn: NzSafeAny): void;
+    registerOnTouched(fn: NzSafeAny): void;
+    setDisabledState?(isDisabled: boolean): void;
+    fileListChange(list: NzUploadFile[]): void;
+    change(value: NzUploadChangeParam): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<UploadComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<UploadComponent, "formly-upload", never, { "text": "text"; "className": "className"; "resultMap": "resultMap"; }, {}, never, never>;
+}

package/upload/upload.module.d.ts

@@ -0,0 +1,15 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./upload.type";
+import * as i2 from "./upload.component";
+import * as i3 from "@angular/common";
+import * as i4 from "@angular/forms";
+import * as i5 from "ngx-formly-zorro-antd/form-field";
+import * as i6 from "ng-zorro-antd/upload";
+import * as i7 from "ng-zorro-antd/button";
+import * as i8 from "ng-zorro-antd/icon";
+import * as i9 from "@ngx-formly/core";
+export declare class FormlyNzUploadModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyNzUploadModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FormlyNzUploadModule, [typeof i1.FormlyFieldUpload, typeof i2.UploadComponent], [typeof i3.CommonModule, typeof i4.ReactiveFormsModule, typeof i5.FormlyNzFormFieldModule, typeof i6.NzUploadModule, typeof i7.NzButtonModule, typeof i8.NzIconModule, typeof i9.FormlyModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FormlyNzUploadModule>;
+}

package/upload/upload.type.d.ts

@@ -0,0 +1,173 @@
+import { TemplateRef, Type, OnInit } from '@angular/core';
+import { FieldType, FieldTypeConfig, FormlyFieldConfig } from '@ngx-formly/core';
+import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
+import { Observable, Subscription } from 'rxjs';
+import { NzUploadComponent, NzUploadChangeParam, NzUploadFile, NzUploadTransformFileType, UploadFilter, NzIconRenderTemplate, NzUploadListType } from 'ng-zorro-antd/upload';
+import type { NzSafeAny } from 'ng-zorro-antd/core/types';
+import * as i0 from "@angular/core";
+interface UploadProps extends FormlyFieldProps {
+    /**
+     * 接受上传的文件类型, 详见 input accept Attribute
+     */
+    accept?: string | string[];
+    /**
+     * 必选参数, 上传的地址
+     */
+    action?: string | ((file: NzUploadFile) => string | Observable<string>);
+    /**
+     * 支持上传文件夹（caniuse）
+     * @default false
+     */
+    directory?: boolean;
+    /**
+     * 上传文件之前的钩子，参数为上传的文件，若返回 false 则停止上传。注意：IE9 不支持该方法；注意：务必使用 => 定义处理方法。
+     */
+    beforeUpload?: (file: NzUploadFile, fileList: NzUploadFile[]) => boolean | Observable<boolean>;
+    /**
+     * 通过覆盖默认的上传行为，可以自定义自己的上传实现；注意：务必使用 => 定义处理方法。
+     */
+    customRequest?: (item: NzSafeAny) => Subscription;
+    /**
+     * 上传所需参数或返回上传参数的方法；注意：务必使用 => 定义处理方法。
+     */
+    data?: Object | ((file: NzUploadFile) => Object | Observable<{}>);
+    /**
+     * 文件列表，双向绑定
+     */
+    fileList?: NzUploadFile[];
+    /**
+     * 限制单次最多上传数量，nzMultiple 打开时有效；0 表示不限
+     * @default 0
+     */
+    limit?: number;
+    /**
+     * 限制文件大小，单位：KB；0 表示不限
+     * @default 0
+     */
+    size?: number;
+    /**
+     * 限制文件类型，例如：image/png,image/jpeg,image/gif,image/bmp
+     */
+    fileType?: string;
+    /**
+     * 自定义过滤器
+     */
+    filter?: UploadFilter[];
+    /**
+     * 设置上传的请求头部，IE10 以上有效；注意：务必使用 => 定义处理方法。
+     */
+    headers?: Object | ((file: NzUploadFile) => Object | Observable<{}>);
+    /**
+     * 上传列表的内建样式，支持三种基本样式 text, picture 和 picture-card
+     * @default text
+     */
+    listType?: NzUploadListType;
+    /**
+     * 是否支持多选文件，ie10+ 支持。开启后按住 ctrl 可选择多个文件。
+     * @default false;
+     */
+    multiple?: boolean;
+    /**
+     * 发到后台的文件参数名
+     * @default file
+     */
+    name?: string;
+    /**
+     * 是否展示 uploadList, 可设为一个对象，用于单独设定 showPreviewIcon，showRemoveIcon 和 showDownloadIcon
+     * @default true
+     */
+    showUploadList?: boolean | {
+        showPreviewIcon?: boolean;
+        showRemoveIcon?: boolean;
+        showDownloadIcon?: boolean;
+    };
+    /**
+     * 是否展示上传按钮
+     * @default true
+     */
+    showButton?: boolean;
+    /**
+     * 上传请求时是否携带 cookie
+     * @default false
+     */
+    withCredentials?: boolean;
+    /**
+     * 点击打开文件对话框
+     * @default true
+     */
+    openFileDialogOnClick?: boolean;
+    /**
+     * 点击文件链接或预览图标时的回调；注意：务必使用 => 定义处理方法。
+     */
+    preview?: (file: NzUploadFile) => void;
+    /**
+     * 自定义文件预览逻辑；注意：务必使用 => 定义处理方法。
+     */
+    previewFile?: (file: NzUploadFile) => Observable<string>;
+    /**
+     * 自定义预览文件是否有效图像，一般用于图像URL为非标准格式；注意：务必使用 => 定义处理方法。
+     */
+    previewIsImage?: (file: NzUploadFile) => boolean;
+    /**
+     * 点击移除文件时的回调，返回值为 false 时不移除。支持返回 Observable 对象；注意：务必使用 => 定义处理方法。
+     */
+    remove?: (file: NzUploadFile) => boolean | Observable<boolean>;
+    /**
+     * 上传文件改变时的状态
+     */
+    onChange?: (value: NzUploadChangeParam) => void;
+    /**
+     * 点击下载文件时的回调，如果没有指定，则默认跳转到文件 url 对应的标签页
+     * @default 跳转新标签页
+     */
+    download?: (file: NzUploadFile) => void;
+    /**
+     * 在上传之前转换文件。支持返回一个 Observable 对象
+     */
+    transformFile?: (file: NzUploadFile) => NzUploadTransformFileType;
+    /**
+     * 自定义显示 icon
+     */
+    iconRender?: NzIconRenderTemplate | null;
+    /**
+     * 自定义显示整个列表
+     */
+    fileListRender?: TemplateRef<void> | null;
+    /**
+     * 按钮文本
+     * @default 点击上传
+     */
+    text?: string;
+    /**
+     * 文件列表改变事件
+     */
+    fileListChange?: (list: NzUploadFile[]) => void;
+    /**
+     * 返回结果格式映射
+     * @returns 默认返回 NzUploadFile[] 格式
+     */
+    resultMap?: (items: NzUploadFile[]) => NzSafeAny[];
+}
+export interface FormlyUploadFieldConfig extends FormlyFieldConfig<UploadProps> {
+    type: 'upload' | Type<FormlyFieldUpload>;
+}
+export declare class FormlyFieldUpload extends FieldType<FieldTypeConfig> implements OnInit {
+    defaultOptions: {
+        props: {
+            listType: "text";
+            name: string;
+            showUploadList: boolean;
+            showButton: boolean;
+            openFileDialogOnClick: boolean;
+            limit: number;
+            size: number;
+            filter: never[];
+            text: string;
+        };
+    };
+    upload: NzUploadComponent;
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldUpload, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldUpload, "formly-field-upload", never, {}, {}, never, never>;
+}
+export {};