forked from kirillzyusko/react-native-keyboard-controller
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtypes.ts
237 lines (230 loc) · 6.79 KB
/
types.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
import type { PropsWithChildren } from "react";
import type {
EmitterSubscription,
NativeSyntheticEvent,
TextInputProps,
ViewProps,
} from "react-native";
// DirectEventHandler events declaration
export type NativeEvent = {
progress: number;
height: number;
duration: number;
target: number;
};
export type FocusedInputLayoutChangedEvent = {
target: number;
parentScrollViewTarget: number;
layout: {
x: number;
y: number;
width: number;
height: number;
absoluteX: number;
absoluteY: number;
};
};
export type FocusedInputTextChangedEvent = {
text: string;
};
export type FocusedInputSelectionChangedEvent = {
target: number;
selection: {
start: {
x: number;
y: number;
position: number;
};
end: {
x: number;
y: number;
position: number;
};
};
};
export type EventWithName<T> = {
eventName: string;
} & T;
// native View/Module declarations
export type KeyboardControllerProps = {
//ref prop
ref?: React.Ref<React.Component<KeyboardControllerProps>>;
// callback props
onKeyboardMoveStart?: (
e: NativeSyntheticEvent<EventWithName<NativeEvent>>,
) => void;
onKeyboardMove?: (
e: NativeSyntheticEvent<EventWithName<NativeEvent>>,
) => void;
onKeyboardMoveEnd?: (
e: NativeSyntheticEvent<EventWithName<NativeEvent>>,
) => void;
onKeyboardMoveInteractive?: (
e: NativeSyntheticEvent<EventWithName<NativeEvent>>,
) => void;
onFocusedInputLayoutChanged?: (
e: NativeSyntheticEvent<EventWithName<FocusedInputLayoutChangedEvent>>,
) => void;
onFocusedInputTextChanged?: (
e: NativeSyntheticEvent<EventWithName<FocusedInputTextChangedEvent>>,
) => void;
onFocusedInputSelectionChanged?: (
e: NativeSyntheticEvent<EventWithName<FocusedInputSelectionChangedEvent>>,
) => void;
// fake props used to activate reanimated bindings
onKeyboardMoveReanimated?: (
e: NativeSyntheticEvent<EventWithName<NativeEvent>>,
) => void;
onFocusedInputLayoutChangedReanimated?: (
e: NativeSyntheticEvent<EventWithName<FocusedInputLayoutChangedEvent>>,
) => void;
onFocusedInputTextChangedReanimated?: (
e: NativeSyntheticEvent<EventWithName<FocusedInputTextChangedEvent>>,
) => void;
onFocusedInputSelectionChangedReanimated?: (
e: NativeSyntheticEvent<EventWithName<FocusedInputSelectionChangedEvent>>,
) => void;
// props
statusBarTranslucent?: boolean;
navigationBarTranslucent?: boolean;
enabled?: boolean;
} & ViewProps;
export type KeyboardGestureAreaProps = {
interpolator: "ios" | "linear";
/**
* Whether to allow to show a keyboard from dismissed state by swipe up.
* Default to `false`.
*/
showOnSwipeUp?: boolean;
/**
* Whether to allow to control a keyboard by gestures. The strategy how
* it should be controlled is determined by `interpolator` property.
* Defaults to `true`.
*/
enableSwipeToDismiss?: boolean;
/**
* Extra distance to the keyboard.
*/
offset?: number;
} & ViewProps;
export type OverKeyboardViewProps = PropsWithChildren<{
visible: boolean;
}>;
export type Direction = "next" | "prev" | "current";
export type DismissOptions = {
keepFocus: boolean;
};
export type KeyboardControllerModule = {
// android only
setDefaultMode: () => void;
setInputMode: (mode: number) => void;
// all platforms
dismiss: (options?: DismissOptions) => Promise<void>;
setFocusTo: (direction: Direction) => void;
isVisible: () => boolean;
state: () => KeyboardEventData | null;
};
export type KeyboardControllerNativeModule = {
// android only
setDefaultMode: () => void;
setInputMode: (mode: number) => void;
// all platforms
dismiss: (keepFocus: boolean) => void;
setFocusTo: (direction: Direction) => void;
// native event module stuff
addListener: (eventName: string) => void;
removeListeners: (count: number) => void;
};
// Event module declarations
export type KeyboardControllerEvents =
| "keyboardWillShow"
| "keyboardDidShow"
| "keyboardWillHide"
| "keyboardDidHide";
export type KeyboardEventData = {
height: number;
duration: number;
timestamp: number;
target: number;
type: NonNullable<TextInputProps["keyboardType"]>;
appearance: NonNullable<TextInputProps["keyboardAppearance"]>;
};
export type KeyboardEventsModule = {
addListener: (
name: KeyboardControllerEvents,
cb: (e: KeyboardEventData) => void,
) => EmitterSubscription;
};
export type FocusedInputAvailableEvents = "focusDidSet";
export type FocusedInputEventData = {
current: number;
count: number;
};
export type FocusedInputEventsModule = {
addListener: (
name: FocusedInputAvailableEvents,
cb: (e: FocusedInputEventData) => void,
) => EmitterSubscription;
};
export type WindowDimensionsAvailableEvents = "windowDidResize";
export type WindowDimensionsEventData = {
width: number;
height: number;
};
export type WindowDimensionsEventsModule = {
addListener: (
name: WindowDimensionsAvailableEvents,
cb: (e: WindowDimensionsEventData) => void,
) => EmitterSubscription;
};
// reanimated hook declaration
export type KeyboardHandlerHook<TContext, Event> = (
handlers: {
onKeyboardMoveStart?: (e: NativeEvent, context: TContext) => void;
onKeyboardMove?: (e: NativeEvent, context: TContext) => void;
onKeyboardMoveEnd?: (e: NativeEvent, context: TContext) => void;
onKeyboardMoveInteractive?: (e: NativeEvent, context: TContext) => void;
},
dependencies?: unknown[],
) => (e: NativeSyntheticEvent<Event>) => void;
export type FocusedInputLayoutHandlerHook<TContext, Event> = (
handlers: {
onFocusedInputLayoutChanged?: (
e: FocusedInputLayoutChangedEvent,
context: TContext,
) => void;
},
dependencies?: unknown[],
) => (e: NativeSyntheticEvent<Event>) => void;
export type FocusedInputTextHandlerHook<TContext, Event> = (
handlers: {
onFocusedInputTextChanged?: (
e: FocusedInputTextChangedEvent,
context: TContext,
) => void;
},
dependencies?: unknown[],
) => (e: NativeSyntheticEvent<Event>) => void;
export type FocusedInputSelectionHandlerHook<TContext, Event> = (
handlers: {
onFocusedInputSelectionChanged?: (
e: FocusedInputSelectionChangedEvent,
context: TContext,
) => void;
},
dependencies?: unknown[],
) => (e: NativeSyntheticEvent<Event>) => void;
// package types
export type Handlers<T> = Record<string, T | undefined>;
export type KeyboardHandler = Partial<{
onStart: (e: NativeEvent) => void;
onMove: (e: NativeEvent) => void;
onEnd: (e: NativeEvent) => void;
onInteractive: (e: NativeEvent) => void;
}>;
export type KeyboardHandlers = Handlers<KeyboardHandler>;
export type FocusedInputHandler = Partial<{
onChangeText: (e: FocusedInputTextChangedEvent) => void;
onSelectionChange: (e: FocusedInputSelectionChangedEvent) => void;
}>;
export type FocusedInputHandlers = Handlers<FocusedInputHandler>;