ngx-formly-zorro-antd 14.1.0 → 14.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,173 @@
1
+ import { TemplateRef } from '@angular/core';
2
+ import type { FormlyFieldConfig } from '@ngx-formly/core';
3
+ import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
4
+ import { Observable, Subscription } from 'rxjs';
5
+ import type { ThemeType } from '@ant-design/icons-angular';
6
+ import type { NzUploadChangeParam, NzUploadFile, NzUploadTransformFileType, UploadFilter, NzIconRenderTemplate, NzUploadListType, NzUploadType, NzUploadXHRArgs } from 'ng-zorro-antd/upload';
7
+ import type { NzSafeAny } from 'ng-zorro-antd/core/types';
8
+ export interface UploadProps extends FormlyFieldProps {
9
+ type?: NzUploadType;
10
+ /**
11
+ * 接受上传的文件类型, 详见 input accept Attribute
12
+ */
13
+ accept?: string | string[];
14
+ /**
15
+ * 必选参数, 上传的地址
16
+ */
17
+ action?: string | ((file: NzUploadFile) => string | Observable<string>);
18
+ /**
19
+ * 支持上传文件夹(caniuse)
20
+ * @default false
21
+ */
22
+ directory?: boolean;
23
+ /**
24
+ * 上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。注意:IE9 不支持该方法;注意:务必使用 => 定义处理方法。
25
+ */
26
+ beforeUpload?: (file: NzUploadFile, fileList: NzUploadFile[]) => boolean | Observable<boolean>;
27
+ /**
28
+ * 通过覆盖默认的上传行为,可以自定义自己的上传实现;注意:务必使用 => 定义处理方法。
29
+ */
30
+ customRequest?: (item: NzUploadXHRArgs) => Subscription;
31
+ /**
32
+ * 上传所需参数或返回上传参数的方法;注意:务必使用 => 定义处理方法。
33
+ */
34
+ data?: {} | ((file: NzUploadFile) => {} | Observable<{}>);
35
+ /**
36
+ * 文件列表,双向绑定
37
+ */
38
+ fileList: NzUploadFile[];
39
+ /**
40
+ * 限制单次最多上传数量,nzMultiple 打开时有效;0 表示不限
41
+ * @default 0
42
+ */
43
+ limit?: number;
44
+ /**
45
+ * 限制文件大小,单位:KB;0 表示不限
46
+ * @default 0
47
+ */
48
+ size?: number;
49
+ /**
50
+ * 限制文件类型,例如:image/png,image/jpeg,image/gif,image/bmp
51
+ */
52
+ fileType?: string;
53
+ /**
54
+ * 自定义过滤器
55
+ */
56
+ filter?: UploadFilter[];
57
+ /**
58
+ * 设置上传的请求头部,IE10 以上有效;注意:务必使用 => 定义处理方法。
59
+ */
60
+ headers?: Object | ((file: NzUploadFile) => Object | Observable<{}>);
61
+ /**
62
+ * 上传列表的内建样式,支持三种基本样式 text, picture 和 picture-card
63
+ * @default text
64
+ */
65
+ listType?: NzUploadListType;
66
+ /**
67
+ * 是否支持多选文件,ie10+ 支持。开启后按住 ctrl 可选择多个文件。
68
+ * @default false;
69
+ */
70
+ multiple?: boolean;
71
+ /**
72
+ * 发到后台的文件参数名
73
+ * @default file
74
+ */
75
+ name?: string;
76
+ /**
77
+ * 是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon,showRemoveIcon 和 showDownloadIcon
78
+ * @default true
79
+ */
80
+ showUploadList?: boolean | {
81
+ showPreviewIcon?: boolean;
82
+ showRemoveIcon?: boolean;
83
+ showDownloadIcon?: boolean;
84
+ };
85
+ /**
86
+ * 是否展示上传按钮
87
+ * @default true
88
+ */
89
+ showButton?: boolean;
90
+ /**
91
+ * 上传请求时是否携带 cookie
92
+ * @default false
93
+ */
94
+ withCredentials?: boolean;
95
+ /**
96
+ * 点击打开文件对话框
97
+ * @default true
98
+ */
99
+ openFileDialogOnClick?: boolean;
100
+ /**
101
+ * 点击文件链接或预览图标时的回调;注意:务必使用 => 定义处理方法。
102
+ */
103
+ preview?: (file: NzUploadFile) => void;
104
+ /**
105
+ * 自定义文件预览逻辑;注意:务必使用 => 定义处理方法。
106
+ */
107
+ previewFile?: (file: NzUploadFile) => Observable<string>;
108
+ /**
109
+ * 自定义预览文件是否有效图像,一般用于图像URL为非标准格式;注意:务必使用 => 定义处理方法。
110
+ */
111
+ previewIsImage?: (file: NzUploadFile) => boolean;
112
+ /**
113
+ * 点击移除文件时的回调,返回值为 false 时不移除。支持返回 Observable 对象;注意:务必使用 => 定义处理方法。
114
+ */
115
+ remove?: (file: NzUploadFile) => boolean | Observable<boolean>;
116
+ /**
117
+ * 上传文件改变时的状态
118
+ */
119
+ onChange?: (value: NzUploadChangeParam) => void;
120
+ /**
121
+ * 点击下载文件时的回调,如果没有指定,则默认跳转到文件 url 对应的标签页
122
+ * @default 跳转新标签页
123
+ */
124
+ download?: (file: NzUploadFile) => void;
125
+ /**
126
+ * 在上传之前转换文件。支持返回一个 Observable 对象
127
+ */
128
+ transformFile?: (file: NzUploadFile) => NzUploadTransformFileType;
129
+ /**
130
+ * 自定义显示 icon
131
+ */
132
+ iconRender?: NzIconRenderTemplate | null;
133
+ /**
134
+ * 自定义显示整个列表
135
+ */
136
+ fileListRender?: TemplateRef<void> | null;
137
+ /**
138
+ * 文件列表改变事件
139
+ */
140
+ fileListChange?: (field: FormlyFieldConfig, event: NzUploadFile[]) => void;
141
+ /**
142
+ * 返回结果格式映射
143
+ * @returns 默认返回 NzUploadFile[] 格式
144
+ */
145
+ resultMap?: (items: NzUploadFile[]) => NzSafeAny[];
146
+ /** 上传的提示信息 */
147
+ hint?: string;
148
+ /**
149
+ * 上传显示文本信息
150
+ */
151
+ text?: string;
152
+ /**
153
+ * 上传按钮的图标
154
+ */
155
+ uploadButtonIcon?: AntdIcon | null;
156
+ /**
157
+ * 是否显示上传按钮
158
+ * @default true
159
+ */
160
+ showUploadButton?: boolean;
161
+ }
162
+ export interface AntdIcon {
163
+ /** 图标类型 */
164
+ type: string;
165
+ /** 图标主题风格,默认:`outline` */
166
+ theme?: ThemeType;
167
+ /** 是否有旋转动画,默认:`false` */
168
+ spin?: boolean;
169
+ /** 仅适用双色图标,设置双色图标的主要颜色,仅对当前 icon 生效 */
170
+ twoToneColor?: string;
171
+ /** 指定来自 IconFont 的图标类型 */
172
+ iconfont?: string;
173
+ }
@@ -1,157 +1,12 @@
1
- import { TemplateRef, Type, OnInit } from '@angular/core';
1
+ import { Type, OnInit } from '@angular/core';
2
2
  import { FieldType, FieldTypeConfig, FormlyFieldConfig } from '@ngx-formly/core';
3
- import { FormlyFieldProps } from 'ngx-formly-zorro-antd/form-field';
4
- import { Observable, Subscription } from 'rxjs';
5
- import { NzUploadComponent, NzUploadChangeParam, NzUploadFile, NzUploadTransformFileType, UploadFilter, NzIconRenderTemplate, NzUploadListType } from 'ng-zorro-antd/upload';
6
- import type { NzSafeAny } from 'ng-zorro-antd/core/types';
3
+ import { UploadNzComponent } from './upload.component';
4
+ import type { UploadProps } from './upload.props';
7
5
  import * as i0 from "@angular/core";
8
- interface UploadProps extends FormlyFieldProps {
9
- /**
10
- * 接受上传的文件类型, 详见 input accept Attribute
11
- */
12
- accept?: string | string[];
13
- /**
14
- * 必选参数, 上传的地址
15
- */
16
- action?: string | ((file: NzUploadFile) => string | Observable<string>);
17
- /**
18
- * 支持上传文件夹(caniuse)
19
- * @default false
20
- */
21
- directory?: boolean;
22
- /**
23
- * 上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。注意:IE9 不支持该方法;注意:务必使用 => 定义处理方法。
24
- */
25
- beforeUpload?: (file: NzUploadFile, fileList: NzUploadFile[]) => boolean | Observable<boolean>;
26
- /**
27
- * 通过覆盖默认的上传行为,可以自定义自己的上传实现;注意:务必使用 => 定义处理方法。
28
- */
29
- customRequest?: (item: NzSafeAny) => Subscription;
30
- /**
31
- * 上传所需参数或返回上传参数的方法;注意:务必使用 => 定义处理方法。
32
- */
33
- data?: Object | ((file: NzUploadFile) => Object | Observable<{}>);
34
- /**
35
- * 文件列表,双向绑定
36
- */
37
- fileList?: NzUploadFile[];
38
- /**
39
- * 限制单次最多上传数量,nzMultiple 打开时有效;0 表示不限
40
- * @default 0
41
- */
42
- limit?: number;
43
- /**
44
- * 限制文件大小,单位:KB;0 表示不限
45
- * @default 0
46
- */
47
- size?: number;
48
- /**
49
- * 限制文件类型,例如:image/png,image/jpeg,image/gif,image/bmp
50
- */
51
- fileType?: string;
52
- /**
53
- * 自定义过滤器
54
- */
55
- filter?: UploadFilter[];
56
- /**
57
- * 设置上传的请求头部,IE10 以上有效;注意:务必使用 => 定义处理方法。
58
- */
59
- headers?: Object | ((file: NzUploadFile) => Object | Observable<{}>);
60
- /**
61
- * 上传列表的内建样式,支持三种基本样式 text, picture 和 picture-card
62
- * @default text
63
- */
64
- listType?: NzUploadListType;
65
- /**
66
- * 是否支持多选文件,ie10+ 支持。开启后按住 ctrl 可选择多个文件。
67
- * @default false;
68
- */
69
- multiple?: boolean;
70
- /**
71
- * 发到后台的文件参数名
72
- * @default file
73
- */
74
- name?: string;
75
- /**
76
- * 是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon,showRemoveIcon 和 showDownloadIcon
77
- * @default true
78
- */
79
- showUploadList?: boolean | {
80
- showPreviewIcon?: boolean;
81
- showRemoveIcon?: boolean;
82
- showDownloadIcon?: boolean;
83
- };
84
- /**
85
- * 是否展示上传按钮
86
- * @default true
87
- */
88
- showButton?: boolean;
89
- /**
90
- * 上传请求时是否携带 cookie
91
- * @default false
92
- */
93
- withCredentials?: boolean;
94
- /**
95
- * 点击打开文件对话框
96
- * @default true
97
- */
98
- openFileDialogOnClick?: boolean;
99
- /**
100
- * 点击文件链接或预览图标时的回调;注意:务必使用 => 定义处理方法。
101
- */
102
- preview?: (file: NzUploadFile) => void;
103
- /**
104
- * 自定义文件预览逻辑;注意:务必使用 => 定义处理方法。
105
- */
106
- previewFile?: (file: NzUploadFile) => Observable<string>;
107
- /**
108
- * 自定义预览文件是否有效图像,一般用于图像URL为非标准格式;注意:务必使用 => 定义处理方法。
109
- */
110
- previewIsImage?: (file: NzUploadFile) => boolean;
111
- /**
112
- * 点击移除文件时的回调,返回值为 false 时不移除。支持返回 Observable 对象;注意:务必使用 => 定义处理方法。
113
- */
114
- remove?: (file: NzUploadFile) => boolean | Observable<boolean>;
115
- /**
116
- * 上传文件改变时的状态
117
- */
118
- onChange?: (value: NzUploadChangeParam) => void;
119
- /**
120
- * 点击下载文件时的回调,如果没有指定,则默认跳转到文件 url 对应的标签页
121
- * @default 跳转新标签页
122
- */
123
- download?: (file: NzUploadFile) => void;
124
- /**
125
- * 在上传之前转换文件。支持返回一个 Observable 对象
126
- */
127
- transformFile?: (file: NzUploadFile) => NzUploadTransformFileType;
128
- /**
129
- * 自定义显示 icon
130
- */
131
- iconRender?: NzIconRenderTemplate | null;
132
- /**
133
- * 自定义显示整个列表
134
- */
135
- fileListRender?: TemplateRef<void> | null;
136
- /**
137
- * 按钮文本
138
- * @default 点击上传
139
- */
140
- text?: string;
141
- /**
142
- * 文件列表改变事件
143
- */
144
- fileListChange?: (list: NzUploadFile[]) => void;
145
- /**
146
- * 返回结果格式映射
147
- * @returns 默认返回 NzUploadFile[] 格式
148
- */
149
- resultMap?: (items: NzUploadFile[]) => NzSafeAny[];
150
- }
151
6
  export interface FormlyUploadFieldConfig extends FormlyFieldConfig<UploadProps> {
152
7
  type: 'upload' | Type<FormlyFieldUpload>;
153
8
  }
154
- export declare class FormlyFieldUpload extends FieldType<FieldTypeConfig> implements OnInit {
9
+ export declare class FormlyFieldUpload extends FieldType<FieldTypeConfig<UploadProps>> implements OnInit {
155
10
  defaultOptions: {
156
11
  props: {
157
12
  listType: "text";
@@ -159,15 +14,16 @@ export declare class FormlyFieldUpload extends FieldType<FieldTypeConfig> implem
159
14
  showUploadList: boolean;
160
15
  showButton: boolean;
161
16
  openFileDialogOnClick: boolean;
17
+ showUploadButton: boolean;
162
18
  limit: number;
163
19
  size: number;
20
+ fileList: never[];
164
21
  filter: never[];
165
22
  text: string;
166
23
  };
167
24
  };
168
- upload: NzUploadComponent;
25
+ upload: UploadNzComponent;
169
26
  ngOnInit(): void;
170
27
  static ɵfac: i0.ɵɵFactoryDeclaration<FormlyFieldUpload, never>;
171
28
  static ɵcmp: i0.ɵɵComponentDeclaration<FormlyFieldUpload, "formly-field-upload", never, {}, {}, never, never, false>;
172
29
  }
173
- export {};