@contegris/rn-intellicon-chat-sdk v1.0.1

rn-intellicon-chat-sdk

A React Native SDK for integrating chat functionality into your application.

Table of Contents

• Installation
• Usage
• Configuration
• Features
• Contributing
• License

Installation

To install the SDK, use either npm or yarn:

npm

npm install @contegris/rn-intellicon-chat-sdk react-native-document-picker

yarn

yarn add @contegris/rn-intellicon-chat-sdk react-native-document-picker

Usage

Here's a basic example of how to use the SDK in your React Native application:

import React    from "react";
import { Chat } from "@contegris/rn-intellicon-chat-sdk ";

const App = () => {
  return (
    <Chat
      user={ { name: "Participant Name", id: "Unique Identification" } }
      appId={ "YOUR CHAT BOT APP ID" }
      cloudServer={ "Your domain provided by Contegris" }
      backAction={ () => {
        // Define actions to take when user navigates back
      } }
    />
  );
};

export default App;

Configuration

To customize the chat experience, pass the necessary props to the Chat component:

• user: An object containing the user's name and unique ID.
• appId: Your Chat Bot application ID.
• cloudServer: The domain provided by Contegris.
• backAction: A function to define actions when the user navigates back.

Features

• Easy integration of chat functionality.
• Customizable user interface.
• Supports document picking with react-native-document-picker.

Contributing

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -am 'Add a new feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

This version provides a more professional layout, additional sections, and improved explanations to make it easier for users to understand and utilize the SDK.