@extclp/vexip-ui
Version:
A Vue 3 UI library, Highly customizability, full TypeScript, performance pretty good
44 lines (43 loc) • 2.27 kB
TypeScript
import { ExtractPropTypes, PropType } from 'vue';
import { ConfigurableProps } from '@vexip-ui/config';
import { TourSlots, TourStepOptions, TourStepRenderFn } from './symbol';
export declare const tourProps: {
inherit: PropType<boolean>;
locale: PropType<Partial<{
prev: string;
next: string;
done: string;
stepCount: string;
}>>;
active: PropType<boolean>;
index: PropType<number>;
steps: PropType<TourStepOptions[]>;
type: PropType<"default" | "success" | "error" | "warning" | "info" | "primary">;
hideMask: PropType<boolean>;
signType: PropType<"bar" | "count" | "dot">;
padding: PropType<number | number[]>;
closable: PropType<boolean>;
permeable: PropType<boolean>;
transfer: PropType<string | boolean>;
slots: PropType<TourSlots>;
onToggle: PropType<((active: boolean) => void) | ((active: boolean) => void)[]>;
onChange: PropType<((index: number, step: TourStepOptions) => void) | ((index: number, step: TourStepOptions) => void)[]>;
onClose: PropType<import('@vexip-ui/config').AnyFunction | import('@vexip-ui/config').AnyFunction[]>;
onMaskClick: PropType<((event: MouseEvent) => void) | ((event: MouseEvent) => void)[]>;
};
export type TourProps = ExtractPropTypes<typeof tourProps>;
export type TourCProps = ConfigurableProps<ExtractPropTypes<typeof tourProps>>;
export declare const tourStepProps: {
inherit: PropType<boolean>;
target: PropType<string | object | (() => any)>;
placement: PropType<"bottom" | "top" | "right" | "left" | "bottom-start" | "bottom-end" | "top-start" | "top-end" | "right-start" | "right-end" | "left-start" | "left-end">;
title: PropType<string>;
content: PropType<string>;
order: PropType<number>;
type: PropType<"default" | "success" | "error" | "warning" | "info" | "primary">;
renderer: PropType<TourStepRenderFn>;
onPrev: PropType<import('@vexip-ui/config').AnyFunction | import('@vexip-ui/config').AnyFunction[]>;
onNext: PropType<import('@vexip-ui/config').AnyFunction | import('@vexip-ui/config').AnyFunction[]>;
};
export type TourStepProps = ExtractPropTypes<typeof tourStepProps>;
export type TourStepCProps = ConfigurableProps<ExtractPropTypes<typeof tourStepProps>>;