FormItem.d.ts 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  1. import type { PropType, ExtractPropTypes, ComputedRef, Ref, ComponentPublicInstance, HTMLAttributes } from 'vue';
  2. import type { InternalNamePath, RuleError, RuleObject, ValidateOptions } from './interface';
  3. import type { ValidationRule } from './Form';
  4. declare const ValidateStatuses: ["success", "warning", "error", "validating", ""];
  5. export declare type ValidateStatus = typeof ValidateStatuses[number];
  6. export interface FieldExpose {
  7. fieldValue: Ref<any>;
  8. fieldId: ComputedRef<any>;
  9. fieldName: ComputedRef<any>;
  10. resetField: () => void;
  11. clearValidate: () => void;
  12. namePath: ComputedRef<InternalNamePath>;
  13. rules?: ComputedRef<ValidationRule[]>;
  14. validateRules: (options: ValidateOptions) => Promise<void> | Promise<RuleError[]>;
  15. }
  16. export declare const formItemProps: () => {
  17. htmlFor: StringConstructor;
  18. prefixCls: StringConstructor;
  19. label: import("vue-types").VueTypeValidableDef<any>;
  20. help: import("vue-types").VueTypeValidableDef<any>;
  21. extra: import("vue-types").VueTypeValidableDef<any>;
  22. labelCol: {
  23. type: PropType<Partial<ExtractPropTypes<{
  24. span: (StringConstructor | NumberConstructor)[];
  25. order: (StringConstructor | NumberConstructor)[];
  26. offset: (StringConstructor | NumberConstructor)[];
  27. push: (StringConstructor | NumberConstructor)[];
  28. pull: (StringConstructor | NumberConstructor)[];
  29. xs: {
  30. type: PropType<string | number | import("../grid/Col").ColSize>;
  31. default: string | number | import("../grid/Col").ColSize;
  32. };
  33. sm: {
  34. type: PropType<string | number | import("../grid/Col").ColSize>;
  35. default: string | number | import("../grid/Col").ColSize;
  36. };
  37. md: {
  38. type: PropType<string | number | import("../grid/Col").ColSize>;
  39. default: string | number | import("../grid/Col").ColSize;
  40. };
  41. lg: {
  42. type: PropType<string | number | import("../grid/Col").ColSize>;
  43. default: string | number | import("../grid/Col").ColSize;
  44. };
  45. xl: {
  46. type: PropType<string | number | import("../grid/Col").ColSize>;
  47. default: string | number | import("../grid/Col").ColSize;
  48. };
  49. xxl: {
  50. type: PropType<string | number | import("../grid/Col").ColSize>;
  51. default: string | number | import("../grid/Col").ColSize;
  52. };
  53. xxxl: {
  54. type: PropType<string | number | import("../grid/Col").ColSize>;
  55. default: string | number | import("../grid/Col").ColSize;
  56. };
  57. prefixCls: StringConstructor;
  58. flex: (StringConstructor | NumberConstructor)[];
  59. }>> & HTMLAttributes>;
  60. };
  61. wrapperCol: {
  62. type: PropType<Partial<ExtractPropTypes<{
  63. span: (StringConstructor | NumberConstructor)[];
  64. order: (StringConstructor | NumberConstructor)[];
  65. offset: (StringConstructor | NumberConstructor)[];
  66. push: (StringConstructor | NumberConstructor)[];
  67. pull: (StringConstructor | NumberConstructor)[];
  68. xs: {
  69. type: PropType<string | number | import("../grid/Col").ColSize>;
  70. default: string | number | import("../grid/Col").ColSize;
  71. };
  72. sm: {
  73. type: PropType<string | number | import("../grid/Col").ColSize>;
  74. default: string | number | import("../grid/Col").ColSize;
  75. };
  76. md: {
  77. type: PropType<string | number | import("../grid/Col").ColSize>;
  78. default: string | number | import("../grid/Col").ColSize;
  79. };
  80. lg: {
  81. type: PropType<string | number | import("../grid/Col").ColSize>;
  82. default: string | number | import("../grid/Col").ColSize;
  83. };
  84. xl: {
  85. type: PropType<string | number | import("../grid/Col").ColSize>;
  86. default: string | number | import("../grid/Col").ColSize;
  87. };
  88. xxl: {
  89. type: PropType<string | number | import("../grid/Col").ColSize>;
  90. default: string | number | import("../grid/Col").ColSize;
  91. };
  92. xxxl: {
  93. type: PropType<string | number | import("../grid/Col").ColSize>;
  94. default: string | number | import("../grid/Col").ColSize;
  95. };
  96. prefixCls: StringConstructor;
  97. flex: (StringConstructor | NumberConstructor)[];
  98. }>> & HTMLAttributes>;
  99. };
  100. hasFeedback: {
  101. type: BooleanConstructor;
  102. default: boolean;
  103. };
  104. colon: {
  105. type: BooleanConstructor;
  106. default: any;
  107. };
  108. labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
  109. prop: {
  110. type: PropType<string | number | (string | number)[]>;
  111. };
  112. name: {
  113. type: PropType<string | number | (string | number)[]>;
  114. };
  115. rules: PropType<RuleObject | RuleObject[]>;
  116. autoLink: {
  117. type: BooleanConstructor;
  118. default: boolean;
  119. };
  120. required: {
  121. type: BooleanConstructor;
  122. default: any;
  123. };
  124. validateFirst: {
  125. type: BooleanConstructor;
  126. default: any;
  127. };
  128. validateStatus: import("vue-types").VueTypeDef<"" | "error" | "validating" | "success" | "warning">;
  129. validateTrigger: {
  130. type: PropType<string | string[]>;
  131. };
  132. messageVariables: {
  133. type: PropType<Record<string, string>>;
  134. };
  135. hidden: BooleanConstructor;
  136. noStyle: BooleanConstructor;
  137. };
  138. export declare type FormItemProps = Partial<ExtractPropTypes<ReturnType<typeof formItemProps>>>;
  139. export declare type FormItemExpose = {
  140. onFieldBlur: () => void;
  141. onFieldChange: () => void;
  142. clearValidate: () => void;
  143. resetField: () => void;
  144. };
  145. export declare type FormItemInstance = ComponentPublicInstance<FormItemProps, FormItemExpose>;
  146. declare const _default: import("vue").DefineComponent<{
  147. htmlFor: StringConstructor;
  148. prefixCls: StringConstructor;
  149. label: import("vue-types").VueTypeValidableDef<any>;
  150. help: import("vue-types").VueTypeValidableDef<any>;
  151. extra: import("vue-types").VueTypeValidableDef<any>;
  152. labelCol: {
  153. type: PropType<Partial<ExtractPropTypes<{
  154. span: (StringConstructor | NumberConstructor)[];
  155. order: (StringConstructor | NumberConstructor)[];
  156. offset: (StringConstructor | NumberConstructor)[];
  157. push: (StringConstructor | NumberConstructor)[];
  158. pull: (StringConstructor | NumberConstructor)[];
  159. xs: {
  160. type: PropType<string | number | import("../grid/Col").ColSize>;
  161. default: string | number | import("../grid/Col").ColSize;
  162. };
  163. sm: {
  164. type: PropType<string | number | import("../grid/Col").ColSize>;
  165. default: string | number | import("../grid/Col").ColSize;
  166. };
  167. md: {
  168. type: PropType<string | number | import("../grid/Col").ColSize>;
  169. default: string | number | import("../grid/Col").ColSize;
  170. };
  171. lg: {
  172. type: PropType<string | number | import("../grid/Col").ColSize>;
  173. default: string | number | import("../grid/Col").ColSize;
  174. };
  175. xl: {
  176. type: PropType<string | number | import("../grid/Col").ColSize>;
  177. default: string | number | import("../grid/Col").ColSize;
  178. };
  179. xxl: {
  180. type: PropType<string | number | import("../grid/Col").ColSize>;
  181. default: string | number | import("../grid/Col").ColSize;
  182. };
  183. xxxl: {
  184. type: PropType<string | number | import("../grid/Col").ColSize>;
  185. default: string | number | import("../grid/Col").ColSize;
  186. };
  187. prefixCls: StringConstructor;
  188. flex: (StringConstructor | NumberConstructor)[];
  189. }>> & HTMLAttributes>;
  190. };
  191. wrapperCol: {
  192. type: PropType<Partial<ExtractPropTypes<{
  193. span: (StringConstructor | NumberConstructor)[];
  194. order: (StringConstructor | NumberConstructor)[];
  195. offset: (StringConstructor | NumberConstructor)[];
  196. push: (StringConstructor | NumberConstructor)[];
  197. pull: (StringConstructor | NumberConstructor)[];
  198. xs: {
  199. type: PropType<string | number | import("../grid/Col").ColSize>;
  200. default: string | number | import("../grid/Col").ColSize;
  201. };
  202. sm: {
  203. type: PropType<string | number | import("../grid/Col").ColSize>;
  204. default: string | number | import("../grid/Col").ColSize;
  205. };
  206. md: {
  207. type: PropType<string | number | import("../grid/Col").ColSize>;
  208. default: string | number | import("../grid/Col").ColSize;
  209. };
  210. lg: {
  211. type: PropType<string | number | import("../grid/Col").ColSize>;
  212. default: string | number | import("../grid/Col").ColSize;
  213. };
  214. xl: {
  215. type: PropType<string | number | import("../grid/Col").ColSize>;
  216. default: string | number | import("../grid/Col").ColSize;
  217. };
  218. xxl: {
  219. type: PropType<string | number | import("../grid/Col").ColSize>;
  220. default: string | number | import("../grid/Col").ColSize;
  221. };
  222. xxxl: {
  223. type: PropType<string | number | import("../grid/Col").ColSize>;
  224. default: string | number | import("../grid/Col").ColSize;
  225. };
  226. prefixCls: StringConstructor;
  227. flex: (StringConstructor | NumberConstructor)[];
  228. }>> & HTMLAttributes>;
  229. };
  230. hasFeedback: {
  231. type: BooleanConstructor;
  232. default: boolean;
  233. };
  234. colon: {
  235. type: BooleanConstructor;
  236. default: any;
  237. };
  238. labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
  239. prop: {
  240. type: PropType<string | number | (string | number)[]>;
  241. };
  242. name: {
  243. type: PropType<string | number | (string | number)[]>;
  244. };
  245. rules: PropType<RuleObject | RuleObject[]>;
  246. autoLink: {
  247. type: BooleanConstructor;
  248. default: boolean;
  249. };
  250. required: {
  251. type: BooleanConstructor;
  252. default: any;
  253. };
  254. validateFirst: {
  255. type: BooleanConstructor;
  256. default: any;
  257. };
  258. validateStatus: import("vue-types").VueTypeDef<"" | "error" | "validating" | "success" | "warning">;
  259. validateTrigger: {
  260. type: PropType<string | string[]>;
  261. };
  262. messageVariables: {
  263. type: PropType<Record<string, string>>;
  264. };
  265. hidden: BooleanConstructor;
  266. noStyle: BooleanConstructor;
  267. }, () => JSX.Element | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  268. [key: string]: any;
  269. }>[], unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
  270. htmlFor: StringConstructor;
  271. prefixCls: StringConstructor;
  272. label: import("vue-types").VueTypeValidableDef<any>;
  273. help: import("vue-types").VueTypeValidableDef<any>;
  274. extra: import("vue-types").VueTypeValidableDef<any>;
  275. labelCol: {
  276. type: PropType<Partial<ExtractPropTypes<{
  277. span: (StringConstructor | NumberConstructor)[];
  278. order: (StringConstructor | NumberConstructor)[];
  279. offset: (StringConstructor | NumberConstructor)[];
  280. push: (StringConstructor | NumberConstructor)[];
  281. pull: (StringConstructor | NumberConstructor)[];
  282. xs: {
  283. type: PropType<string | number | import("../grid/Col").ColSize>;
  284. default: string | number | import("../grid/Col").ColSize;
  285. };
  286. sm: {
  287. type: PropType<string | number | import("../grid/Col").ColSize>;
  288. default: string | number | import("../grid/Col").ColSize;
  289. };
  290. md: {
  291. type: PropType<string | number | import("../grid/Col").ColSize>;
  292. default: string | number | import("../grid/Col").ColSize;
  293. };
  294. lg: {
  295. type: PropType<string | number | import("../grid/Col").ColSize>;
  296. default: string | number | import("../grid/Col").ColSize;
  297. };
  298. xl: {
  299. type: PropType<string | number | import("../grid/Col").ColSize>;
  300. default: string | number | import("../grid/Col").ColSize;
  301. };
  302. xxl: {
  303. type: PropType<string | number | import("../grid/Col").ColSize>;
  304. default: string | number | import("../grid/Col").ColSize;
  305. };
  306. xxxl: {
  307. type: PropType<string | number | import("../grid/Col").ColSize>;
  308. default: string | number | import("../grid/Col").ColSize;
  309. };
  310. prefixCls: StringConstructor;
  311. flex: (StringConstructor | NumberConstructor)[];
  312. }>> & HTMLAttributes>;
  313. };
  314. wrapperCol: {
  315. type: PropType<Partial<ExtractPropTypes<{
  316. span: (StringConstructor | NumberConstructor)[];
  317. order: (StringConstructor | NumberConstructor)[];
  318. offset: (StringConstructor | NumberConstructor)[];
  319. push: (StringConstructor | NumberConstructor)[];
  320. pull: (StringConstructor | NumberConstructor)[];
  321. xs: {
  322. type: PropType<string | number | import("../grid/Col").ColSize>;
  323. default: string | number | import("../grid/Col").ColSize;
  324. };
  325. sm: {
  326. type: PropType<string | number | import("../grid/Col").ColSize>;
  327. default: string | number | import("../grid/Col").ColSize;
  328. };
  329. md: {
  330. type: PropType<string | number | import("../grid/Col").ColSize>;
  331. default: string | number | import("../grid/Col").ColSize;
  332. };
  333. lg: {
  334. type: PropType<string | number | import("../grid/Col").ColSize>;
  335. default: string | number | import("../grid/Col").ColSize;
  336. };
  337. xl: {
  338. type: PropType<string | number | import("../grid/Col").ColSize>;
  339. default: string | number | import("../grid/Col").ColSize;
  340. };
  341. xxl: {
  342. type: PropType<string | number | import("../grid/Col").ColSize>;
  343. default: string | number | import("../grid/Col").ColSize;
  344. };
  345. xxxl: {
  346. type: PropType<string | number | import("../grid/Col").ColSize>;
  347. default: string | number | import("../grid/Col").ColSize;
  348. };
  349. prefixCls: StringConstructor;
  350. flex: (StringConstructor | NumberConstructor)[];
  351. }>> & HTMLAttributes>;
  352. };
  353. hasFeedback: {
  354. type: BooleanConstructor;
  355. default: boolean;
  356. };
  357. colon: {
  358. type: BooleanConstructor;
  359. default: any;
  360. };
  361. labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
  362. prop: {
  363. type: PropType<string | number | (string | number)[]>;
  364. };
  365. name: {
  366. type: PropType<string | number | (string | number)[]>;
  367. };
  368. rules: PropType<RuleObject | RuleObject[]>;
  369. autoLink: {
  370. type: BooleanConstructor;
  371. default: boolean;
  372. };
  373. required: {
  374. type: BooleanConstructor;
  375. default: any;
  376. };
  377. validateFirst: {
  378. type: BooleanConstructor;
  379. default: any;
  380. };
  381. validateStatus: import("vue-types").VueTypeDef<"" | "error" | "validating" | "success" | "warning">;
  382. validateTrigger: {
  383. type: PropType<string | string[]>;
  384. };
  385. messageVariables: {
  386. type: PropType<Record<string, string>>;
  387. };
  388. hidden: BooleanConstructor;
  389. noStyle: BooleanConstructor;
  390. }>>, {
  391. hidden: boolean;
  392. required: boolean;
  393. colon: boolean;
  394. hasFeedback: boolean;
  395. autoLink: boolean;
  396. validateFirst: boolean;
  397. noStyle: boolean;
  398. }>;
  399. export default _default;