README.md

channel-web-sdk-loader

The Official Channel SDK Loader for Web

Quick Links

• 📄 Official Developer Documentation
• 📄 TypeDoc API Reference
• 📦 Playground - React Demo

Installation

NPM

npm install @channel.io/channel-web-sdk-loader

Yarn

yarn add @channel.io/channel-web-sdk-loader

PNPM

pnpm install @channel.io/channel-web-sdk-loader

Usage

⚠️ Note: This SDK is designed for client-side use only and should not be invoked on the server-side.

Step1: Import the ChannelService Module

import * as ChannelService from '@channel.io/channel-web-sdk-loader';

Step2: Load the Channel Web SDK

ChannelService.loadScript()

Step3: Initialize the Channel Web SDK

ChannelService.boot({
  pluginKey: 'YOUR_PLUGIN_KEY'
})

• Obtain your plugin key from the Desk application.
• For additional information, please consult the the official documentation.

API Documentation

• 📄 TypeDoc API Reference

Playground

• 📦 CodeSandbox - React Demo