Skip to content
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.

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

#doc : Add missing documentation for enableUpload flag #39

Merged
merged 1 commit into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ TarkaChat.init({
themeColor: "#F0DAFB",
selectorId: "chatbot",
expand: true,
enableUpload: true,
preChatRenderer: function (onClose) {
// Return a DOM Node that can be attached to the chatbot UI
// Use the onClose callback to close the pre-chat screen
Expand All @@ -48,6 +49,7 @@ where,
- [Optional] **title** is the title of the chatbot window
- [Optional] **botName** will be displayed below each bot message
- [Optional] **expand** opens the chat window in expanded mode on init when set to true, otherwise opens in collapse mode. Defaults to false.
- [Optional] **enableUpload** will show the option to upload a file when set to true. False by default
- **greeting** will be the first message displayed on the chatbot when opened for the first time
- **themeColor** will set the color scheme of the chat window
- **selectorId** the DOM element selector (id) inside which the bot will be rendered
Expand Down Expand Up @@ -126,6 +128,10 @@ where,
Demo is deployed from the application code in `demo/` folder.
Link: https://tarkalabs.github.io/tarka-chat/demo/

## Dev notes

If you wanted to run this code in your local for development purposes, Run the following command from project root folder `yarn dev` and open `dev/index.html` in your browser to see the chat window. Your local changes will be hot reloaded

## Old versions

- v1.1 : https://d1fmfone96g0x2.cloudfront.net/tarka-chat-1.1.umd.js
Expand Down
1 change: 0 additions & 1 deletion dev/init.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ const chat = TarkaChat.init({
greeting: "Hello. How can I assist you today?",
themeColor: "#F0DAFB",
selectorId: "tarkachatbot",
enableUpload: true,
uploadTypes: UPLOAD_TYPES,
generateUploadPreview: generateImageThumbnail,
preChatRenderer: getPreChatScreen,
Expand Down