1.0.0 • Published 12 months ago

react-native-chat-bubble v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

React Native Chat Bubble

React Native Chat bubble is a simple lightweight component for your React Native Applications which uses react-native-svg and react-native-size-matters to create a highly customizable chat bubble for you with curved tail or without.

Installation

react-native-chat-bubble has two peer dependencies:

react-native-svg and react-native-size-matters

You must install these alongside react-native-chat-bubble.

Install the package using npm or yarn:

npm install react-native-chat-bubble react-native-svg react-native-size-matters
yarn add react-native-chat-bubble react-native-svg react-native-size-matters

If you're using Expo, make sure to use the expo install command to install these packages to ensure compatibility with your Expo SDK version:

expo install react-native-chat-bubble
expo install react-native-svg
expo install react-native-size-matters

Usage

import ChatBubble from 'react-native-chat-bubble';

<ChatBubble
  isOwnMessage={true}
  bubbleColor='#1084ff'
  tailColor='#1084ff'
  withTail={true}
  onPress={() => console.log("Bubble Pressed!")}
>
  <Text>Your message content</Text>
</ChatBubble>

Check the example

Props

The SwipeableFlatList component accepts the following props:

ViewProps:

If you don't pass onPress function, the chat bubble wrapper will be a View from react-native and you can also pass the rest of the ViewProps, which you can check here

PressableProps

If you pass the onPress function, the package will wrap the ChatBubble in Pressable from react-native to call your function when the user presses the message, so you can also pass the rest of the PressableProps, which you can check here

isOwnMessage: boolean

Prop to identify the message and therefore the alignment.

children: ReactNode

The message content.

bubbleColor: string

Color of your chat bubble. Defaults to #1084ff for own messages and grey for others.

tailColor: string

Color of the tail of the chat bubble. If you pass a bubbleColor prop and your tail and the bubble are the same color, you don't need to use this prop, they'll match automatically.

withTail: boolean

Prop which defines if the tail is displayed with your message. Defaults to true.

withTail: boolean

Prop which defines if the tail is displayed with your message. Defaults to true.

hitSlop:({top: number, bottom: number, left: number, right: number})

increase the touchable area of the chat bubble.

maxWidth:number

Maximum width of your chat bubble. When adjusting maxWidth this prop should be used instead of a style override, in order to use moderateScale. Defaults to 250

style: StyleProp<ViewStyle>

Additional styles or style overrides for the chat bubble.

License

This project is licensed under the MIT License.

Dependencies

react-native-chat-bubble has a peer dependency on react-native-svg and react-native-size-matters. It will be installed automatically when you install this package. However, please ensure that your project meets the requirements for both of these libraries.

example

import React from 'react';
import { Alert, Image, StyleSheet, Text, View } from 'react-native';
import ChatBubble from "react-native-chat-bubble";

const App: React.FC = () => {

  return (
    <View style={styles.container}>
      <ChatBubble
        isOwnMessage={true}
        bubbleColor="#1084ff"
        tailColor="#1084ff"
        withTail={true}
        style={styles.chatBubble}
      >
        <Text style={styles.textOwn}>Lorem ipsum dolor sit amet consectetur adipisicing elit. Quas atque repudiandae alias nisi aut? Ut perferendis similique non vel! Blanditiis nihil enim culpa ex numquam commodi saepe? Non, ex recusandae.</Text>
      </ChatBubble>
      <ChatBubble
       onPress={() => Alert.alert("Hi", "This is alert")}
        isOwnMessage={false}
        bubbleColor="lightgrey"
        withTail={true}
        style={styles.chatBubble}
      >
        <Text style={styles.text}>hi.</Text>
      </ChatBubble>
      <ChatBubble
        isOwnMessage={true}
        bubbleColor="#1084ff"
        tailColor="#1084ff"
        withTail={true}
        style={styles.chatBubble}
      >
        <Text  style={styles.textOwn}>Lorem ipsum dolor sit amet consectetur adipisicing elit. Quas atque repudiandae alias nisi aut? Ut perferendis similique non vel! Blanditiis nihil enim culpa ex numquam commodi saepe? Non, ex recusandae.</Text>
      </ChatBubble>
      <ChatBubble
        isOwnMessage={true}
        bubbleColor="#1084ff"
        tailColor="#1084ff"
        withTail={true}
        style={styles.chatBubble}
      >
        <Image style={{height:100, width:100}} 
        resizeMode="contain" 
        resizeMethod="resize"  
        source={{uri: "https://raw.githubusercontent.com/GFean/rn-gesture-swipeable-flatlist-example/main/assets/favicon.png"}}/>
      </ChatBubble>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
   marginTop:100,
    flex: 1,
   paddingHorizontal:10
  },
  chatBubble: {
    padding: 10,
  },
  text: {
    color: 'black',
  },
  textOwn: {
   color: 'white',
 },
});

export default App