0.1.4 • Published 6 months ago
expo-gifted-chat v0.1.4
Attribution
This package is a fork of react-native-gifted-chat with the following key improvements:
- Removed unstable react-native-reanimated dependency for more reliable keyboard handling
- Replaced FlatList with FlashList for better performance
- Fixed Android keyboard issues including blank space problems
Key Changes
- Keyboard Handling: Removed react-native-reanimated dependency which was causing keyboard height calculation issues on Android
- Performance: Migrated from FlatList to FlashList for improved scrolling and rendering performance
- Bug Fixes: Resolved Android keyboard blank space issues
Performance Benefits
- Up to 5x faster list rendering with FlashList
- More reliable keyboard behavior on Android
- Reduced bundle size by removing reanimated dependency
Features
- Write with TypeScript
- Fully customizable components
- Composer actions (to attach photos, etc.)
- Load earlier messages
- Copy messages to clipboard
- Touchable links using react-native-parsed-text
- Avatar as user's initials
- Localized dates
- Multi-line TextInput
- InputToolbar avoiding keyboard
- Redux support
- System message
- Quick Reply messages (bot)
- Typing indicator
- Supports react-native-web
Getting started
Installation
Install dependencies
Yarn:
yarn add expo-gifted-chat react-native-keyboard-controller react-native-safe-area-context react-native-get-random-values
Npm:
npm install --save expo-gifted-chat react-native-keyboard-controller react-native-safe-area-context react-native-get-random-values
Expo
npx expo install expo-gifted-chat react-native-keyboard-controller react-native-safe-area-context react-native-get-random-values
Non-expo users
npx pod-install
Setup react-native-safe-area-context
Follow guide: react-native-safe-area-context
react-native-video and expo-av
- Both dependencies are removed since
0.11.0
. - You still be able to provide a
video
but you need to providerenderMessageVideo
prop.
Testing
TEST_ID
is exported as constants that can be used in your testing library of choice
Gifted Chat uses onLayout
to determine the height of the chat container. To trigger onLayout
during your tests, you can run the following bits of code.
const WIDTH = 200 // or any number
const HEIGHT = 2000 // or any number
const loadingWrapper = getByTestId(TEST_ID.LOADING_WRAPPER)
fireEvent(loadingWrapper, 'layout', {
nativeEvent: {
layout: {
width: WIDTH,
height: HEIGHT,
},
},
})
Example
import React, { useState, useCallback, useEffect } from 'react'
import { GiftedChat } from 'expo-gifted-chat'
export function Example() {
const [messages, setMessages] = useState([])
useEffect(() => {
setMessages([
{
_id: 1,
text: 'Hello developer',
createdAt: new Date(),
user: {
_id: 2,
name: 'React Native',
avatar: 'https://placeimg.com/140/140/any',
},
},
])
}, [])
const onSend = useCallback((messages = []) => {
setMessages((previousMessages) =>
GiftedChat.append(previousMessages, messages)
)
}, [])
return (
<GiftedChat
messages={messages}
onSend={(messages) => onSend(messages)}
user={{
_id: 1,
}}
/>
)
}
Message object
export interface IMessage {
_id: string | number
text: string
createdAt: Date | number
user: User
image?: string
video?: string
audio?: string
system?: boolean
sent?: boolean
received?: boolean
pending?: boolean
quickReplies?: QuickReplies
}
{
_id: 1,
text: 'My message',
createdAt: new Date(Date.UTC(2016, 5, 11, 17, 20, 0)),
user: {
_id: 2,
name: 'React Native',
avatar: 'https://facebook.github.io/react/img/logo_og.png',
},
image: 'https://facebook.github.io/react/img/logo_og.png',
// You can also add a video prop:
video: 'http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4',
// Mark the message as sent, using one tick
sent: true,
// Mark the message as received, using two tick
received: true,
// Mark the message as pending with a clock loader
pending: true,
// Any additional custom parameters are passed through
}
e.g. System Message
{
_id: 1,
text: 'This is a system message',
createdAt: new Date(Date.UTC(2016, 5, 11, 17, 20, 0)),
system: true,
// Any additional custom parameters are passed through
}
e.g. Chat Message with Quick Reply options
interface Reply {
title: string
value: string
messageId?: number | string
}
interface QuickReplies {
type: 'radio' | 'checkbox'
values: Reply[]
keepIt?: boolean
}
{
_id: 1,
text: 'This is a quick reply. Do you love Gifted Chat? (radio) KEEP IT',
createdAt: new Date(),
quickReplies: {
type: 'radio', // or 'checkbox',
keepIt: true,
values: [
{
title: '😋 Yes',
value: 'yes',
},
{
title: '📷 Yes, let me show you with a picture!',
value: 'yes_picture',
},
{
title: '😞 Nope. What?',
value: 'no',
},
],
},
user: {
_id: 2,
name: 'React Native',
},
},
{
_id: 2,
text: 'This is a quick reply. Do you love Gifted Chat? (checkbox)',
createdAt: new Date(),
quickReplies: {
type: 'checkbox', // or 'radio',
values: [
{
title: 'Yes',
value: 'yes',
},
{
title: 'Yes, let me show you with a picture!',
value: 'yes_picture',
},
{
title: 'Nope. What?',
value: 'no',
},
],
},
user: {
_id: 2,
name: 'React Native',
},
}
Props
messageContainerRef
(FlashList ref) - Ref to the flashListtextInputRef
(TextInput ref) - Ref to the text inputmessages
(Array) - Messages to displayisTyping
(Bool) - Typing Indicator state; defaultfalse
. If you userenderFooter
it will override this.text
(String) - Input text; default isundefined
, but if specified, it will override GiftedChat's internal state (e.g. for redux; see notes below)placeholder
(String) - Placeholder whentext
is empty; default is'Type a message...'
messageIdGenerator
(Function) - Generate an id for new messages. Defaults to UUID v4, generated by uuiduser
(Object) - User sending the messages:{ _id, name, avatar }
onSend
(Function) - Callback when sending a messagealwaysShowSend
(Bool) - Always show send button in input text composer; defaultfalse
, show only when text input is not emptylocale
(String) - Locale to localize the dates. You need first to import the locale you need (ie.require('dayjs/locale/de')
orimport 'dayjs/locale/fr'
)timeFormat
(String) - Format to use for rendering times; default is'LT'
(see Day.js Format)dateFormat
(String) - Format to use for rendering dates; default is'll'
(see Day.js Format)loadEarlier
(Bool) - Enables the "load earlier messages" button, required forinfiniteScroll
onLoadEarlier
(Function) - Callback when loading earlier messagesisLoadingEarlier
(Bool) - Display anActivityIndicator
when loading earlier messagesrenderLoading
(Function) - Render a loading view when initializingrenderLoadEarlier
(Function) - Custom "Load earlier messages" buttonrenderAvatar
(Function) - Custom message avatar; set tonull
to not render any avatar for the messageshowUserAvatar
(Bool) - Whether to render an avatar for the current user; default isfalse
, only show avatars for other usersshowAvatarForEveryMessage
(Bool) - When false, avatars will only be displayed when a consecutive message is from the same user on the same day; default isfalse
onPressAvatar
(Function(user
)) - Callback when a message avatar is tappedonLongPressAvatar
(Function(user
)) - Callback when a message avatar is long-pressedrenderAvatarOnTop
(Bool) - Render the message avatar at the top of consecutive messages, rather than the bottom; default isfalse
renderBubble
(Function) - Custom message bubblerenderTicks
(Function(message
)) - Custom ticks indicator to display message statusrenderSystemMessage
(Function) - Custom system messageonPress
(Function(context
,message
)) - Callback when a message bubble is pressedonLongPress
(Function(context
,message
)) - Callback when a message bubble is long-pressedinverted
(Bool) - Reverses display order ofmessages
; default istrue
renderUsernameOnMessage
(Bool) - Indicate whether to show the user's username inside the message bubble; default isfalse
renderUsername
(Function) - Custom Username containerrenderMessage
(Function) - Custom message containerrenderMessageText
(Function) - Custom message textrenderMessageImage
(Function) - Custom message imagerenderMessageVideo
(Function) - Custom message videoimageProps
(Object) - Extra props to be passed to the<Image>
component created by the defaultrenderMessageImage
videoProps
(Object) - Extra props to be passed to the video component created by the requiredrenderMessageVideo
lightboxProps
(Object) - Extra props to be passed to theMessageImage
's LightboxisCustomViewBottom
(Bool) - Determine whether renderCustomView is displayed before or after the text, image and video views; default isfalse
renderCustomView
(Function) - Custom view inside the bubblerenderDay
(Function) - Custom day above a messagerenderTime
(Function) - Custom time inside a messagerenderFooter
(Function) - Custom footer component on the ListView, e.g.'User is typing...'
; see App.tsx for an example. Overrides default typing indicator that triggers whenisTyping
is true.renderChatEmpty
(Function) - Custom component to render in the ListView when messages are emptyrenderChatFooter
(Function) - Custom component to render below the MessageContainer (separate from the ListView)renderInputToolbar
(Function) - Custom message composer containerrenderComposer
(Function) - Custom text input message composerrenderActions
(Function) - Custom action button on the left of the message composerrenderSend
(Function) - Custom send button; you can pass children to the originalSend
component quite easily, for example, to use a custom iconrenderAccessory
(Function) - Custom second line of actions below the message composeronPressActionButton
(Function) - Callback when the Action button is pressed (if set, the defaultactionSheet
will not be used)bottomOffset
(Integer) - Distance of the chat from the bottom of the screen (e.g. useful if you display a tab bar)minInputToolbarHeight
(Integer) - Minimum height of the input toolbar; default is44
listViewProps
(Object) - Extra props to be passed to the messages<ListView>
; some props can't be overridden, see the code inMessageContainer.render()
for detailstextInputProps
(Object) - Extra props to be passed to the<TextInput>
textInputStyle
(Object) - Custom style to be passed to the<TextInput>
multiline
(Bool) - Indicates whether to allow the<TextInput>
to be multiple lines or not; defaulttrue
.keyboardShouldPersistTaps
(Enum) - Determines whether the keyboard should stay visible after a tap; see<ScrollView>
docsonInputTextChanged
(Function) - Callback when the input text changesmaxInputLength
(Integer) - Max message composer TextInput lengthparsePatterns
(Function) - Custom parse patterns for react-native-parsed-text used to linking message content (like URLs and phone numbers), e.g.:
<GiftedChat
parsePatterns={(linkStyle) => [
{ type: 'phone', style: linkStyle, onPress: this.onPressPhoneNumber },
{ pattern: /#(\w+)/, style: { ...linkStyle, styles.hashtag }, onPress: this.onPressHashtag },
]}
/>
extraData
(Object) - Extra props for re-rendering FlashList on demand. This will be useful for rendering footer etc.minComposerHeight
(Object) - Custom min-height of the composer.maxComposerHeight
(Object) - Custom max height of the composer.
scrollToBottom
(Bool) - Enables the scroll to bottom Component (Default is false)scrollToBottomComponent
(Function) - Custom Scroll To Bottom Component containerscrollToBottomOffset
(Integer) - Custom Height Offset upon which to begin showing Scroll To Bottom Component (Default is 200)scrollToBottomStyle
(Object) - Custom style for Bottom Component containeralignTop
(Boolean) Controls whether or not the message bubbles appear at the top of the chat (Default is false - bubbles align to bottom)onQuickReply
(Function) - Callback when sending a quick reply (to backend server)renderQuickReplies
(Function) - Custom all quick reply viewquickReplyStyle
(StyleProp) - Custom quick reply view stylerenderQuickReplySend
(Function) - Custom quick reply send viewshouldUpdateMessage
(Function) - Lets the message component know when to update outside of normal cases.infiniteScroll
(Bool) - infinite scroll up when reach the top of messages container, automatically call onLoadEarlier function if exist (not yet supported for the web). You need to addloadEarlier
prop too.isStatusBarTranslucentAndroid
(Bool) - If you use translucent status bar on Android, set this option to true. Ignored on iOS.