FormItem.d.ts 16 KB

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