-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
76 lines (67 loc) · 1.61 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// Options
export interface UseTypewriterOptions {
/**
* The amount of time|ms) between each character being typed out.
*
* @default 100
*/
typeInterval: number;
/**
* The amount of time|ms) between each character being deleted.
*
* @default 50
*/
deleteInterval: number;
/**
* The amount of time(ms) to hold on once the word has been typed out.
*
* @default 1000
*/
holdFor: number;
/**
* The amount of time(ms) to hold on once the word has been deleted.
*
* @default 200
*/
holdEmptyFor: number;
/**
* Whether or not to loop the typewriter after the last word has been typed out.
*
* @default true
*/
loop: boolean;
/**
* How many times to loop the typewriter. (0 = loop forever)
*
* @default 0
*/
iterations: number;
/**
* Whether or not to start the typewriter as an empty string.
* (if false, the typewriter will start with the first word in the array)
*
* @default false
*/
startEmpty: boolean;
/**
* Whether to start the typewriter paused and wait for it to be triggered.
* If true, the typewriter will not start until the `start` function is called
* If fasle, the typewriter will start immediately.
*
* @default false
*
*/
startPaused: boolean;
/**
* Should we finish at an emptry string? if false then finish with the last word typed out.
*
* @default false
*/
finishEmpty: boolean;
/**
* Whether or not to shuffle the words before for each iteration.
* (if true, the words will be shuffled before each iteration)
* @default false
*/
shuffle: boolean;
}