Getting Started
Get up and running with ZyeChat SDK in your React project in minutes.
Prerequisites
Before you begin, make sure you have:
- React 17 or higher
- Node.js 16 or higher
- A ZyeChat account and API key
Installation
Install the ZyeChat SDK using your preferred package manager:
npm
npm install @zyenova/zyechatyarn
yarn add @zyenova/zyechatpnpm
pnpm add @zyenova/zyechatImport Styles
Import the widget CSS file in your application entry point:
typescript
1
import '@zyenova/zyechat/widget.css';Basic Usage
Add the Widget component to your application:
tsx
1
2
3
4
5
6
7
8
9
10
11
import { Widget } from '@zyenova/zyechat';
import '@zyenova/zyechat/widget.css';
function App() {
return (
<Widget
apiKey="your-api-key-here"
botName="Support Bot"
/>
);
}Tip
The widget will automatically appear in the bottom-right corner of your page. You can customize its position and appearance using props.
Get Your API Key
To use the ZyeChat widget, you'll need an API key:
- Log in to your ZyeChat dashboard
- Navigate to the Widget settings page
- Generate or copy your API key
Important
Copy your API key immediately after generating it. You won't be able to see it again for security reasons.
Next Steps
Now that you have the widget installed, explore these guides: