form.vue.d.ts 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. import type { Arrayable } from 'element-plus/es/utils';
  2. import type { FormItemContext, FormValidateCallback, FormValidationResult } from './types';
  3. import type { FormItemProp } from './form-item';
  4. declare function __VLS_template(): {
  5. default?(_: {}): any;
  6. };
  7. declare const __VLS_component: import("vue").DefineComponent<{
  8. readonly model: ObjectConstructor;
  9. readonly rules: {
  10. readonly type: import("vue").PropType<Partial<Record<string, Arrayable<import("./types").FormItemRule>>>>;
  11. readonly required: false;
  12. readonly validator: ((val: unknown) => boolean) | undefined;
  13. __epPropKey: true;
  14. };
  15. readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "top" | "left" | "right", unknown, "right", boolean>;
  16. readonly requireAsteriskPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right", unknown, "left", boolean>;
  17. readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
  18. readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
  19. readonly inline: BooleanConstructor;
  20. readonly inlineMessage: BooleanConstructor;
  21. readonly statusIcon: BooleanConstructor;
  22. readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  23. readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  24. readonly hideRequiredAsterisk: BooleanConstructor;
  25. readonly scrollToError: BooleanConstructor;
  26. readonly scrollIntoViewOptions: {
  27. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<readonly [ObjectConstructor, BooleanConstructor], unknown, unknown>>;
  28. readonly required: false;
  29. readonly validator: ((val: unknown) => boolean) | undefined;
  30. __epPropKey: true;
  31. };
  32. readonly size: {
  33. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
  34. readonly required: false;
  35. readonly validator: ((val: unknown) => boolean) | undefined;
  36. __epPropKey: true;
  37. };
  38. readonly disabled: BooleanConstructor;
  39. }, {
  40. /**
  41. * @description Validate the whole form. Receives a callback or returns `Promise`.
  42. */
  43. validate: (callback?: FormValidateCallback) => FormValidationResult;
  44. /**
  45. * @description Validate specified fields.
  46. */
  47. validateField: (props?: Arrayable<FormItemProp>, callback?: FormValidateCallback) => FormValidationResult;
  48. /**
  49. * @description Reset specified fields and remove validation result.
  50. */
  51. resetFields: (props?: Arrayable<FormItemProp>) => void;
  52. /**
  53. * @description Clear validation message for specified fields.
  54. */
  55. clearValidate: (props?: Arrayable<FormItemProp>) => void;
  56. /**
  57. * @description Scroll to the specified fields.
  58. */
  59. scrollToField: (prop: FormItemProp) => void;
  60. /**
  61. * @description All fields context.
  62. */
  63. fields: FormItemContext[];
  64. }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  65. validate: (prop: FormItemProp, isValid: boolean, message: string) => void;
  66. }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
  67. readonly model: ObjectConstructor;
  68. readonly rules: {
  69. readonly type: import("vue").PropType<Partial<Record<string, Arrayable<import("./types").FormItemRule>>>>;
  70. readonly required: false;
  71. readonly validator: ((val: unknown) => boolean) | undefined;
  72. __epPropKey: true;
  73. };
  74. readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "top" | "left" | "right", unknown, "right", boolean>;
  75. readonly requireAsteriskPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right", unknown, "left", boolean>;
  76. readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
  77. readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
  78. readonly inline: BooleanConstructor;
  79. readonly inlineMessage: BooleanConstructor;
  80. readonly statusIcon: BooleanConstructor;
  81. readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  82. readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  83. readonly hideRequiredAsterisk: BooleanConstructor;
  84. readonly scrollToError: BooleanConstructor;
  85. readonly scrollIntoViewOptions: {
  86. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<readonly [ObjectConstructor, BooleanConstructor], unknown, unknown>>;
  87. readonly required: false;
  88. readonly validator: ((val: unknown) => boolean) | undefined;
  89. __epPropKey: true;
  90. };
  91. readonly size: {
  92. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
  93. readonly required: false;
  94. readonly validator: ((val: unknown) => boolean) | undefined;
  95. __epPropKey: true;
  96. };
  97. readonly disabled: BooleanConstructor;
  98. }>> & {
  99. onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => any) | undefined;
  100. }, {
  101. readonly disabled: boolean;
  102. readonly inline: boolean;
  103. readonly labelWidth: import("element-plus/es/utils").EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
  104. readonly labelPosition: import("element-plus/es/utils").EpPropMergeType<StringConstructor, "top" | "left" | "right", unknown>;
  105. readonly inlineMessage: boolean;
  106. readonly showMessage: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
  107. readonly requireAsteriskPosition: import("element-plus/es/utils").EpPropMergeType<StringConstructor, "left" | "right", unknown>;
  108. readonly labelSuffix: string;
  109. readonly validateOnRuleChange: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
  110. readonly statusIcon: boolean;
  111. readonly hideRequiredAsterisk: boolean;
  112. readonly scrollToError: boolean;
  113. }>;
  114. declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
  115. export default _default;
  116. type __VLS_WithTemplateSlots<T, S> = T & {
  117. new (): {
  118. $slots: S;
  119. };
  120. };