FormItem.d.ts 15 KB

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