{"id":21517709,"url":"https://github.com/channel-io/channel-web-sdk-loader","last_synced_at":"2025-04-09T18:16:40.780Z","repository":{"id":195954313,"uuid":"693036871","full_name":"channel-io/channel-web-sdk-loader","owner":"channel-io","description":"Official Channel Web SDK Loader","archived":false,"fork":false,"pushed_at":"2024-08-05T10:31:23.000Z","size":413,"stargazers_count":75,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-09T18:16:33.494Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://channel-io.github.io/channel-web-sdk-loader/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/channel-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-18T08:11:18.000Z","updated_at":"2025-04-08T16:04:44.000Z","dependencies_parsed_at":"2025-01-18T18:12:33.606Z","dependency_job_id":"863a968a-8573-47b2-a8c0-611d08dc847e","html_url":"https://github.com/channel-io/channel-web-sdk-loader","commit_stats":null,"previous_names":["channel-io/channel-web-sdk-loader"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/channel-io%2Fchannel-web-sdk-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/channel-io%2Fchannel-web-sdk-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/channel-io%2Fchannel-web-sdk-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/channel-io%2Fchannel-web-sdk-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/channel-io","download_url":"https://codeload.github.com/channel-io/channel-web-sdk-loader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085323,"owners_count":21045139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-11-24T00:44:42.031Z","updated_at":"2025-04-09T18:16:40.758Z","avatar_url":"https://github.com/channel-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./images/ChannelTalk_Logo_White.svg\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"./images/ChannelTalk_Logo_Primary.svg\"\u003e\n  \u003cimg alt=\"Channel Talk\" src=\"./images/ChannelTalk_Logo_Primary.svg\"\u003e\n\u003c/picture\u003e\n\n# channel-web-sdk-loader\n\n[![npm](https://img.shields.io/npm/v/%40channel.io%2Fchannel-web-sdk-loader)](https://www.npmjs.com/package/@channel.io/channel-web-sdk-loader)\n[![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)\n[![npm](https://img.shields.io/npm/dm/%40channel.io/channel-web-sdk-loader)](https://www.npmjs.com/package/@channel.io/channel-web-sdk-loader)\n[![minzip](https://img.shields.io/bundlephobia/minzip/@channel.io/channel-web-sdk-loader)](https://bundlephobia.com/result?p=@channel.io/channel-web-sdk-loader)\n\n\n\u003e The Official [Channel SDK](https://developers.channel.io/docs/sdk) Loader for Web\n\n## Quick Links\n- [📄 Official Developer Documentation](https://developers.channel.io/docs/web-channelio)\n- [📄 TypeDoc API Reference](https://channel-io.github.io/channel-web-sdk-loader/)\n- [📦 Playground - React Demo](https://codesandbox.io/p/sandbox/ch-web-sdk-playground-xm8ls8)\n\n## Installation\n### NPM\n```bash\nnpm install @channel.io/channel-web-sdk-loader\n```\n\n### Yarn\n```bash\nyarn add @channel.io/channel-web-sdk-loader\n```\n\n### PNPM\n```bash\npnpm install @channel.io/channel-web-sdk-loader\n```\n\n## Usage\n\u003e ⚠️ Note: This SDK is designed for client-side use only and should not be invoked on the server-side.\n\n### Step1: Import the ChannelService Module\n```typescript\nimport * as ChannelService from '@channel.io/channel-web-sdk-loader';\n```\n\n### Step2: Load the Channel Web SDK\n```typescript\nChannelService.loadScript()\n```\n\n### Step3: Initialize the Channel Web SDK\n```typescript\nChannelService.boot({\n  pluginKey: 'YOUR_PLUGIN_KEY'\n})\n```\n- Obtain your [plugin key](https://developers.channel.io/docs/web-boot-option#pluginkey) from the [Desk application](https://developers.channel.io/docs/glossary#desk).\n- For additional information, please consult the [the official documentation](https://developers.channel.io/docs/sdk#get-a-plugin-key).\n\n## API Documentation\n- [📄 TypeDoc API Reference](https://channel-io.github.io/channel-web-sdk-loader/)\n\n## Playground\n- [📦 CodeSandbox - React Demo](https://codesandbox.io/p/sandbox/ch-web-sdk-playground-xm8ls8)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchannel-io%2Fchannel-web-sdk-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchannel-io%2Fchannel-web-sdk-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchannel-io%2Fchannel-web-sdk-loader/lists"}