diff --git a/docs/pages/Extensions/react-widget.md b/docs/pages/Extensions/react-widget.md index 94e6c23be..15717588d 100644 --- a/docs/pages/Extensions/react-widget.md +++ b/docs/pages/Extensions/react-widget.md @@ -17,7 +17,6 @@ Now, you can use the widget in your component like this : ```jsx ``` DocsGPTWidget takes 8 **props** with default fallback values: 1. `apiHost` — The URL of your DocsGPT API. -2. `selectDocs` — The documentation source that you want to use for your widget (e.g. `default` or `local/docs1.zip`). +2. `theme` — Allows to select your specific theme (dark or light). 3. `apiKey` — Usually, it's empty. 4. `avatar`: Specifies the URL of the avatar or image representing the chatbot. 5. `title`: Sets the title text displayed in the chatbot interface. 6. `description`: Provides a brief description of the chatbot's purpose or functionality. 7. `heroTitle`: Displays a welcome title when users interact with the chatbot. 8. `heroDescription`: Provide additional introductory text or information about the chatbot's capabilities. +9. `buttonIcon`: Specifies the url of the icon image for the widget. +10. `buttonBg`: Allows to specify the Background color of the widget. +11. `size`: Sets the size of the widget ( small, medium). + ### How to use DocsGPTWidget with [Nextra](https://nextra.site/) (Next.js + MDX) Install your widget as described above and then go to your `pages/` folder and create a new file `_app.js` with the following content: @@ -55,22 +61,30 @@ export default function MyApp({ Component, pageProps }) { ```html - - - - - DocsGPT Widget - - -
- - - - + + + + + HTML + CSS + + + +

This is a simple HTML + CSS template!

+
+ + + + ``` To link the widget to your api and your documents you can pass parameters to the renderDocsGPTWidget('div id', { parameters }). @@ -82,22 +96,24 @@ To link the widget to your api and your documents you can pass parameters to the DocsGPT Widget +
-