form-item.vue.d.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. import type { CSSProperties } from 'vue';
  2. import type { RuleItem } from 'async-validator';
  3. import type { FormItemContext, FormItemRule, FormValidateFailure } from 'element-plus/es/tokens';
  4. import type { Arrayable } from 'element-plus/es/utils';
  5. import type { FormItemValidateState } from './form-item';
  6. declare const _default: import("vue").DefineComponent<{
  7. readonly label: StringConstructor;
  8. readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
  9. readonly prop: {
  10. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => import("./form-item").FormItemProp & {}) | (() => import("./form-item").FormItemProp) | ((new (...args: any[]) => import("./form-item").FormItemProp & {}) | (() => import("./form-item").FormItemProp))[], unknown, unknown>>;
  11. readonly required: false;
  12. readonly validator: ((val: unknown) => boolean) | undefined;
  13. __epPropKey: true;
  14. };
  15. readonly required: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, undefined, boolean>;
  16. readonly rules: {
  17. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>) | ((new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>))[], unknown, unknown>>;
  18. readonly required: false;
  19. readonly validator: ((val: unknown) => boolean) | undefined;
  20. __epPropKey: true;
  21. };
  22. readonly error: StringConstructor;
  23. readonly validateStatus: {
  24. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "success" | "error" | "validating", unknown>>;
  25. readonly required: false;
  26. readonly validator: ((val: unknown) => boolean) | undefined;
  27. __epPropKey: true;
  28. };
  29. readonly for: StringConstructor;
  30. readonly inlineMessage: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, BooleanConstructor], unknown, unknown, "", boolean>;
  31. readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  32. readonly size: {
  33. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "default" | "small" | "large", unknown>>;
  34. readonly required: false;
  35. readonly validator: ((val: unknown) => boolean) | undefined;
  36. __epPropKey: true;
  37. };
  38. }, {
  39. props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
  40. readonly label: StringConstructor;
  41. readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
  42. readonly prop: {
  43. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => import("./form-item").FormItemProp & {}) | (() => import("./form-item").FormItemProp) | ((new (...args: any[]) => import("./form-item").FormItemProp & {}) | (() => import("./form-item").FormItemProp))[], unknown, unknown>>;
  44. readonly required: false;
  45. readonly validator: ((val: unknown) => boolean) | undefined;
  46. __epPropKey: true;
  47. };
  48. readonly required: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, undefined, boolean>;
  49. readonly rules: {
  50. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>) | ((new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>))[], unknown, unknown>>;
  51. readonly required: false;
  52. readonly validator: ((val: unknown) => boolean) | undefined;
  53. __epPropKey: true;
  54. };
  55. readonly error: StringConstructor;
  56. readonly validateStatus: {
  57. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "success" | "error" | "validating", unknown>>;
  58. readonly required: false;
  59. readonly validator: ((val: unknown) => boolean) | undefined;
  60. __epPropKey: true;
  61. };
  62. readonly for: StringConstructor;
  63. readonly inlineMessage: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, BooleanConstructor], unknown, unknown, "", boolean>;
  64. readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  65. readonly size: {
  66. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "default" | "small" | "large", unknown>>;
  67. readonly required: false;
  68. readonly validator: ((val: unknown) => boolean) | undefined;
  69. __epPropKey: true;
  70. };
  71. }>> & {
  72. [x: string & `on${string}`]: ((...args: any[]) => any) | ((...args: unknown[]) => any) | undefined;
  73. }>>;
  74. slots: Readonly<{
  75. [name: string]: import("vue").Slot | undefined;
  76. }>;
  77. formContext: import("element-plus/es/tokens").FormContext | undefined;
  78. parentFormItemContext: FormItemContext | undefined;
  79. _size: import("vue").ComputedRef<"" | "default" | "small" | "large">;
  80. ns: {
  81. namespace: import("vue").Ref<string>;
  82. b: (blockSuffix?: string) => string;
  83. e: (element?: string | undefined) => string;
  84. m: (modifier?: string | undefined) => string;
  85. be: (blockSuffix?: string | undefined, element?: string | undefined) => string;
  86. em: (element?: string | undefined, modifier?: string | undefined) => string;
  87. bm: (blockSuffix?: string | undefined, modifier?: string | undefined) => string;
  88. bem: (blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined) => string;
  89. is: {
  90. (name: string, state: boolean | undefined): string;
  91. (name: string): string;
  92. };
  93. cssVar: (object: Record<string, string>) => Record<string, string>;
  94. cssVarName: (name: string) => string;
  95. cssVarBlock: (object: Record<string, string>) => Record<string, string>;
  96. cssVarBlockName: (name: string) => string;
  97. };
  98. labelId: string;
  99. inputIds: import("vue").Ref<string[]>;
  100. validateState: import("vue").Ref<"" | "success" | "error" | "validating">;
  101. validateStateDebounced: Readonly<import("vue").Ref<"" | "success" | "error" | "validating">>;
  102. validateMessage: import("vue").Ref<string>;
  103. formItemRef: import("vue").Ref<HTMLDivElement | undefined>;
  104. initialValue: any;
  105. isResettingField: boolean;
  106. labelStyle: import("vue").ComputedRef<CSSProperties>;
  107. contentStyle: import("vue").ComputedRef<CSSProperties>;
  108. formItemClasses: import("vue").ComputedRef<(string | {
  109. [x: string]: boolean | undefined;
  110. })[]>;
  111. _inlineMessage: import("vue").ComputedRef<boolean>;
  112. validateClasses: import("vue").ComputedRef<(string | {
  113. [x: string]: boolean;
  114. })[]>;
  115. propString: import("vue").ComputedRef<string>;
  116. hasLabel: import("vue").ComputedRef<boolean>;
  117. labelFor: import("vue").ComputedRef<string | undefined>;
  118. isGroup: import("vue").ComputedRef<boolean>;
  119. isNested: boolean;
  120. fieldValue: import("vue").ComputedRef<any>;
  121. normalizedRules: import("vue").ComputedRef<FormItemRule[]>;
  122. validateEnabled: import("vue").ComputedRef<boolean>;
  123. getFilteredRule: (trigger: string) => RuleItem[];
  124. isRequired: import("vue").ComputedRef<boolean>;
  125. shouldShowError: import("vue").ComputedRef<import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>>;
  126. currentLabel: import("vue").ComputedRef<string>;
  127. setValidationState: (state: FormItemValidateState) => void;
  128. onValidationFailed: (error: FormValidateFailure) => void;
  129. onValidationSucceeded: () => void;
  130. doValidate: (rules: RuleItem[]) => Promise<true>;
  131. validate: (trigger: string, callback?: import("element-plus/es/tokens").FormValidateCallback | undefined) => import("element-plus/es/tokens").FormValidationResult;
  132. clearValidate: () => void;
  133. resetField: () => void;
  134. addInputId: (id: string) => void;
  135. removeInputId: (id: string) => void;
  136. context: FormItemContext;
  137. FormLabelWrap: import("vue").DefineComponent<{
  138. isAutoWidth: BooleanConstructor;
  139. updateAll: BooleanConstructor;
  140. }, () => JSX.Element | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
  141. isAutoWidth: BooleanConstructor;
  142. updateAll: BooleanConstructor;
  143. }>>, {
  144. isAutoWidth: boolean;
  145. updateAll: boolean;
  146. }>;
  147. }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
  148. readonly label: StringConstructor;
  149. readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
  150. readonly prop: {
  151. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => import("./form-item").FormItemProp & {}) | (() => import("./form-item").FormItemProp) | ((new (...args: any[]) => import("./form-item").FormItemProp & {}) | (() => import("./form-item").FormItemProp))[], unknown, unknown>>;
  152. readonly required: false;
  153. readonly validator: ((val: unknown) => boolean) | undefined;
  154. __epPropKey: true;
  155. };
  156. readonly required: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, undefined, boolean>;
  157. readonly rules: {
  158. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>) | ((new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>))[], unknown, unknown>>;
  159. readonly required: false;
  160. readonly validator: ((val: unknown) => boolean) | undefined;
  161. __epPropKey: true;
  162. };
  163. readonly error: StringConstructor;
  164. readonly validateStatus: {
  165. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "success" | "error" | "validating", unknown>>;
  166. readonly required: false;
  167. readonly validator: ((val: unknown) => boolean) | undefined;
  168. __epPropKey: true;
  169. };
  170. readonly for: StringConstructor;
  171. readonly inlineMessage: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, BooleanConstructor], unknown, unknown, "", boolean>;
  172. readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  173. readonly size: {
  174. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "default" | "small" | "large", unknown>>;
  175. readonly required: false;
  176. readonly validator: ((val: unknown) => boolean) | undefined;
  177. __epPropKey: true;
  178. };
  179. }>>, {
  180. readonly required: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
  181. readonly labelWidth: import("element-plus/es/utils").EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
  182. readonly showMessage: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
  183. readonly inlineMessage: import("element-plus/es/utils").EpPropMergeType<readonly [StringConstructor, BooleanConstructor], unknown, unknown>;
  184. }>;
  185. export default _default;