Skip to content

Commit d211e06

Browse files
committed
Format
1 parent 6dab801 commit d211e06

5 files changed

Lines changed: 534 additions & 505 deletions

File tree

src/Types.ts

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
import type { NanoPopPosition } from "nanopop";
1+
import type { NanoPopPosition } from 'nanopop';
22

33
/**
44
* Configuration for a single step in a tour
55
*/
66
export interface ITourStep {
77
/** CSS selector for the target element */
88
readonly target: string;
9-
9+
1010
/** HTML content to display in the tooltip */
1111
readonly content: string;
12-
12+
1313
/** Position of the tooltip relative to target (defaults to 'right') */
1414
readonly placement?: NanoPopPosition;
15-
15+
1616
/** Callback executed before showing this step */
1717
readonly onBefore?: () => Promise<void> | void;
18-
18+
1919
/** Callback executed after showing this step */
2020
readonly onAfter?: () => Promise<void> | void;
21-
21+
2222
/** Whether to highlight the target element for this step */
2323
readonly highlight?: boolean;
24-
24+
2525
/** Whether to show backdrop for this step */
2626
readonly backdrop?: boolean;
27-
27+
2828
/** Whether to disable auto-scrolling for this step */
2929
readonly noScroll?: boolean;
3030
}
3131

3232
/**
3333
* LocalStorage save strategy options
3434
*/
35-
export type SaveToLocalStorage = "never" | "step" | "end";
35+
export type SaveToLocalStorage = 'never' | 'step' | 'end';
3636

3737
/**
3838
* Button label configuration
@@ -50,40 +50,40 @@ export interface ButtonLabels {
5050
export interface VTourProps {
5151
/** Unique name for the tour (used for localStorage keys) */
5252
readonly name?: string;
53-
53+
5454
/** Array of tour steps */
5555
readonly steps: readonly ITourStep[];
56-
56+
5757
/** Whether to show backdrop by default */
5858
readonly backdrop?: boolean;
59-
59+
6060
/** Whether to automatically start the tour when component is mounted */
6161
readonly autoStart?: boolean;
62-
62+
6363
/** Delay in milliseconds before starting the tour */
6464
readonly startDelay?: number;
65-
65+
6666
/** Whether to highlight target elements by default */
6767
readonly highlight?: boolean;
68-
68+
6969
/** Margin in pixels around the tooltip */
7070
readonly margin?: number;
71-
71+
7272
/** Custom button labels */
7373
readonly buttonLabels?: Partial<ButtonLabels>;
74-
74+
7575
/** When to save tour progress to localStorage */
7676
readonly saveToLocalStorage?: SaveToLocalStorage;
77-
77+
7878
/** Whether to hide the skip button */
7979
readonly hideSkip?: boolean;
80-
80+
8181
/** Whether to hide the arrow pointing to target */
8282
readonly hideArrow?: boolean;
83-
83+
8484
/** Whether to disable auto-scrolling by default */
8585
readonly noScroll?: boolean;
86-
86+
8787
/** Debounce timeout for resize events in milliseconds */
8888
readonly resizeTimeout?: number;
8989
}
@@ -94,10 +94,10 @@ export interface VTourProps {
9494
export interface VTourEvents {
9595
/** Emitted when the tour starts */
9696
onTourStart: [];
97-
97+
9898
/** Emitted when the tour ends */
9999
onTourEnd: [];
100-
100+
101101
/** Emitted when a step is shown (with step index) */
102102
onTourStep: [step: number];
103103
}
@@ -125,35 +125,35 @@ export interface VTourData {
125125

126126
/**
127127
* Public API methods exposed by the VTour component
128-
*/
128+
*/
129129
export interface VTourExposedMethods {
130130
/** Start the tour */
131131
startTour: () => Promise<void>;
132-
132+
133133
/** Move to the next step */
134134
nextStep: () => Promise<void>;
135-
135+
136136
/** Move to the previous step */
137137
lastStep: () => Promise<void>;
138-
138+
139139
/** End the tour */
140140
endTour: () => void;
141-
141+
142142
/** Stop the tour without saving completion */
143143
stopTour: () => void;
144-
144+
145145
/** Navigate to a specific step by index */
146146
goToStep: (step: number) => Promise<void>;
147-
147+
148148
/** Reset tour state and optionally restart */
149149
resetTour: (restart?: boolean) => void;
150-
150+
151151
/** Update tooltip position */
152152
updatePosition: () => Promise<void>;
153-
153+
154154
/** Update element highlights */
155155
updateHighlight: () => void;
156-
156+
157157
/** Update backdrop visibility */
158158
updateBackdrop: () => void;
159159
}

0 commit comments

Comments
 (0)