@humanise-ai/client-sdk-react

This library allows you to use Humanise.AI's Client SDK including our live chat, allowing your customers to communicate with you on your React-based website or application.

Installation

Installation is really simple.

# npm
npm install @humanise-ai/client-sdk-react
# yarn
yarn add @humanise-ai/client-sdk-react
# pnpm
pnpm add @humanise-ai/client-sdk-react

Usage

This package exports a single React component ClientSdk and it's associated TypeScript types.

ClientSdk component

Props

Name	Type	Default	Description
apiKey	string		Required API key
apiRoot	string	"https://app.humanise.ai/"	API root path
bundlePath	string	"web-chat/web-chat.bundle.js"	Client SDK bundle path
embedded	boolean	false	Determines if the Client SDK is embedded within it's parent element

Example usage

import { ClientSdk } from "@humanise-ai/client-sdk-react";

export const App = () => <ClientSdk apiKey={API_KEY}>;