https://github.com/channel-io/channel-web-sdk-loader

Official Channel Web SDK Loader
https://github.com/channel-io/channel-web-sdk-loader

branding channel channel-io channel-talk channel-web-sdk chat chat-application chatbot crm crm-platform customer-relationship-management customer-service japanese-language korean-language live-chat live-chat-sdk marketing-tools messenger sales user-management

Last synced: 3 days ago
JSON representation

Official Channel Web SDK Loader

• Host: GitHub
• URL: https://github.com/channel-io/channel-web-sdk-loader
• Owner: channel-io
• License: apache-2.0
• Created: 2023-09-18T08:11:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-05T10:31:23.000Z (6 months ago)
• Last Synced: 2025-01-11T17:08:04.724Z (10 days ago)
• Topics: branding, channel, channel-io, channel-talk, channel-web-sdk, chat, chat-application, chatbot, crm, crm-platform, customer-relationship-management, customer-service, japanese-language, korean-language, live-chat, live-chat-sdk, marketing-tools, messenger, sales, user-management
• Language: TypeScript
• Homepage: https://channel-io.github.io/channel-web-sdk-loader/
• Size: 403 KB
• Stars: 75
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

  

  

  

# channel-web-sdk-loader

[![npm](https://img.shields.io/npm/v/%40channel.io%2Fchannel-web-sdk-loader)](https://www.npmjs.com/package/@channel.io/channel-web-sdk-loader)

[![NPM](https://img.shields.io/npm/l/%40channel.io%2Fchannel-web-sdk-loader)](https://github.com/channel-io/channel-web-sdk-loader/blob/main/LICENSE)

[![npm](https://img.shields.io/npm/dm/%40channel.io/channel-web-sdk-loader)](https://www.npmjs.com/package/@channel.io/channel-web-sdk-loader)

[![minzip](https://img.shields.io/bundlephobia/minzip/@channel.io/channel-web-sdk-loader)](https://bundlephobia.com/[email protected]/channel-web-sdk-loader)

> The Official [Channel SDK](https://developers.channel.io/docs/sdk) Loader for Web

## Quick Links

- [📄 Official Developer Documentation](https://developers.channel.io/docs/web-channelio)

- [📄 TypeDoc API Reference](https://channel-io.github.io/channel-web-sdk-loader/)

- [📦 Playground - React Demo](https://codesandbox.io/p/sandbox/ch-web-sdk-playground-xm8ls8)

## Installation

### NPM

```bash

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

```

### Yarn

```bash

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

```

### PNPM

```bash

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

```typescript

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

```

### Step2: Load the Channel Web SDK

```typescript

ChannelService.loadScript()

```

### Step3: Initialize the Channel Web SDK

```typescript

ChannelService.boot({

  pluginKey: 'YOUR_PLUGIN_KEY'

})

```

- Obtain your [plugin key](https://developers.channel.io/docs/web-boot-option#pluginkey) from the [Desk application](https://developers.channel.io/docs/glossary#desk).

- For additional information, please consult the [the official documentation](https://developers.channel.io/docs/sdk#get-a-plugin-key).

## API Documentation

- [📄 TypeDoc API Reference](https://channel-io.github.io/channel-web-sdk-loader/)

## Playground

- [📦 CodeSandbox - React Demo](https://codesandbox.io/p/sandbox/ch-web-sdk-playground-xm8ls8)