Skip to content

[connectReactNativeChat] docs: update components documentation #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[connectReactNativeChat] docs: update components documentation #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions mobileChatExamples/connectReactNativeChat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,21 @@ Please refer to the ChatJS README: https://github.com/amazon-connect/amazon-conn

## Components

ChatScreen includes these main components:
The demo app uses these main components:

- `initiateChat.js`: handles HTTP request to your personal chat backend
- `ChatSession.js`: low-level abstraction on top of ChatJS
- `ChatWrapper.js`: manages chat state at the UI level, handling loading/disconnect
- `ChatWidget.js`: renders chat composer and transcript
- `ChatUI.js`: layout component that renders GiftedChatUI component
- `ChatContext.js`: a context hook managing all ChatJS business logic and state

```tree
App.js
└── ChatUIWrapper (src/ChatUI.js)
└── ChatProvider (Context Provider from src/ChatContext.js)
└── ChatUI (Main UI Component)
├── Header Section
│ ├── Title
│ └── Button (Launch Chat/End Chat)
└── GiftedChat (Chat UI from react-native-gifted-chat)
```

## Additional Features

Expand Down