forked from FaridSafi/react-native-gifted-chat
-
Notifications
You must be signed in to change notification settings - Fork 59
/
index.d.ts
384 lines (344 loc) · 13.7 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
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
import * as React from 'react';
import * as RN from 'react-native';
type ViewStyle = RN.StyleProp<RN.ViewStyle>;
type TextStyle = RN.StyleProp<RN.TextStyle>;
type ImageStyle = RN.StyleProp<RN.ImageStyle>;
export interface LeftRightStyle<T> {
left: T;
right: T;
}
export interface User {
id: any;
name?: string;
avatar?: string;
}
export interface IMessage {
id: any;
text: string;
createdAt: Date;
user: User;
image?: string;
system?: boolean;
}
export type IChatMessage = IMessage
interface ActionsProps {
// todo: onSend is not used
onSend?(): void;
options?: any;
optionTintColor?: string;
icon?(): void;
wrapperStyle?: ViewStyle;
containerStyle?: ViewStyle;
iconTextStyle?: ViewStyle;
onPressActionButton(): void;
}
export class Actions extends React.Component<ActionsProps> { }
interface AvatarProps<TMessage extends IMessage = IMessage> {
renderAvatarOnTop: boolean;
position: "left" | "right";
currentMessage: TMessage;
previousMessage: TMessage;
nextMessage: TMessage;
onPressAvatar(): void;
renderAvatar(props: AvatarProps<TMessage>): JSX.Element;
containerStyle: {
left: any;
right: any;
};
imageStyle: {
left: any;
right: any;
};
// TODO: remove in next major release
isSameDay(currentMessage: TMessage, message: TMessage): boolean;
isSameUser(currentMessage: TMessage, message: TMessage): boolean;
}
export class Avatar extends React.Component<AvatarProps> { }
interface BubbleProps<TMessage extends IMessage = IMessage> {
user: User;
touchableProps?: object;
onLongPress?(context?: any, message?: any): void;
renderMessageImage?(messageImageProps: RenderMessageImageProps): React.ReactNode;
renderMessageText?(messageTextProps: MessageTextProps): React.ReactNode;
renderCustomView?(bubbleProps: BubbleProps): React.ReactNode;
renderTime?(timeProps: TimeProps): React.ReactNode;
renderTicks?(currentMessage: TMessage): React.ReactNode;
renderUsername?(): React.ReactNode;
renderUsernameOnMessage?: boolean
position?: "left" | "right";
currentMessage?: TMessage;
nextMessage?: TMessage;
previousMessage?: TMessage;
containerStyle?: LeftRightStyle<ViewStyle>;
wrapperStyle: LeftRightStyle<ViewStyle>;
bottomContainerStyle: LeftRightStyle<ViewStyle>;
tickStyle: TextStyle;
containerToNextStyle: LeftRightStyle<ViewStyle>;
containerToPreviousStyle: LeftRightStyle<ViewStyle>;
// TODO: remove in next major release
isSameDay?(currentMessage: TMessage, nextMessage: TMessage): boolean;
isSameUser?(currentMessage: TMessage, nextMessage: TMessage): boolean;
}
export class Bubble extends React.Component<BubbleProps> { }
interface ComposerProps {
composerHeight?: number;
text?: string;
placeholder?: string;
placeholderTextColor?: string;
textInputProps?: Partial<RN.TextInputProps>;
onTextChanged?(text: string): void;
onInputSizeChanged?(contentSize: number): void;
multiline?: boolean;
textInputStyle?: RN.TextInputProps["style"];
textInputAutoFocus?: boolean;
keyboardAppearance: RN.TextInputProps["keyboardAppearance"];
}
export class Composer extends React.Component<ComposerProps> { }
interface DayProps<TMessage extends IMessage = IMessage> {
currentMessage?: TMessage;
previousMessage?: TMessage;
containerStyle?: ViewStyle;
wrapperStyle?: ViewStyle;
textStyle?: TextStyle;
// TODO: remove in next major release
isSameDay?(currentMessage: TMessage, nextMessage: TMessage): boolean;
isSameUser?(currentMessage: TMessage, nextMessage: TMessage): boolean;
dateFormat?: string;
}
export class Day extends React.Component<DayProps> { }
interface GiftedAvatarProps {
user?: User;
onPress?(): void;
avatarStyle?: ImageStyle;
textStyle?: TextStyle;
}
export class GiftedAvatar extends React.Component<GiftedAvatarProps> { }
export interface GiftedChatProps<TMessage extends IMessage = IMessage> {
/* Messages to display */
messages?: TMessage[];
/* Input text; default is undefined, but if specified, it will override GiftedChat's internal state */
text?: string;
/* Placeholder when text is empty; default is 'Type a message...' */
placeholder?: string;
/* Generate an id for new messages. Defaults to UUID v4, generated by uuid */
messageIdGenerator?(message: TMessage): string;
/* User sending the messages: { id, name, avatar } */
user?: User;
/* Callback when sending a message */
onSend?(messages: TMessage[]): void;
/* Locale to localize the dates */
locale?: string;
/* Format to use for rendering times; default is 'LT' */
timeFormat?: string;
/* Format to use for rendering dates; default is 'll' */
dateFormat?: string;
/* Animates the view when the keyboard appears */
isAnimated?: boolean;
/* Enables the "Load earlier messages" button */
loadEarlier?: boolean;
/*Callback when loading earlier messages*/
onLoadEarlier?(): void;
/*Display an ActivityIndicator when loading earlier messages*/
isLoadingEarlier?: boolean;
/* Render a loading view when initializing */
renderLoading?(): React.ReactNode;
/* Custom "Load earlier messages" button */
renderLoadEarlier?(props: LoadEarlierProps): React.ReactNode;
/* Custom message avatar; set to null to not render any avatar for the message */
renderAvatar?(props: AvatarProps): React.ReactNode;
/* Whether to render an avatar for the current user; default is false, only show avatars for other users */
showUserAvatar?: boolean;
/* When false, avatars will only be displayed when a consecutive message is from the same user on the same day; default is false */
showAvatarForEveryMessage?: boolean;
/* Callback when a message avatar is tapped */
onPressAvatar?(user: User): void;
/* Render the message avatar at the top of consecutive messages, rather than the bottom; default is false */
renderAvatarOnTop?: boolean;
/* Custom message bubble */
renderBubble?(props: BubbleProps): React.ReactNode;
/*Custom system message */
renderSystemMessage?(props: SystemMessageProps): React.ReactNode;
/* Callback when a message bubble is long-pressed; default is to show an ActionSheet with "Copy Text" (see example using showActionSheetWithOptions()) */
onLongPress?(context: any, message: any): void;
/* Reverses display order of messages; default is true */
inverted?: boolean;
/*Custom message container */
renderMessage?(message: MessageProps): React.ReactNode;
/* Custom message text */
renderMessageText?(messageText: MessageTextProps): React.ReactNode;
/* Custom message image */
renderMessageImage?(props: RenderMessageImageProps): React.ReactNode;
/* Extra props to be passed to the <Image> component created by the default renderMessageImage */
imageProps?: MessageProps;
/*Extra props to be passed to the MessageImage's Lightbox */
lightboxProps?: any;
/* Custom view inside the bubble */
renderCustomView?(): React.ReactNode;
/*Custom day above a message*/
renderDay?(props: DayProps): React.ReactNode;
/* Custom time inside a message */
renderTime?(props: TimeProps): React.ReactNode;
/* Custom footer component on the ListView, e.g. 'User is typing...' */
renderFooter?(): React.ReactNode;
/* Custom component to render below the MessageContainer (separate from the ListView) */
renderChatFooter?(): React.ReactNode;
/* Custom message composer container */
renderInputToolbar?(props: InputToolbarProps): React.ReactNode;
/* Custom text input message composer */
renderComposer?(props: ComposerProps): React.ReactNode;
/* Custom action button on the left of the message composer */
renderActions?(props: ActionsProps): React.ReactNode;
/* Custom send button; you can pass children to the original Send component quite easily, for example to use a custom icon (example) */
renderSend?(props: SendProps): React.ReactNode;
/*Custom second line of actions below the message composer */
renderAccessory?(props: InputToolbarProps): React.ReactNode;
/*Callback when the Action button is pressed (if set, the default actionSheet will not be used) */
onPressActionButton?(): void;
/*Distance of the chat from the bottom of the screen (e.g. useful if you display a tab bar) */
bottomOffset?: number;
/* Minimum height of the input toolbar; default is 44 */
minInputToolbarHeight?: number;
/*Extra props to be passed to the messages <ListView>; some props can't be overridden, see the code in MessageContainer.render() for details */
listViewProps?: any;
/* Extra props to be passed to the <TextInput> */
textInputProps?: any;
/*Determines whether the keyboard should stay visible after a tap; see <ScrollView> docs */
keyboardShouldPersistTaps?: any;
/* Callback when the input text changes */
onInputTextChanged?(text: string): void;
/*Max message composer TextInput length */
maxInputLength?: number;
/* Custom parse patterns for react-native-parsed-text used to linkify message content (like URLs and phone numbers) */
parsePatterns?(): React.ReactNode;
/* Force getting keyboard height to fix some display issues */
forceGetKeyboardHeight?: boolean;
/* Force send button */
alwaysShowSend?: boolean;
/* Image style */
imageStyle?: ViewStyle
/* This can be used to pass any data which needs to be re-rendered */
extraData?: any;
/* composer min Height */
minComposerHeight?: number;
/* composer min Height */
maxComposerHeight?: number;
}
export class GiftedChat extends React.Component<GiftedChatProps> {
static defaultProps: GiftedChatProps;
static append<TMessage extends IMessage = IMessage>(
currentMessages: TMessage[],
messages: TMessage[],
inverted?: boolean
): TMessage[];
static prepend<TMessage extends IMessage = IMessage>(
currentMessages: TMessage[],
messages: TMessage[],
inverted?: boolean
): TMessage[];
}
interface InputToolbarProps {
renderAccessory?(props: InputToolbarProps): React.ReactNode;
renderActions?(props: ActionsProps): React.ReactNode;
renderSend?(props: SendProps): React.ReactNode;
renderComposer?(props: ComposerProps): React.ReactNode;
onPressActionButton?(): void;
containerStyle?: ViewStyle;
primaryStyle?: ViewStyle;
accessoryStyle?: ViewStyle;
}
export class InputToolbar extends React.Component<InputToolbarProps> { }
interface LoadEarlierProps {
onLoadEarlier?(): void;
isLoadingEarlier: boolean;
label?: string;
containerStyle?: ViewStyle;
wrapperStyle?: ViewStyle;
textStyle?: TextStyle;
activityIndicatorStyle?: ViewStyle;
}
export class LoadEarlier extends React.Component<LoadEarlierProps> { }
interface MessageProps<TMessage extends IMessage = IMessage> {
// TODO: this is not used
renderAvatar(props: AvatarProps): React.ReactNode;
showUserAvatar?: boolean;
renderBubble(props: BubbleProps): React.ReactNode;
renderDay(props: DayProps): React.ReactNode;
renderSystemMessage(props: SystemMessageProps): React.ReactNode;
position?: "left" | "right";
currentMessage?: TMessage;
nextMessage?: TMessage;
previousMessage?: TMessage;
user?: User;
inverted?: boolean;
containerStyle: LeftRightStyle<ViewStyle>;
}
export class Message extends React.Component<MessageProps> { }
interface MessageContainerProps<TMessage extends IMessage = IMessage> {
messages?: TMessage[];
user?: User;
renderFooter?(props: MessageContainerProps): React.ReactNode;
renderMessage?(props: MessageProps): React.ReactNode;
renderLoadEarlier?(props: LoadEarlierProps): React.ReactNode;
// todo: not used
onLoadEarlier?(): void;
listViewProps: Partial<RN.ListViewProps>;
inverted?: boolean;
loadEarlier?: boolean;
// todo: should be InvertibleScrollView props
invertibleScrollViewProps?: object;
}
export class MessageContainer extends React.Component<MessageContainerProps> { }
interface MessageImageProps<TMessage extends IMessage = IMessage> {
currentMessage?: TMessage;
containerStyle?: ViewStyle;
imageStyle?: ImageStyle;
imageProps?: Partial<RN.ImageProps>;
// todo: should be LightBox properties
lightboxProps?: object;
}
export class MessageImage extends React.Component<MessageImageProps> { }
export type RenderMessageImageProps<TMessage extends IMessage = IMessage> =
MessageImageProps<TMessage> & Exclude<BubbleProps<TMessage>, 'wrapperStyle' | 'containerStyle'>
interface MessageTextProps<TMessage extends IMessage = IMessage> {
position: "left" | "right";
currentMessage?: TMessage;
containerStyle?: LeftRightStyle<ViewStyle>;
textStyle?: LeftRightStyle<TextStyle>;
linkStyle?: LeftRightStyle<TextStyle>;
parsePatterns?(linkStyle: TextStyle): any;
textProps?: RN.TextProps;
customTextStyle?: TextStyle;
}
export class MessageText extends React.Component<MessageTextProps> { }
export type RenderMessageTextProps<TMessage extends IMessage = IMessage> =
MessageTextProps<TMessage> & Exclude<BubbleProps<TMessage>, 'wrapperStyle' | 'containerStyle'>
interface SendProps {
text?: string;
onSend?({ text }: { text: string }, b: boolean): void;
label?: string;
containerStyle?: ViewStyle;
textStyle?: TextStyle;
children?: React.ReactNode;
}
export class Send extends React.Component<SendProps> { }
interface SystemMessageProps<TMessage extends IMessage = IMessage> {
currentMessage?: TMessage;
containerStyle?: ViewStyle;
wrapperStyle?: ViewStyle;
textStyle?: TextStyle;
}
export class SystemMessage extends React.Component<SystemMessageProps> { }
interface TimeProps<TMessage extends IMessage = IMessage> {
position?: "left" | "right";
currentMessage?: TMessage;
containerStyle?: LeftRightStyle<ViewStyle>;
textStyle?: LeftRightStyle<TextStyle>;
timeFormat?: string;
}
export class Time extends React.Component<TimeProps> { }
export type utils<TMessage extends IMessage = IMessage> = {
isSameUser(currentMessage?: TMessage, message?: TMessage): boolean;
isSameDay(currentMessage?: TMessage, message?: TMessage): boolean;
isSameTime(currentMessage?: TMessage, message?: TMessage): boolean;
};
export const utils: utils;