https://github.com/livechat/products-sdk
The collection of sdk's for our products to help developers with building integrations
https://github.com/livechat/products-sdk
Last synced: 5 months ago
JSON representation
The collection of sdk's for our products to help developers with building integrations
- Host: GitHub
- URL: https://github.com/livechat/products-sdk
- Owner: livechat
- Created: 2022-04-01T12:03:33.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-09-26T09:34:01.000Z (9 months ago)
- Last Synced: 2025-09-26T11:36:07.124Z (9 months ago)
- Language: TypeScript
- Size: 1.24 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Products SDK's
> This project contains a collection of sdk's for our products to help developers with building integrations.
[](https://choosealicense.com/licenses/mit/)
[](https://turbo.build/repo)
| 🛠 Framework | 📦 Library | ⚖️ Size |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| 
**Agent App SDK** | [@livechat/agent-app-sdk](https://www.npmjs.com/package/@livechat/agent-app-sdk) |  |
| 
**HelpDesk SDK** | [@livechat/helpdesk-sdk](https://www.npmjs.com/package/@livechat/helpdesk-sdk) |  |
## 📦 Installation
Use the package manager [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install choosen package in your project.
### Agent App SDK
```bash
npm install @livechat/agent-app-sdk
# or
yarn add @livechat/agent-app-sdk
```
### HelpDesk SDK
```bash
npm install @livechat/helpdesk-sdk
# or
yarn add @livechat/helpdesk-sdk
```
## 🚀 Usage
### Agent App SDK
#### Details Widget
```ts
// App.tsx
import { createDetailsWidget } from "@livechat/agent-app-sdk";
const getDetailsWidget = async () => {
const detailsWidget = await createDetailsWidget();
};
```
#### Fullscreen Widget
```ts
// App.tsx
import { createFullscreenWidget } from "@livechat/agent-app-sdk";
const getFullscreenWidget = async () => {
const fullscreenWidget = await createFullscreenWidget();
};
```
#### Messagebox Widget
```ts
// App.tsx
import { createMessageBoxWidget } from "@livechat/agent-app-sdk";
const getMessageboxWidget = async () => {
const messageboxWidget = await createMessageBoxWidget();
};
```
### HelpDesk SDK
#### Details Widget
```ts
// App.tsx
import { createDetailsWidget } from "@livechat/helpdesk-sdk";
const getDetailsWidget = async () => {
const detailsWidget = await createDetailsWidget();
};
```
#### Fullscreen Widget
```ts
// App.tsx
import { createFullscreenWidget } from "@livechat/helpdesk-sdk";
const getFullscreenWidget = async () => {
const fullscreenWidget = await createFullscreenWidget();
};
```
## 🏗 Contributing
Read our [Contributing Guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.
This project has adopted a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
## 📃 License
The code and documentation in this project are released under the [MIT License](https://choosealicense.com/licenses/mit/).