livechat / products-sdk

The collection of sdk's for our products to help developers with building integrations

Products SDK's

This project contains a collection of sdk's for our products to help developers with building integrations.

🛠 Framework	📦 Library	⚖️ Size
Agent App SDK	@livechat/agent-app-sdk
HelpDesk SDK	@livechat/helpdesk-sdk

📦 Installation

Use the package manager npm or yarn to install choosen package in your project.

Agent App SDK

npm install @livechat/agent-app-sdk
# or
yarn add @livechat/agent-app-sdk

HelpDesk SDK

npm install @livechat/helpdesk-sdk
# or
yarn add @livechat/helpdesk-sdk

🚀 Usage

Agent App SDK

Details Widget

// App.tsx

import { createDetailsWidget } from "@livechat/agent-app-sdk";

const getDetailsWidget = async () => {
  const detailsWidget = await createDetailsWidget();
};

Fullscreen Widget

// App.tsx

import { createFullscreenWidget } from "@livechat/agent-app-sdk";

const getFullscreenWidget = async () => {
  const fullscreenWidget = await createFullscreenWidget();
};

Messagebox Widget

// App.tsx

import { createMessageBoxWidget } from "@livechat/agent-app-sdk";

const getMessageboxWidget = async () => {
  const messageboxWidget = await createMessageBoxWidget();
};

HelpDesk SDK

Details Widget

// App.tsx

import { createDetailsWidget } from "@livechat/helpdesk-sdk";

const getDetailsWidget = async () => {
  const detailsWidget = await createDetailsWidget();
};

Fullscreen Widget

// App.tsx

import { createFullscreenWidget } from "@livechat/helpdesk-sdk";

const getFullscreenWidget = async () => {
  const fullscreenWidget = await createFullscreenWidget();
};

🏗 Contributing

Read our Contributing Guide 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 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.