index.d.mts 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. import * as vue from 'vue';
  2. import { ComponentPropsOptions, ExtractPropTypes, VNodeChild, VNode, PropType, ComponentPublicInstance, FunctionalComponent, ComputedRef, Ref } from 'vue';
  3. type SlotsToProps<U extends RawSlots, T = MakeInternalSlots<U>> = {
  4. $children?: (VNodeChild | (T extends {
  5. default: infer V;
  6. } ? V : {}) | {
  7. [K in keyof T]?: T[K];
  8. });
  9. 'v-slots'?: {
  10. [K in keyof T]?: T[K] | false;
  11. };
  12. } & {
  13. [K in keyof T as `v-slot:${K & string}`]?: T[K] | false;
  14. };
  15. type RawSlots = Record<string, unknown>;
  16. type Slot<T> = [T] extends [never] ? () => VNodeChild : (arg: T) => VNodeChild;
  17. type VueSlot<T> = [T] extends [never] ? () => VNode[] : (arg: T) => VNode[];
  18. type MakeInternalSlots<T extends RawSlots> = {
  19. [K in keyof T]: Slot<T[K]>;
  20. };
  21. type MakeSlots<T extends RawSlots> = {
  22. [K in keyof T]: VueSlot<T[K]>;
  23. };
  24. type GenericProps<Props, Slots extends Record<string, unknown>> = {
  25. $props: Props & SlotsToProps<Slots>;
  26. $slots: MakeSlots<Slots>;
  27. };
  28. interface FilterPropsOptions<PropsOptions extends Readonly<ComponentPropsOptions>, Props = ExtractPropTypes<PropsOptions>> {
  29. filterProps<T extends Partial<Props>, U extends Exclude<keyof Props, Exclude<keyof Props, keyof T>>>(props: T): Partial<Pick<T, U>>;
  30. }
  31. type ClassValue = any;
  32. type EventProp<T extends any[] = any[], F = (...args: T) => void> = F;
  33. declare const EventProp: <T extends any[] = any[]>() => PropType<EventProp<T>>;
  34. type Density = null | 'default' | 'comfortable' | 'compact';
  35. type ValidationResult = string | boolean;
  36. type ValidationRule = ValidationResult | PromiseLike<ValidationResult> | ((value: any) => ValidationResult) | ((value: any) => PromiseLike<ValidationResult>);
  37. type ValidateOnValue = 'blur' | 'input' | 'submit' | 'invalid-input';
  38. type ValidateOn = ValidateOnValue | `${ValidateOnValue} lazy` | `${ValidateOnValue} eager` | `lazy ${ValidateOnValue}` | `eager ${ValidateOnValue}` | 'lazy' | 'eager';
  39. interface ValidationProps {
  40. disabled: boolean | null;
  41. error: boolean;
  42. errorMessages: string | readonly string[] | null;
  43. focused: boolean;
  44. maxErrors: string | number;
  45. name: string | undefined;
  46. label: string | undefined;
  47. readonly: boolean | null;
  48. rules: readonly ValidationRule[];
  49. modelValue: any;
  50. 'onUpdate:modelValue': EventProp | undefined;
  51. validateOn?: ValidateOn;
  52. validationValue: any;
  53. }
  54. type JSXComponent<Props = any> = {
  55. new (): ComponentPublicInstance<Props>;
  56. } | FunctionalComponent<Props>;
  57. type IconValue = string | (string | [path: string, opacity: number])[] | JSXComponent;
  58. declare const IconValue: PropType<IconValue>;
  59. type VMessageSlot = {
  60. message: string;
  61. };
  62. interface VInputSlot {
  63. id: ComputedRef<string>;
  64. messagesId: ComputedRef<string>;
  65. isDirty: ComputedRef<boolean>;
  66. isDisabled: ComputedRef<boolean>;
  67. isReadonly: ComputedRef<boolean>;
  68. isPristine: Ref<boolean>;
  69. isValid: ComputedRef<boolean | null>;
  70. isValidating: Ref<boolean>;
  71. reset: () => void;
  72. resetValidation: () => void;
  73. validate: () => void;
  74. }
  75. type VInputSlots = {
  76. default: VInputSlot;
  77. prepend: VInputSlot;
  78. append: VInputSlot;
  79. details: VInputSlot;
  80. message: VMessageSlot;
  81. };
  82. declare const VInput: {
  83. new (...args: any[]): vue.CreateComponentPublicInstance<{
  84. error: boolean;
  85. direction: "horizontal" | "vertical";
  86. style: vue.StyleValue;
  87. disabled: boolean | null;
  88. readonly: boolean | null;
  89. messages: string | readonly string[];
  90. focused: boolean;
  91. errorMessages: string | readonly string[] | null;
  92. maxErrors: string | number;
  93. rules: readonly ValidationRule[];
  94. density: Density;
  95. centerAffix: boolean;
  96. hideSpinButtons: boolean;
  97. persistentHint: boolean;
  98. } & {
  99. name?: string | undefined;
  100. id?: string | undefined;
  101. width?: string | number | undefined;
  102. maxWidth?: string | number | undefined;
  103. minWidth?: string | number | undefined;
  104. label?: string | undefined;
  105. class?: any;
  106. theme?: string | undefined;
  107. 'onUpdate:focused'?: ((args_0: boolean) => void) | undefined;
  108. validateOn?: ("eager" | "lazy" | ("input" | "blur" | "submit" | "invalid-input") | "input lazy" | "blur lazy" | "submit lazy" | "invalid-input lazy" | "input eager" | "blur eager" | "submit eager" | "invalid-input eager" | "lazy input" | "lazy blur" | "lazy submit" | "lazy invalid-input" | "eager input" | "eager blur" | "eager submit" | "eager invalid-input") | undefined;
  109. validationValue?: any;
  110. prependIcon?: IconValue | undefined;
  111. appendIcon?: IconValue | undefined;
  112. 'onClick:append'?: ((args_0: MouseEvent) => void) | undefined;
  113. 'onClick:prepend'?: ((args_0: MouseEvent) => void) | undefined;
  114. hint?: string | undefined;
  115. hideDetails?: boolean | "auto" | undefined;
  116. } & {}, {
  117. reset: () => Promise<void>;
  118. resetValidation: () => Promise<void>;
  119. validate: (silent?: boolean) => Promise<string[]>;
  120. isValid: ComputedRef<boolean | null>;
  121. errorMessages: ComputedRef<string[]>;
  122. }, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Omit<{
  123. 'update:modelValue': (value: any) => true;
  124. }, "$children" | "v-slots" | "v-slot:default" | "modelValue" | "v-slot:prepend" | "v-slot:append" | "update:modelValue" | "v-slot:message" | "v-slot:details">, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
  125. error: boolean;
  126. direction: "horizontal" | "vertical";
  127. style: vue.StyleValue;
  128. disabled: boolean | null;
  129. readonly: boolean | null;
  130. messages: string | readonly string[];
  131. focused: boolean;
  132. errorMessages: string | readonly string[] | null;
  133. maxErrors: string | number;
  134. rules: readonly ValidationRule[];
  135. density: Density;
  136. centerAffix: boolean;
  137. hideSpinButtons: boolean;
  138. persistentHint: boolean;
  139. } & {
  140. name?: string | undefined;
  141. id?: string | undefined;
  142. width?: string | number | undefined;
  143. maxWidth?: string | number | undefined;
  144. minWidth?: string | number | undefined;
  145. label?: string | undefined;
  146. class?: any;
  147. theme?: string | undefined;
  148. 'onUpdate:focused'?: ((args_0: boolean) => void) | undefined;
  149. validateOn?: ("eager" | "lazy" | ("input" | "blur" | "submit" | "invalid-input") | "input lazy" | "blur lazy" | "submit lazy" | "invalid-input lazy" | "input eager" | "blur eager" | "submit eager" | "invalid-input eager" | "lazy input" | "lazy blur" | "lazy submit" | "lazy invalid-input" | "eager input" | "eager blur" | "eager submit" | "eager invalid-input") | undefined;
  150. validationValue?: any;
  151. prependIcon?: IconValue | undefined;
  152. appendIcon?: IconValue | undefined;
  153. 'onClick:append'?: ((args_0: MouseEvent) => void) | undefined;
  154. 'onClick:prepend'?: ((args_0: MouseEvent) => void) | undefined;
  155. hint?: string | undefined;
  156. hideDetails?: boolean | "auto" | undefined;
  157. } & {}, {
  158. error: boolean;
  159. direction: "horizontal" | "vertical";
  160. style: vue.StyleValue;
  161. disabled: boolean | null;
  162. readonly: boolean | null;
  163. messages: string | readonly string[];
  164. focused: boolean;
  165. errorMessages: string | readonly string[] | null;
  166. maxErrors: string | number;
  167. rules: readonly ValidationRule[];
  168. density: Density;
  169. centerAffix: boolean;
  170. hideSpinButtons: boolean;
  171. persistentHint: boolean;
  172. }, true, {}, vue.SlotsType<Partial<{
  173. default: (arg: VInputSlot) => vue.VNode[];
  174. prepend: (arg: VInputSlot) => vue.VNode[];
  175. append: (arg: VInputSlot) => vue.VNode[];
  176. details: (arg: VInputSlot) => vue.VNode[];
  177. message: (arg: VMessageSlot) => vue.VNode[];
  178. }>>, {
  179. P: {};
  180. B: {};
  181. D: {};
  182. C: {};
  183. M: {};
  184. Defaults: {};
  185. }, {
  186. error: boolean;
  187. direction: "horizontal" | "vertical";
  188. style: vue.StyleValue;
  189. disabled: boolean | null;
  190. readonly: boolean | null;
  191. messages: string | readonly string[];
  192. focused: boolean;
  193. errorMessages: string | readonly string[] | null;
  194. maxErrors: string | number;
  195. rules: readonly ValidationRule[];
  196. density: Density;
  197. centerAffix: boolean;
  198. hideSpinButtons: boolean;
  199. persistentHint: boolean;
  200. } & {
  201. name?: string | undefined;
  202. id?: string | undefined;
  203. width?: string | number | undefined;
  204. maxWidth?: string | number | undefined;
  205. minWidth?: string | number | undefined;
  206. label?: string | undefined;
  207. class?: any;
  208. theme?: string | undefined;
  209. 'onUpdate:focused'?: ((args_0: boolean) => void) | undefined;
  210. validateOn?: ("eager" | "lazy" | ("input" | "blur" | "submit" | "invalid-input") | "input lazy" | "blur lazy" | "submit lazy" | "invalid-input lazy" | "input eager" | "blur eager" | "submit eager" | "invalid-input eager" | "lazy input" | "lazy blur" | "lazy submit" | "lazy invalid-input" | "eager input" | "eager blur" | "eager submit" | "eager invalid-input") | undefined;
  211. validationValue?: any;
  212. prependIcon?: IconValue | undefined;
  213. appendIcon?: IconValue | undefined;
  214. 'onClick:append'?: ((args_0: MouseEvent) => void) | undefined;
  215. 'onClick:prepend'?: ((args_0: MouseEvent) => void) | undefined;
  216. hint?: string | undefined;
  217. hideDetails?: boolean | "auto" | undefined;
  218. } & {}, {
  219. reset: () => Promise<void>;
  220. resetValidation: () => Promise<void>;
  221. validate: (silent?: boolean) => Promise<string[]>;
  222. isValid: ComputedRef<boolean | null>;
  223. errorMessages: ComputedRef<string[]>;
  224. }, {}, {}, {}, {
  225. error: boolean;
  226. direction: "horizontal" | "vertical";
  227. style: vue.StyleValue;
  228. disabled: boolean | null;
  229. readonly: boolean | null;
  230. messages: string | readonly string[];
  231. focused: boolean;
  232. errorMessages: string | readonly string[] | null;
  233. maxErrors: string | number;
  234. rules: readonly ValidationRule[];
  235. density: Density;
  236. centerAffix: boolean;
  237. hideSpinButtons: boolean;
  238. persistentHint: boolean;
  239. }>;
  240. __isFragment?: never;
  241. __isTeleport?: never;
  242. __isSuspense?: never;
  243. } & vue.ComponentOptionsBase<{
  244. error: boolean;
  245. direction: "horizontal" | "vertical";
  246. style: vue.StyleValue;
  247. disabled: boolean | null;
  248. readonly: boolean | null;
  249. messages: string | readonly string[];
  250. focused: boolean;
  251. errorMessages: string | readonly string[] | null;
  252. maxErrors: string | number;
  253. rules: readonly ValidationRule[];
  254. density: Density;
  255. centerAffix: boolean;
  256. hideSpinButtons: boolean;
  257. persistentHint: boolean;
  258. } & {
  259. name?: string | undefined;
  260. id?: string | undefined;
  261. width?: string | number | undefined;
  262. maxWidth?: string | number | undefined;
  263. minWidth?: string | number | undefined;
  264. label?: string | undefined;
  265. class?: any;
  266. theme?: string | undefined;
  267. 'onUpdate:focused'?: ((args_0: boolean) => void) | undefined;
  268. validateOn?: ("eager" | "lazy" | ("input" | "blur" | "submit" | "invalid-input") | "input lazy" | "blur lazy" | "submit lazy" | "invalid-input lazy" | "input eager" | "blur eager" | "submit eager" | "invalid-input eager" | "lazy input" | "lazy blur" | "lazy submit" | "lazy invalid-input" | "eager input" | "eager blur" | "eager submit" | "eager invalid-input") | undefined;
  269. validationValue?: any;
  270. prependIcon?: IconValue | undefined;
  271. appendIcon?: IconValue | undefined;
  272. 'onClick:append'?: ((args_0: MouseEvent) => void) | undefined;
  273. 'onClick:prepend'?: ((args_0: MouseEvent) => void) | undefined;
  274. hint?: string | undefined;
  275. hideDetails?: boolean | "auto" | undefined;
  276. } & {}, {
  277. reset: () => Promise<void>;
  278. resetValidation: () => Promise<void>;
  279. validate: (silent?: boolean) => Promise<string[]>;
  280. isValid: ComputedRef<boolean | null>;
  281. errorMessages: ComputedRef<string[]>;
  282. }, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Omit<{
  283. 'update:modelValue': (value: any) => true;
  284. }, "$children" | "v-slots" | "v-slot:default" | "modelValue" | "v-slot:prepend" | "v-slot:append" | "update:modelValue" | "v-slot:message" | "v-slot:details">, string, {
  285. error: boolean;
  286. direction: "horizontal" | "vertical";
  287. style: vue.StyleValue;
  288. disabled: boolean | null;
  289. readonly: boolean | null;
  290. messages: string | readonly string[];
  291. focused: boolean;
  292. errorMessages: string | readonly string[] | null;
  293. maxErrors: string | number;
  294. rules: readonly ValidationRule[];
  295. density: Density;
  296. centerAffix: boolean;
  297. hideSpinButtons: boolean;
  298. persistentHint: boolean;
  299. }, {}, string, vue.SlotsType<Partial<{
  300. default: (arg: VInputSlot) => vue.VNode[];
  301. prepend: (arg: VInputSlot) => vue.VNode[];
  302. append: (arg: VInputSlot) => vue.VNode[];
  303. details: (arg: VInputSlot) => vue.VNode[];
  304. message: (arg: VMessageSlot) => vue.VNode[];
  305. }>>> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new <T>(props: {
  306. modelValue?: T | null;
  307. "onUpdate:modelValue"?: (value: T | null) => void;
  308. }, slots: VInputSlots) => GenericProps<typeof props, typeof slots>) & FilterPropsOptions<{
  309. focused: BooleanConstructor;
  310. 'onUpdate:focused': PropType<(args_0: boolean) => void>;
  311. disabled: {
  312. type: PropType<boolean | null>;
  313. default: null;
  314. };
  315. error: BooleanConstructor;
  316. errorMessages: {
  317. type: PropType<string | readonly string[] | null>;
  318. default: () => never[];
  319. };
  320. maxErrors: {
  321. type: (StringConstructor | NumberConstructor)[];
  322. default: number;
  323. };
  324. name: StringConstructor;
  325. label: StringConstructor;
  326. readonly: {
  327. type: PropType<boolean | null>;
  328. default: null;
  329. };
  330. rules: {
  331. type: PropType<readonly ValidationRule[]>;
  332. default: () => never[];
  333. };
  334. modelValue: null;
  335. validateOn: PropType<ValidationProps["validateOn"]>;
  336. validationValue: null;
  337. theme: StringConstructor;
  338. width: (StringConstructor | NumberConstructor)[];
  339. maxWidth: (StringConstructor | NumberConstructor)[];
  340. minWidth: (StringConstructor | NumberConstructor)[];
  341. density: {
  342. type: PropType<Density>;
  343. default: string;
  344. validator: (v: any) => boolean;
  345. };
  346. class: PropType<ClassValue>;
  347. style: {
  348. type: PropType<vue.StyleValue>;
  349. default: null;
  350. };
  351. id: StringConstructor;
  352. appendIcon: PropType<IconValue>;
  353. centerAffix: {
  354. type: BooleanConstructor;
  355. default: boolean;
  356. };
  357. prependIcon: PropType<IconValue>;
  358. hideDetails: PropType<boolean | "auto">;
  359. hideSpinButtons: BooleanConstructor;
  360. hint: StringConstructor;
  361. persistentHint: BooleanConstructor;
  362. messages: {
  363. type: PropType<string | readonly string[]>;
  364. default: () => never[];
  365. };
  366. direction: {
  367. type: PropType<"horizontal" | "vertical">;
  368. default: string;
  369. validator: (v: any) => boolean;
  370. };
  371. 'onClick:prepend': PropType<(args_0: MouseEvent) => void>;
  372. 'onClick:append': PropType<(args_0: MouseEvent) => void>;
  373. }, vue.ExtractPropTypes<{
  374. focused: BooleanConstructor;
  375. 'onUpdate:focused': PropType<(args_0: boolean) => void>;
  376. disabled: {
  377. type: PropType<boolean | null>;
  378. default: null;
  379. };
  380. error: BooleanConstructor;
  381. errorMessages: {
  382. type: PropType<string | readonly string[] | null>;
  383. default: () => never[];
  384. };
  385. maxErrors: {
  386. type: (StringConstructor | NumberConstructor)[];
  387. default: number;
  388. };
  389. name: StringConstructor;
  390. label: StringConstructor;
  391. readonly: {
  392. type: PropType<boolean | null>;
  393. default: null;
  394. };
  395. rules: {
  396. type: PropType<readonly ValidationRule[]>;
  397. default: () => never[];
  398. };
  399. modelValue: null;
  400. validateOn: PropType<ValidationProps["validateOn"]>;
  401. validationValue: null;
  402. theme: StringConstructor;
  403. width: (StringConstructor | NumberConstructor)[];
  404. maxWidth: (StringConstructor | NumberConstructor)[];
  405. minWidth: (StringConstructor | NumberConstructor)[];
  406. density: {
  407. type: PropType<Density>;
  408. default: string;
  409. validator: (v: any) => boolean;
  410. };
  411. class: PropType<ClassValue>;
  412. style: {
  413. type: PropType<vue.StyleValue>;
  414. default: null;
  415. };
  416. id: StringConstructor;
  417. appendIcon: PropType<IconValue>;
  418. centerAffix: {
  419. type: BooleanConstructor;
  420. default: boolean;
  421. };
  422. prependIcon: PropType<IconValue>;
  423. hideDetails: PropType<boolean | "auto">;
  424. hideSpinButtons: BooleanConstructor;
  425. hint: StringConstructor;
  426. persistentHint: BooleanConstructor;
  427. messages: {
  428. type: PropType<string | readonly string[]>;
  429. default: () => never[];
  430. };
  431. direction: {
  432. type: PropType<"horizontal" | "vertical">;
  433. default: string;
  434. validator: (v: any) => boolean;
  435. };
  436. 'onClick:prepend': PropType<(args_0: MouseEvent) => void>;
  437. 'onClick:append': PropType<(args_0: MouseEvent) => void>;
  438. }>>;
  439. type VInput = InstanceType<typeof VInput>;
  440. export { VInput };