Skip to content

Commit

Permalink
update readme for tailwind styling (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
yen-tt authored Oct 19, 2023
1 parent 93dba26 commit 5e7cd0e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,14 @@ export default App;

### default styling

By default, the component library uses Tailwind styling. However, for projects that
do not use Tailwind, a css bundle is exported as part of this package. To use it, you can import
#### Tailwind
The component library utilizes Tailwind styling by default. Please make sure that your application's tailwind configuration includes the following:
- The `content` field should contain the path to the location of the `@yext/chat-ui-react` library (e.g., `node_modules/@yext/chat-ui-react/lib/**/*.{js,jsx}`)
- The default theme should be extended with the custom styling used by the components specified [here](https://github.com/yext/chat-ui-react/blob/main/tailwind.config.js).


#### CSS bundle
For projects that do not use Tailwind, a css bundle is exported as part of this package. To use it, you can import
the file `@yext/chat-ui-react/bundle.css` into your normal CSS flow.

Example for Yext Pages:
Expand Down

0 comments on commit 5e7cd0e

Please sign in to comment.