Skip to content

Commit

Permalink
chore: Update README with new props (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrderyk authored Feb 24, 2024
1 parent 5329303 commit 4b43380
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ import { ReactChatbot } from "@vectara/react-chatbot";
apiKey="API_KEY"
title="My Chatbot"
placeholder="Chat with your AI assistant"
inputSize="large"
emptyStateDisplay={<MyEmptyStateDisplayComponent />}
isOpened={false}
isInitiallyOpen={false}
/>;
```

Expand Down Expand Up @@ -75,9 +76,13 @@ Configure the placeholder text in the chatbot's input.

Configure JSX content to render in the messages window when there are no messages to display.

#### `isOpened` (optional)
#### `isInitiallyOpen` (optional)

Configure initial open/closed state of the the chatbot component.
Set the chat window to be opened on initial render.

#### `inputSize` (optional)

Used to control the size of the input - either "large" (18px) or "medium" (14px)

### Set up your data

Expand Down
4 changes: 0 additions & 4 deletions docs/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,6 @@ const App = () => {

<VuiSpacer size="m" />

<VuiText>
<p>Looking for it? It's in the lower-right corner of the screen. 😃</p>
</VuiText>

{/**
* Here we ensure that if the field is blank, we use the default props that point to the docs page.
* This ensures that we don't voluntarily display the docs corpus details in the text fields.
Expand Down

0 comments on commit 4b43380

Please sign in to comment.