0.0.0-experimental-7 • Published 3 years ago

@humanise-ai/client-sdk-react v0.0.0-experimental-7

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

@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

NameTypeDefaultDescription
apiKeystringRequired API key
apiRootstring"https://app.humanise.ai/"API root path
bundlePathstring"web-chat/web-chat.bundle.js"Client SDK bundle path
embeddedbooleanfalseDetermines 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}>;