-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathinterfaces.ts
67 lines (64 loc) · 1.29 KB
/
interfaces.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
export interface Focus {
x: number;
y: number;
}
/**
* @param {Focus} focusCoordinates
* @returns {void}
*/
export type OnFocusChange = (focusCoordinates: {
x: number;
y: number;
}) => void;
export interface FocusPickerOptions {
/**
* Callback that receives FocusCoordinates on change
*/
onChange?: OnFocusChange;
/**
* Focus to initialize with
*/
focus?: Focus;
/**
* src attribute for the retina
*/
retina?: string;
}
export interface FocusedImageOptions {
/**
* Time in MS before debounceApplyShift fires
*
* Defaults to `17`
*/
debounceTime?: number;
/**
* Should window resize events fire debounceApplyShift?
*
* Defaults to `true`
*/
updateOnWindowResize?: boolean;
/**
* Should container resize (even from CSS) fire debounceApplyShift?
*
* Defaults to `false`
*/
updateOnContainerResize?: boolean;
/**
* Focus coordinates to initialize with
*
* Default value is `undefined`
*/
focus?: Focus;
/**
* Container position
*
* Default value is "relative"
*/
containerPosition?: 'fixed' | 'relative' | 'absolute' | 'sticky';
/**
* Focus image container
*
* Default value is `undefined`, and code will fall back to `FocusedImage::imageNode.parentElement`
*/
container?: HTMLElement;
}