CodeCow/chatwoot
1
0
Fork 0
mirror of https://github.com/chatwoot/chatwoot.git synced 2026-06-28 21:01:02 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

chore: remove usage file

Browse Source
This commit is contained in:
Shivam Mishra 2025-12-09 17:11:48 +05:30
parent 491569fa4f
commit 1dcafe6e47
No known key found for this signature in database
1 changed files with 0 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
app/javascript/ui/usage.md
View File

@ -1,46 +0,0 @@
# Chatwoot UI Components Usage Guide
This document explains how to use the Chatwoot UI components library, which can be used both as Web Components (Custom Elements) and as Vue components.
## Installation
```bash
npm install @chatwoot/ui
# or
yarn add @chatwoot/ui
# or
pnpm add @chatwoot/ui
```
## Usage
### As Web Components (Custom Elements)
Web Components can be used in any HTML page or application, regardless of the framework.
```html
<!-- Include the built JS file -->
<script src="https://unpkg.com/@chatwoot/ui/dist/ui.js"></script>
<!-- Use the custom element anywhere in your HTML -->
<chat-button label="Click me"></chat-button>
```
When the script loads, it automatically registers all custom elements with the browser, making them immediately available for use.
#### Accessing the Store in Web Components
The components have access to a global store instance. When using Web Components, the store is available through `window.__CHATWOOT_STORE__`.
You can interact with the store from your JavaScript:
```javascript
// Access the store
const store = window.__CHATWOOT_STORE__;
// Check store state
console.log(store.state.someData);
// Dispatch actions
store.dispatch('someAction', { data: 'example' });
```