tour.d.ts 4.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. import type { CSSProperties, ExtractPropTypes } from 'vue';
  2. import type Tour from './tour.vue';
  3. import type { TourGap, TourMask } from './types';
  4. export declare const tourProps: {
  5. modelValue: BooleanConstructor;
  6. current: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
  7. showArrow: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
  8. showClose: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
  9. closeIcon: {
  10. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("vue").Component) & {}) | (() => string | import("vue").Component) | ((new (...args: any[]) => (string | import("vue").Component) & {}) | (() => string | import("vue").Component))[], unknown, unknown>>;
  11. readonly required: false;
  12. readonly validator: ((val: unknown) => boolean) | undefined;
  13. __epPropKey: true;
  14. };
  15. placement: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => "top" | "bottom" | "left" | "right" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => import("@floating-ui/core").Placement) | ((new (...args: any[]) => "top" | "bottom" | "left" | "right" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => import("@floating-ui/core").Placement))[], "top" | "bottom" | "left" | "right" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
  16. contentStyle: {
  17. readonly type: import("vue").PropType<CSSProperties>;
  18. readonly required: false;
  19. readonly validator: ((val: unknown) => boolean) | undefined;
  20. __epPropKey: true;
  21. };
  22. mask: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => boolean | {
  23. style?: CSSProperties;
  24. color?: string;
  25. }) | (() => TourMask) | ((new (...args: any[]) => boolean | {
  26. style?: CSSProperties;
  27. color?: string;
  28. }) | (() => TourMask))[], unknown, unknown, boolean, boolean>;
  29. gap: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TourGap) | (() => TourGap) | ((new (...args: any[]) => TourGap) | (() => TourGap))[], unknown, unknown, () => {
  30. offset: number;
  31. radius: number;
  32. }, boolean>;
  33. zIndex: {
  34. readonly type: import("vue").PropType<number>;
  35. readonly required: false;
  36. readonly validator: ((val: unknown) => boolean) | undefined;
  37. __epPropKey: true;
  38. };
  39. scrollIntoViewOptions: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => boolean | ScrollIntoViewOptions) | (() => boolean | ScrollIntoViewOptions) | ((new (...args: any[]) => boolean | ScrollIntoViewOptions) | (() => boolean | ScrollIntoViewOptions))[], unknown, unknown, () => {
  40. block: string;
  41. }, boolean>;
  42. type: {
  43. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => "default" | "primary") | (() => "default" | "primary") | ((new (...args: any[]) => "default" | "primary") | (() => "default" | "primary"))[], unknown, unknown>>;
  44. readonly required: false;
  45. readonly validator: ((val: unknown) => boolean) | undefined;
  46. __epPropKey: true;
  47. };
  48. appendTo: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => string | HTMLElement) | (() => import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement) | ((new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement))[], unknown, unknown>) | ((new (...args: any[]) => string | HTMLElement) | (() => import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement) | ((new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement))[], unknown, unknown>))[], unknown, unknown, string, boolean>;
  49. closeOnPressEscape: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
  50. targetAreaClickable: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
  51. };
  52. export type TourProps = ExtractPropTypes<typeof tourProps>;
  53. export type TourInstance = InstanceType<typeof Tour> & unknown;
  54. export declare const tourEmits: {
  55. "update:modelValue": (value: boolean) => boolean;
  56. "update:current": (current: number) => boolean;
  57. close: (current: number) => boolean;
  58. finish: () => boolean;
  59. change: (current: number) => boolean;
  60. };
  61. export type TourEmits = typeof tourEmits;