@helpai/elements 6.15.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/frameworks.md +7 -3
- package/docs/installation.md +10 -10
- package/elements-web-component.esm.js +1 -1
- package/elements-web-component.esm.js.map +1 -1
- package/elements.cjs.js +23 -23
- package/elements.cjs.js.map +4 -4
- package/elements.esm.js +10 -10
- package/elements.esm.js.map +4 -4
- package/elements.js +29 -29
- package/elements.js.map +4 -4
- package/index.d.ts +7 -7
- package/index.mjs +2 -2
- package/llms-full.txt +157 -153
- package/llms.txt +19 -19
- package/package.json +2 -1
- package/react-BBw_sT1s.mjs +3 -0
- package/react-Dpi-Oi92.mjs +73 -0
- package/react.d.ts +45 -18
- package/react.mjs +1 -71
- package/web-component.mjs +1 -1
package/llms-full.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Help AI Elements: the full SDK docs (@helpai/elements@
|
|
1
|
+
# Help AI Elements: the full SDK docs (@helpai/elements@7.0.0)
|
|
2
2
|
|
|
3
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
3
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/quickstart.md -->
|
|
4
4
|
|
|
5
5
|
# Quickstart
|
|
6
6
|
|
|
@@ -67,7 +67,7 @@ kebab-case `data-*` attribute. Common ones:
|
|
|
67
67
|
></script>
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Full list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/
|
|
70
|
+
Full list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md#path-a--script-data--auto-boot).
|
|
71
71
|
|
|
72
72
|
---
|
|
73
73
|
|
|
@@ -149,7 +149,7 @@ export default function RootLayout({ children }: { children: React.ReactNode })
|
|
|
149
149
|
### Vue / Svelte / Angular / any bundler
|
|
150
150
|
|
|
151
151
|
Call `init(...)` once on mount and `destroy()` on unmount, or use the `<web-ai-chat>` element (path D).
|
|
152
|
-
Full framework-by-framework walkthrough: [Framework integrations](https://cdn.help.ai/sdk/js/elements/
|
|
152
|
+
Full framework-by-framework walkthrough: [Framework integrations](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md).
|
|
153
153
|
|
|
154
154
|
---
|
|
155
155
|
|
|
@@ -186,20 +186,20 @@ round chat bubble with an accent color.
|
|
|
186
186
|
- **Close the panel** → the bubble returns.
|
|
187
187
|
- **Reload the page** → your chat history stays intact.
|
|
188
188
|
|
|
189
|
-
Something not showing up? → [Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
189
|
+
Something not showing up? → [Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md).
|
|
190
190
|
|
|
191
191
|
---
|
|
192
192
|
|
|
193
193
|
## 4. Common next steps
|
|
194
194
|
|
|
195
|
-
- **Match your brand** — [Theming](https://cdn.help.ai/sdk/js/elements/
|
|
195
|
+
- **Match your brand** — [Theming](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md) has every color,
|
|
196
196
|
radius, and font knob.
|
|
197
|
-
- **Change the launcher label / icon** — [`launcher` options](https://cdn.help.ai/sdk/js/elements/
|
|
197
|
+
- **Change the launcher label / icon** — [`launcher` options](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md#launcher).
|
|
198
198
|
- **Know who the visitor is** — pass `userContext: { id, email, name }`
|
|
199
199
|
(and `pageContext: { area }`) for personalization.
|
|
200
|
-
- **Forward chat events to analytics** — [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
200
|
+
- **Forward chat events to analytics** — [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md).
|
|
201
201
|
- **Add a second widget** (one for sales, one for support) — [Recipes
|
|
202
|
-
§ Multiple widgets](https://cdn.help.ai/sdk/js/elements/
|
|
202
|
+
§ Multiple widgets](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#multiple-widgets-on-one-page).
|
|
203
203
|
|
|
204
204
|
---
|
|
205
205
|
|
|
@@ -230,15 +230,15 @@ the same deployment:
|
|
|
230
230
|
| Remix | read from `window.ENV` |
|
|
231
231
|
| Create React App | `REACT_APP_*` |
|
|
232
232
|
|
|
233
|
-
Full security notes: [Security & privacy](https://cdn.help.ai/sdk/js/elements/
|
|
233
|
+
Full security notes: [Security & privacy](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md).
|
|
234
234
|
|
|
235
235
|
---
|
|
236
236
|
|
|
237
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
237
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md -->
|
|
238
238
|
|
|
239
239
|
# Installation
|
|
240
240
|
|
|
241
|
-
Deep-dive for every install path. See [Quickstart](https://cdn.help.ai/sdk/js/elements/
|
|
241
|
+
Deep-dive for every install path. See [Quickstart](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/quickstart.md)
|
|
242
242
|
for the 5-minute version.
|
|
243
243
|
|
|
244
244
|
---
|
|
@@ -250,7 +250,7 @@ for the 5-minute version.
|
|
|
250
250
|
| [A. `<script data-*>` auto-boot](#path-a--script-data--auto-boot) | Static HTML, WordPress, no build step | CDN |
|
|
251
251
|
| [B. Async loader snippet](#path-b--async-loader-snippet) | Tag managers, analytics pipelines | CDN |
|
|
252
252
|
| [C. NPM package](#path-c--npm-package) | React, Next.js, Vue, Svelte, SolidJS, any bundler | NPM |
|
|
253
|
-
| [React kit](https://cdn.help.ai/sdk/js/elements/
|
|
253
|
+
| [React kit](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md#react) | React, Next.js, Remix: `<HelpAI />` + `useHelpAI()` | NPM |
|
|
254
254
|
| [D. Web Component](#path-d--web-component) | Declarative tags in any framework | CDN or NPM |
|
|
255
255
|
|
|
256
256
|
> ### CDN URL
|
|
@@ -271,9 +271,9 @@ for the 5-minute version.
|
|
|
271
271
|
All four paths:
|
|
272
272
|
|
|
273
273
|
- Load the same JS bundle.
|
|
274
|
-
- Accept the same [configuration options](https://cdn.help.ai/sdk/js/elements/
|
|
275
|
-
- Emit the same [events](https://cdn.help.ai/sdk/js/elements/
|
|
276
|
-
- Respect the same [isolation guarantees](https://cdn.help.ai/sdk/js/elements/
|
|
274
|
+
- Accept the same [configuration options](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md).
|
|
275
|
+
- Emit the same [events](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md).
|
|
276
|
+
- Respect the same [isolation guarantees](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#shadow-dom).
|
|
277
277
|
|
|
278
278
|
You can combine them — e.g., a Next.js page can use path C, and a
|
|
279
279
|
marketing landing can use path A, both pointing at the same deployment.
|
|
@@ -328,13 +328,13 @@ The zero-JavaScript path intentionally exposes a small, flat subset of
|
|
|
328
328
|
| `data-page-context` | `pageContext` extras (JSON) | `'{"experiment":"b"}'` |
|
|
329
329
|
|
|
330
330
|
Unknown attributes are ignored. Full option semantics:
|
|
331
|
-
[Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
331
|
+
[Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md).
|
|
332
332
|
|
|
333
333
|
> Explicit scalar attributes (`data-user-id`, `data-page-area`, …) win
|
|
334
334
|
> over keys in the `data-user-context` / `data-page-context` JSON. For
|
|
335
335
|
> SPAs where the visitor logs in after load or navigates between pages,
|
|
336
336
|
> set context dynamically with
|
|
337
|
-
> [`instance.setUserContext(...)` / `setPageContext(...)`](https://cdn.help.ai/sdk/js/elements/
|
|
337
|
+
> [`instance.setUserContext(...)` / `setPageContext(...)`](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md#setting-context-after-login--on-navigation).
|
|
338
338
|
> The `data-user-*` / `data-page-*` attributes are reactive — updating
|
|
339
339
|
> one re-handshakes with the same anonymous visitor/conversation. This
|
|
340
340
|
> context is informational for the AI, never an auth credential.
|
|
@@ -441,7 +441,7 @@ arrays or objects to it before the bundle arrives:
|
|
|
441
441
|
</script>
|
|
442
442
|
```
|
|
443
443
|
|
|
444
|
-
Full details: [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
444
|
+
Full details: [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md#global-lifecycle-hooks).
|
|
445
445
|
|
|
446
446
|
### After boot
|
|
447
447
|
|
|
@@ -463,7 +463,7 @@ window.HelpAI.brand // { id, displayName, cdnUrl, ... }
|
|
|
463
463
|
## Path C — NPM package
|
|
464
464
|
|
|
465
465
|
For sites with a bundler. Full framework-specific walkthroughs:
|
|
466
|
-
[Framework integrations](https://cdn.help.ai/sdk/js/elements/
|
|
466
|
+
[Framework integrations](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md).
|
|
467
467
|
|
|
468
468
|
### Install
|
|
469
469
|
|
|
@@ -655,7 +655,7 @@ declare module 'react' {
|
|
|
655
655
|
|
|
656
656
|
**Angular** — add `CUSTOM_ELEMENTS_SCHEMA` to your module.
|
|
657
657
|
|
|
658
|
-
Framework-by-framework details: [Framework integrations](https://cdn.help.ai/sdk/js/elements/
|
|
658
|
+
Framework-by-framework details: [Framework integrations](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md).
|
|
659
659
|
|
|
660
660
|
---
|
|
661
661
|
|
|
@@ -717,16 +717,16 @@ The web-component bundle self-registers `<web-ai-chat>` on import:
|
|
|
717
717
|
|
|
718
718
|
### File catalog (every `dist/<brand>/` ships these)
|
|
719
719
|
|
|
720
|
-
| File | Purpose
|
|
721
|
-
| --------------------------------- |
|
|
722
|
-
| `elements.js` | IIFE bundle, defines `window.HelpAI`
|
|
723
|
-
| `elements.esm.js` | **Standalone ESM, fully bundled**
|
|
724
|
-
| `elements-web-component.esm.js` | **Standalone ESM, registers `<web-ai-chat>`**
|
|
725
|
-
| `index.mjs` / `web-component.mjs` | tsdown ESM with bare imports (`import "preact"` etc.)
|
|
726
|
-
| `react.mjs` / `react.d.ts` | React kit: `<HelpAI />`, `useHelpAI()
|
|
727
|
-
| `style.css` | Standalone stylesheet — host-element tokens + layout
|
|
728
|
-
| `loader.js`, `loader.min.js` | GA-style queueing loader stub
|
|
729
|
-
| `index.d.ts` | TypeScript declarations
|
|
720
|
+
| File | Purpose | Use with |
|
|
721
|
+
| --------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------------- |
|
|
722
|
+
| `elements.js` | IIFE bundle, defines `window.HelpAI` | Plain `<script>` (no `type="module"`) |
|
|
723
|
+
| `elements.esm.js` | **Standalone ESM, fully bundled** | `<script type="module">` import |
|
|
724
|
+
| `elements-web-component.esm.js` | **Standalone ESM, registers `<web-ai-chat>`** | `<script type="module">` import (no JS) |
|
|
725
|
+
| `index.mjs` / `web-component.mjs` | tsdown ESM with bare imports (`import "preact"` etc.) | Bundlers (Vite, webpack, esbuild) |
|
|
726
|
+
| `react.mjs` / `react.d.ts` | React kit: `<HelpAI />`, `useHelpAI()`; the widget is `react-*.mjs`, loaded on mount | React apps, `@helpai/elements/react` |
|
|
727
|
+
| `style.css` | Standalone stylesheet — host-element tokens + layout | `<link rel="stylesheet">` |
|
|
728
|
+
| `loader.js`, `loader.min.js` | GA-style queueing loader stub | Tag managers / analytics pipelines |
|
|
729
|
+
| `index.d.ts` | TypeScript declarations | NPM consumers |
|
|
730
730
|
|
|
731
731
|
### CDN URL forms
|
|
732
732
|
|
|
@@ -863,14 +863,14 @@ weigh chunking (see [Caching, versioning & self-hosting](#caching-versioning--se
|
|
|
863
863
|
|
|
864
864
|
## Next
|
|
865
865
|
|
|
866
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
867
|
-
- [Theming & customization](https://cdn.help.ai/sdk/js/elements/
|
|
868
|
-
- [Framework integrations](https://cdn.help.ai/sdk/js/elements/
|
|
869
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
866
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) — every option explained with examples.
|
|
867
|
+
- [Theming & customization](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md) — matching your brand.
|
|
868
|
+
- [Framework integrations](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md) — framework-specific recipes.
|
|
869
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md) — "my widget isn't showing up".
|
|
870
870
|
|
|
871
871
|
---
|
|
872
872
|
|
|
873
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
873
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md -->
|
|
874
874
|
|
|
875
875
|
# Framework integrations
|
|
876
876
|
|
|
@@ -959,28 +959,32 @@ function PricingHelp() {
|
|
|
959
959
|
}
|
|
960
960
|
```
|
|
961
961
|
|
|
962
|
-
- **`<HelpAI {...options} />`** takes every [widget option](https://cdn.help.ai/sdk/js/elements/
|
|
962
|
+
- **`<HelpAI {...options} />`** takes every [widget option](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) as a prop; `aiAgentDeploymentId` is
|
|
963
963
|
required. It renders nothing itself: the widget mounts once the page is in the browser, a prop change re-configures
|
|
964
964
|
the live widget without a remount, and unmounting removes it. Callback props (`onOpen`, `onMessage`, …) can be new
|
|
965
965
|
functions on every render; the widget always calls the latest one.
|
|
966
966
|
- **`useHelpAI(widgetId?)`** returns `{ state, ask, open, close, reset, track }`. `state` is
|
|
967
|
-
[`{ open, ready, unread, conversationId? }`](https://cdn.help.ai/sdk/js/elements/
|
|
967
|
+
[`{ open, ready, unread, conversationId? }`](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md#state-and-ready) and re-renders the component when it changes;
|
|
968
968
|
the server render sees the initial state. The commands are stable across renders and do nothing until the widget
|
|
969
969
|
has mounted (`state.ready`). `ask(text)` fills the composer; `ask(text, { send: true })` sends it. Call `reset()`
|
|
970
970
|
when your user logs out.
|
|
971
|
-
- **One import path.** The kit carries the
|
|
972
|
-
from `@helpai/elements/react`; the package's other entries are
|
|
971
|
+
- **One import path.** The kit carries the widget API a React app uses (`getInstance`, `getAllInstances`, `hook`,
|
|
972
|
+
`version`, `brand`, the types), so import everything from `@helpai/elements/react`; the package's other entries are
|
|
973
|
+
separate copies with their own widgets. `<HelpAI />` is how the kit mounts the widget: it has no `init`, `mount` or
|
|
974
|
+
`destroy`.
|
|
973
975
|
- **Two widgets** on one page: give each `<HelpAI widgetId='support' … />` and read it with `useHelpAI('support')`.
|
|
974
976
|
- **Page tools:** `useHelpAITool(tool)` gives the agent a tool while the component is mounted, or pass
|
|
975
|
-
`<HelpAI tools={[...]} />` ([Page tools](https://cdn.help.ai/sdk/js/elements/
|
|
977
|
+
`<HelpAI tools={[...]} />` ([Page tools](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md)). `execute` can be a new function on every render; the
|
|
976
978
|
agent's call runs the latest one, and only a changed definition registers or configures anything again.
|
|
977
979
|
- **Logged-in users:** pass `userToken`, the token your server signs for the user, or a function returning a fresh one
|
|
978
|
-
([Verified users](https://cdn.help.ai/sdk/js/elements/
|
|
980
|
+
([Verified users](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#verified-users-usertoken)). Keep a function stable for one user (a module
|
|
979
981
|
function, or `useCallback` keyed on your user id): a different function logs in afresh, and dropping it logs out.
|
|
980
982
|
To open your own login modal from the widget's Log in button, `hook('default', 'loginRequested', fn)`
|
|
981
983
|
(Logging in).
|
|
982
984
|
|
|
983
|
-
The kit
|
|
985
|
+
The kit carries the widget and imports only React from your app, so you don't need Preact installed. The widget
|
|
986
|
+
itself (about 150 kB gzipped) is a separate chunk that `<HelpAI />` loads once it mounts in the browser, so it stays
|
|
987
|
+
out of your app's first load; the hooks work from the start and pick the widget up when it is ready.
|
|
984
988
|
|
|
985
989
|
### React 19 — use the web component directly
|
|
986
990
|
|
|
@@ -1000,7 +1004,7 @@ function Chat() {
|
|
|
1000
1004
|
`import type {} from '@helpai/elements/jsx/react';` once (in your entry file or a `.d.ts`) registers `<web-ai-chat>`
|
|
1001
1005
|
in React 19's JSX: every attribute the element reads autocompletes, `ai-agent-deployment-id` is required, and a `ref`
|
|
1002
1006
|
is the typed element with `ask`, `open`, `state`, `ready` and `reset`. Vue and Svelte have `@helpai/elements/jsx/vue`
|
|
1003
|
-
and `@helpai/elements/jsx/svelte` ([JSX typings](https://cdn.help.ai/sdk/js/elements/
|
|
1007
|
+
and `@helpai/elements/jsx/svelte` ([JSX typings](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md#jsx-typings)).
|
|
1004
1008
|
|
|
1005
1009
|
```tsx
|
|
1006
1010
|
import { useRef } from 'react';
|
|
@@ -1509,21 +1513,21 @@ sometimes mounts duplicate instances. Always pair your `useEffect` /
|
|
|
1509
1513
|
|
|
1510
1514
|
**CSP blocks the widget** — the widget inlines styles inside a shadow
|
|
1511
1515
|
root (requires `style-src 'unsafe-inline'` or a nonce pattern). See
|
|
1512
|
-
[Security & privacy § CSP](https://cdn.help.ai/sdk/js/elements/
|
|
1516
|
+
[Security & privacy § CSP](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#content-security-policy).
|
|
1513
1517
|
|
|
1514
|
-
More: [Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
1518
|
+
More: [Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md).
|
|
1515
1519
|
|
|
1516
1520
|
---
|
|
1517
1521
|
|
|
1518
1522
|
## Next
|
|
1519
1523
|
|
|
1520
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/
|
|
1521
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
1522
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
1524
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md) — programmatic control patterns.
|
|
1525
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) — analytics integration.
|
|
1526
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) — every option in detail.
|
|
1523
1527
|
|
|
1524
1528
|
---
|
|
1525
1529
|
|
|
1526
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
1530
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md -->
|
|
1527
1531
|
|
|
1528
1532
|
# Configuration reference
|
|
1529
1533
|
|
|
@@ -1531,7 +1535,7 @@ Every option you can pass to `init(...)` / `mount(...)` / set via
|
|
|
1531
1535
|
`data-*` attributes / set via web-component attributes.
|
|
1532
1536
|
|
|
1533
1537
|
Group-by-group walkthrough with realistic examples. For an at-a-glance
|
|
1534
|
-
lookup, see [API reference](https://cdn.help.ai/sdk/js/elements/
|
|
1538
|
+
lookup, see [API reference](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md).
|
|
1535
1539
|
|
|
1536
1540
|
---
|
|
1537
1541
|
|
|
@@ -1616,7 +1620,7 @@ init({ widgetId: 'support', publicKey: SUPPORT_KEY, aiAgentDeploymentId: SUPPORT
|
|
|
1616
1620
|
init({ widgetId: 'sales', publicKey: SALES_KEY, aiAgentDeploymentId: SALES_DEPLOYMENT_ID });
|
|
1617
1621
|
```
|
|
1618
1622
|
|
|
1619
|
-
See [Recipes § Multiple widgets](https://cdn.help.ai/sdk/js/elements/
|
|
1623
|
+
See [Recipes § Multiple widgets](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#multiple-widgets-on-one-page).
|
|
1620
1624
|
|
|
1621
1625
|
### `baseUrl`
|
|
1622
1626
|
|
|
@@ -1636,7 +1640,7 @@ Override if you use:
|
|
|
1636
1640
|
Logs the visitor in as your logged-in user: a JWT your server signs with the deployment's secret key, or a function
|
|
1637
1641
|
returning a fresh one. Their conversations then follow them to any device, and the AI gets their name and email as
|
|
1638
1642
|
verified facts. Runtime-only: not an attribute or `data-*` option, so the token stays out of the page's markup. See
|
|
1639
|
-
[Security → Verified users](https://cdn.help.ai/sdk/js/elements/
|
|
1643
|
+
[Security → Verified users](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#verified-users-usertoken) for signing it and
|
|
1640
1644
|
Logging in for the Log in bar and screen.
|
|
1641
1645
|
|
|
1642
1646
|
```ts
|
|
@@ -1652,7 +1656,7 @@ Tools the AI agent can use on your page, in the WebMCP tool shape: a name, a des
|
|
|
1652
1656
|
and an `execute` function the widget runs in the visitor's browser when the agent calls it
|
|
1653
1657
|
(`annotations: { consequentialHint: true }` asks the visitor first). Runtime-only, like `userToken`;
|
|
1654
1658
|
`chat.update({ tools })` replaces them. `chat.registerTool(tool)` adds one for every widget on the page instead. Full
|
|
1655
|
-
guide: [Page tools](https://cdn.help.ai/sdk/js/elements/
|
|
1659
|
+
guide: [Page tools](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md).
|
|
1656
1660
|
|
|
1657
1661
|
```ts
|
|
1658
1662
|
init({
|
|
@@ -1781,8 +1785,8 @@ widget.clearUserContext();
|
|
|
1781
1785
|
```
|
|
1782
1786
|
|
|
1783
1787
|
You can also seed context at load time via `data-user-*` /
|
|
1784
|
-
`data-page-*` tag attributes — see [Installation](https://cdn.help.ai/sdk/js/elements/
|
|
1785
|
-
the framework recipes in [`frameworks.md`](https://cdn.help.ai/sdk/js/elements/
|
|
1788
|
+
`data-page-*` tag attributes — see [Installation](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md) and
|
|
1789
|
+
the framework recipes in [`frameworks.md`](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md).
|
|
1786
1790
|
|
|
1787
1791
|
---
|
|
1788
1792
|
|
|
@@ -1887,7 +1891,7 @@ mode via the header picker regardless of palette overrides.
|
|
|
1887
1891
|
Visitors can flip the theme via the header picker. Their choice is
|
|
1888
1892
|
persisted per device + synced cross-device.
|
|
1889
1893
|
|
|
1890
|
-
Full customization guide: [Theming](https://cdn.help.ai/sdk/js/elements/
|
|
1894
|
+
Full customization guide: [Theming](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md).
|
|
1891
1895
|
|
|
1892
1896
|
---
|
|
1893
1897
|
|
|
@@ -1987,7 +1991,7 @@ init({
|
|
|
1987
1991
|
```
|
|
1988
1992
|
|
|
1989
1993
|
Variants + callout fully explained in
|
|
1990
|
-
[Theming § Launcher](https://cdn.help.ai/sdk/js/elements/
|
|
1994
|
+
[Theming § Launcher](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md#launcher).
|
|
1991
1995
|
|
|
1992
1996
|
### `launcher.hidden`
|
|
1993
1997
|
|
|
@@ -2237,7 +2241,7 @@ Full behavior + wire contract:
|
|
|
2237
2241
|
`boolean` · default: `false`
|
|
2238
2242
|
|
|
2239
2243
|
Turn OFF the 👍/👎 feedback controls under each rateable reply (AI or operator) — unset/`false` shows them (default). While
|
|
2240
|
-
shown, a choice fires the [`messageFeedback`](https://cdn.help.ai/sdk/js/elements/
|
|
2244
|
+
shown, a choice fires the [`messageFeedback`](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) event and is sent to the backend.
|
|
2241
2245
|
|
|
2242
2246
|
```ts
|
|
2243
2247
|
init({ behavior: { disableMessageFeedback: true } }); // hide the controls
|
|
@@ -2340,7 +2344,7 @@ init({
|
|
|
2340
2344
|
});
|
|
2341
2345
|
```
|
|
2342
2346
|
|
|
2343
|
-
Full key list: [i18n](https://cdn.help.ai/sdk/js/elements/
|
|
2347
|
+
Full key list: [i18n](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md#internationalization) or
|
|
2344
2348
|
`src/i18n/strings.ts` in the source.
|
|
2345
2349
|
|
|
2346
2350
|
---
|
|
@@ -2423,7 +2427,7 @@ init({
|
|
|
2423
2427
|
});
|
|
2424
2428
|
```
|
|
2425
2429
|
|
|
2426
|
-
For richer event handling, see [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
2430
|
+
For richer event handling, see [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md).
|
|
2427
2431
|
|
|
2428
2432
|
---
|
|
2429
2433
|
|
|
@@ -2459,7 +2463,7 @@ The widget itself does not include drafts in Help AI network requests before
|
|
|
2459
2463
|
Send. Use an encrypted adapter when same-origin plaintext storage is not
|
|
2460
2464
|
acceptable; an in-memory adapter disables reload restoration.
|
|
2461
2465
|
|
|
2462
|
-
Full adapter contract: [Security & privacy § custom storage](https://cdn.help.ai/sdk/js/elements/
|
|
2466
|
+
Full adapter contract: [Security & privacy § custom storage](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#custom-storage).
|
|
2463
2467
|
|
|
2464
2468
|
---
|
|
2465
2469
|
|
|
@@ -2565,14 +2569,14 @@ const chat = init({
|
|
|
2565
2569
|
|
|
2566
2570
|
## Not covered here
|
|
2567
2571
|
|
|
2568
|
-
- **Events** → [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
2569
|
-
- **Theming deep-dive** → [Theming](https://cdn.help.ai/sdk/js/elements/
|
|
2570
|
-
- **Framework-specific wiring** → [Frameworks](https://cdn.help.ai/sdk/js/elements/
|
|
2572
|
+
- **Events** → [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md)
|
|
2573
|
+
- **Theming deep-dive** → [Theming](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md)
|
|
2574
|
+
- **Framework-specific wiring** → [Frameworks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md)
|
|
2571
2575
|
- **Backend API** → Backend contract (internal)
|
|
2572
2576
|
|
|
2573
2577
|
---
|
|
2574
2578
|
|
|
2575
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
2579
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/options.md -->
|
|
2576
2580
|
|
|
2577
2581
|
# Configuration — `ChatWidgetOptions`
|
|
2578
2582
|
|
|
@@ -2922,13 +2926,13 @@ Pass `footer: { poweredBy: { text: "" } }` to opt out of the brand attribution.
|
|
|
2922
2926
|
|
|
2923
2927
|
---
|
|
2924
2928
|
|
|
2925
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
2929
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md -->
|
|
2926
2930
|
|
|
2927
2931
|
# API reference
|
|
2928
2932
|
|
|
2929
2933
|
Compact lookup for the SDK's exported functions, types, and events.
|
|
2930
|
-
For explanations + examples, see the [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
2931
|
-
and [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
2934
|
+
For explanations + examples, see the [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md)
|
|
2935
|
+
and [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) guides.
|
|
2932
2936
|
|
|
2933
2937
|
---
|
|
2934
2938
|
|
|
@@ -2979,7 +2983,7 @@ import {
|
|
|
2979
2983
|
} from '@helpai/elements/react';
|
|
2980
2984
|
```
|
|
2981
2985
|
|
|
2982
|
-
See [Frameworks → React](https://cdn.help.ai/sdk/js/elements/
|
|
2986
|
+
See [Frameworks → React](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md#react).
|
|
2983
2987
|
|
|
2984
2988
|
---
|
|
2985
2989
|
|
|
@@ -3094,7 +3098,7 @@ interface ChatWidgetInstance {
|
|
|
3094
3098
|
## `ChatWidgetOptions`
|
|
3095
3099
|
|
|
3096
3100
|
The generated, schema-backed field reference is
|
|
3097
|
-
[`docs/api/configuration.md`](https://cdn.help.ai/sdk/js/elements/
|
|
3101
|
+
[`docs/api/configuration.md`](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/options.md); it is authoritative.
|
|
3098
3102
|
The public input keeps embed identity, context, endpoint overrides, storage,
|
|
3099
3103
|
and callbacks at the top level. Serializable widget settings use focused
|
|
3100
3104
|
nested sections. `mount()` and `init()` require `aiAgentDeploymentId`; the
|
|
@@ -3134,11 +3138,11 @@ init({
|
|
|
3134
3138
|
```
|
|
3135
3139
|
|
|
3136
3140
|
The complete type also exposes `features`, `modules`, and `tracking`.
|
|
3137
|
-
See [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
3141
|
+
See [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) for behavior and examples.
|
|
3138
3142
|
|
|
3139
3143
|
### `ModelContextTool`
|
|
3140
3144
|
|
|
3141
|
-
A tool the agent can use on your page, in the WebMCP tool shape ([Page tools](https://cdn.help.ai/sdk/js/elements/
|
|
3145
|
+
A tool the agent can use on your page, in the WebMCP tool shape ([Page tools](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md)). On `<web-ai-chat>`
|
|
3142
3146
|
it's the `tools` property or `registerTool()`, since functions can't be attributes.
|
|
3143
3147
|
|
|
3144
3148
|
```ts
|
|
@@ -3292,7 +3296,7 @@ any device join the history. A fresh token for the same person (the same `sub`),
|
|
|
3292
3296
|
"Your login expired", is applied in place; a token for another user starts over as `reset()` does. To switch user,
|
|
3293
3297
|
call `reset()` then `login(token)`. Also `HelpAI('login', userToken)`, `element.login(userToken)` on `<web-ai-chat>`
|
|
3294
3298
|
(not an attribute, so the token stays out of the DOM), the `userToken` option at `init()`, and
|
|
3295
|
-
`<HelpAI userToken={…} />`. Signing and the guarantees: [Security → Verified users](https://cdn.help.ai/sdk/js/elements/
|
|
3299
|
+
`<HelpAI userToken={…} />`. Signing and the guarantees: [Security → Verified users](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#verified-users-usertoken);
|
|
3296
3300
|
the Log in bar, screen and `loginRequested`: Logging in.
|
|
3297
3301
|
|
|
3298
3302
|
```ts
|
|
@@ -3306,7 +3310,7 @@ chat.login(tokenFromYourServer);
|
|
|
3306
3310
|
|
|
3307
3311
|
Gives the agent a tool on this page, for every widget on it: the latest registration of a name wins, and aborting
|
|
3308
3312
|
`options.signal` removes it. Also `HelpAI('registerTool', tool)` (queued before the script loads),
|
|
3309
|
-
`element.registerTool(tool)` and the React kit's `useHelpAITool(tool)`. Details: [Page tools](https://cdn.help.ai/sdk/js/elements/
|
|
3313
|
+
`element.registerTool(tool)` and the React kit's `useHelpAITool(tool)`. Details: [Page tools](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md).
|
|
3310
3314
|
|
|
3311
3315
|
```ts
|
|
3312
3316
|
chat.registerTool({ name: 'open_booking', description: 'Open the booking form. Use it whenever the visitor wants to book a call.', execute: () => bookingForm.open() });
|
|
@@ -3320,7 +3324,7 @@ Reports something the visitor did on your site, outside the chat. It sends a `ho
|
|
|
3320
3324
|
(not when tracking is off), and the widget keeps the last 10 for the agent, which reads them with the visitor's next
|
|
3321
3325
|
message. The name is 1–64 characters; the data is flat (strings, numbers, booleans; 256 characters of JSON at most).
|
|
3322
3326
|
Also `HelpAI('track', name, data)`, `element.track(name, data)` and `useHelpAI().track`. Details:
|
|
3323
|
-
[Analytics → Your own events](https://cdn.help.ai/sdk/js/elements/
|
|
3327
|
+
[Analytics → Your own events](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/analytics.md#your-own-events-chattrack).
|
|
3324
3328
|
|
|
3325
3329
|
```ts
|
|
3326
3330
|
chat.track('plan_viewed', { plan: 'pro' });
|
|
@@ -3403,10 +3407,10 @@ The auto-boot parser exposes the documented flat `data-*` subset.
|
|
|
3403
3407
|
></script>
|
|
3404
3408
|
```
|
|
3405
3409
|
|
|
3406
|
-
Full attribute list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/
|
|
3410
|
+
Full attribute list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md#attributes).
|
|
3407
3411
|
|
|
3408
3412
|
Leave out `data-ai-agent-deployment-id` to load the bundle without mounting, then call
|
|
3409
|
-
`HelpAI.init({ … })` from JavaScript ([Installation § Load without mounting](https://cdn.help.ai/sdk/js/elements/
|
|
3413
|
+
`HelpAI.init({ … })` from JavaScript ([Installation § Load without mounting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md#load-without-mounting)).
|
|
3410
3414
|
|
|
3411
3415
|
---
|
|
3412
3416
|
|
|
@@ -3611,14 +3615,14 @@ Or use `/v1/` for the latest 1.x.x (auto-patches, no major breaks).
|
|
|
3611
3615
|
|
|
3612
3616
|
## See also
|
|
3613
3617
|
|
|
3614
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
3615
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
3616
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/
|
|
3617
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
3618
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) — options with examples + context.
|
|
3619
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) — event handling deep-dive.
|
|
3620
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md) — copy-paste scenarios.
|
|
3621
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md) — when things go wrong.
|
|
3618
3622
|
|
|
3619
3623
|
---
|
|
3620
3624
|
|
|
3621
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
3625
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md -->
|
|
3622
3626
|
|
|
3623
3627
|
# Events & lifecycle hooks
|
|
3624
3628
|
|
|
@@ -3652,7 +3656,7 @@ Both deliver the same event stream. Both are safe to mix.
|
|
|
3652
3656
|
| `localeChange` | User picks a different language | `string` (new BCP-47 tag) |
|
|
3653
3657
|
| `messageFeedback` | User rates a reply 👍/👎 (or clears it) | `{ messageId: string; value: "up" \| "down" \| null }` |
|
|
3654
3658
|
| `hostEvent` | Your page calls `chat.track(name, data)` | `{ name: string; data?: Record<string, scalar> }` |
|
|
3655
|
-
| `toolResult` | A [page tool](https://cdn.help.ai/sdk/js/elements/
|
|
3659
|
+
| `toolResult` | A [page tool](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md) call settles, or the visitor answers a question card | `{ toolCallId: string; name?: string; status?: "completed" \| "failed" \| "declined" \| "stopped" \| "interrupted"; durationMs?: number }` |
|
|
3656
3660
|
|
|
3657
3661
|
---
|
|
3658
3662
|
|
|
@@ -4109,21 +4113,21 @@ explicit `off()` is belt-and-suspenders. Either way works.
|
|
|
4109
4113
|
| No events at all | `.on()` called before the instance was fully constructed. Use `init()`'s return value or a pre-boot hook |
|
|
4110
4114
|
| Pre-boot hook never fires | Widget never mounted — check the public-key/deployment-id pair |
|
|
4111
4115
|
|
|
4112
|
-
[Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
4116
|
+
[Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md) has the full diagnostic
|
|
4113
4117
|
checklist.
|
|
4114
4118
|
|
|
4115
4119
|
---
|
|
4116
4120
|
|
|
4117
4121
|
## Next
|
|
4118
4122
|
|
|
4119
|
-
- [Analytics integration](https://cdn.help.ai/sdk/js/elements/
|
|
4120
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/
|
|
4121
|
-
- [API reference § events](https://cdn.help.ai/sdk/js/elements/
|
|
4122
|
-
- [Configuration § callbacks](https://cdn.help.ai/sdk/js/elements/
|
|
4123
|
+
- [Analytics integration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/analytics.md) — GA4, Mixpanel, Segment, Amplitude, PostHog, Sentry, multi-provider
|
|
4124
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md) — copy-paste scenarios
|
|
4125
|
+
- [API reference § events](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md#events) — compact lookup
|
|
4126
|
+
- [Configuration § callbacks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md#callbacks-shortcut-for-events)
|
|
4123
4127
|
|
|
4124
4128
|
---
|
|
4125
4129
|
|
|
4126
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
4130
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md -->
|
|
4127
4131
|
|
|
4128
4132
|
# Page tools
|
|
4129
4133
|
|
|
@@ -4327,7 +4331,7 @@ on the `dev/page-tools.html` playground, with a real model or the mock backend.
|
|
|
4327
4331
|
|
|
4328
4332
|
---
|
|
4329
4333
|
|
|
4330
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
4334
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md -->
|
|
4331
4335
|
|
|
4332
4336
|
# Theming & customization
|
|
4333
4337
|
|
|
@@ -4655,7 +4659,7 @@ init({
|
|
|
4655
4659
|
|
|
4656
4660
|
## Header actions
|
|
4657
4661
|
|
|
4658
|
-
See [Configuration § Header actions](https://cdn.help.ai/sdk/js/elements/
|
|
4662
|
+
See [Configuration § Header actions](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md#header-actions)
|
|
4659
4663
|
for the full semantics. Quick customization examples:
|
|
4660
4664
|
|
|
4661
4665
|
### Minimal chrome
|
|
@@ -4861,7 +4865,7 @@ are for what tokens don't cover (shadows, corners, borders).
|
|
|
4861
4865
|
|
|
4862
4866
|
For truly bespoke designs (e.g., replacing the launcher with your
|
|
4863
4867
|
own component), use `launcher.hidden: true` + custom trigger, or a
|
|
4864
|
-
[no-script trigger](https://cdn.help.ai/sdk/js/elements/
|
|
4868
|
+
[no-script trigger](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md#no-script-triggers).
|
|
4865
4869
|
|
|
4866
4870
|
---
|
|
4867
4871
|
|
|
@@ -4893,16 +4897,16 @@ can always override.
|
|
|
4893
4897
|
|
|
4894
4898
|
## Next
|
|
4895
4899
|
|
|
4896
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
4900
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) — listening to chat
|
|
4897
4901
|
interactions, integrating with analytics.
|
|
4898
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/
|
|
4902
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md) — copy-paste examples for common
|
|
4899
4903
|
customization scenarios.
|
|
4900
|
-
- [Configuration reference](https://cdn.help.ai/sdk/js/elements/
|
|
4904
|
+
- [Configuration reference](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) — the full option
|
|
4901
4905
|
table.
|
|
4902
4906
|
|
|
4903
4907
|
---
|
|
4904
4908
|
|
|
4905
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
4909
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md -->
|
|
4906
4910
|
|
|
4907
4911
|
# Recipes
|
|
4908
4912
|
|
|
@@ -5626,13 +5630,13 @@ brand accent set in the dashboard.
|
|
|
5626
5630
|
|
|
5627
5631
|
## Next
|
|
5628
5632
|
|
|
5629
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
5630
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
5631
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
5633
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) — full event API
|
|
5634
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) — every option
|
|
5635
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md) — when things go wrong
|
|
5632
5636
|
|
|
5633
5637
|
---
|
|
5634
5638
|
|
|
5635
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
5639
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/analytics.md -->
|
|
5636
5640
|
|
|
5637
5641
|
# Analytics integration
|
|
5638
5642
|
|
|
@@ -5693,7 +5697,7 @@ event.
|
|
|
5693
5697
|
|
|
5694
5698
|
Every interactive action emits one event with a typed payload. Subscribe
|
|
5695
5699
|
via `chat.on(name, fn)` (instance) or `HelpAI.hook(widgetId, name, fn)`
|
|
5696
|
-
(global, pre-boot-safe). Full schema in [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
5700
|
+
(global, pre-boot-safe). Full schema in [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md).
|
|
5697
5701
|
|
|
5698
5702
|
| Category | Event | Payload |
|
|
5699
5703
|
| ---------------- | --------------------- | -------------------------------------------------- |
|
|
@@ -6213,14 +6217,14 @@ yourself — see the snippets above.
|
|
|
6213
6217
|
|
|
6214
6218
|
## See also
|
|
6215
6219
|
|
|
6216
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
6217
|
-
- [API reference](https://cdn.help.ai/sdk/js/elements/
|
|
6218
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/
|
|
6219
|
-
- [Security & privacy](https://cdn.help.ai/sdk/js/elements/
|
|
6220
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) — full event reference, payload shapes, pre-boot queue semantics
|
|
6221
|
+
- [API reference](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md) — `ChatWidgetInstance` shape
|
|
6222
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md) — other end-to-end snippets
|
|
6223
|
+
- [Security & privacy](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md) — what data flows where
|
|
6220
6224
|
|
|
6221
6225
|
---
|
|
6222
6226
|
|
|
6223
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
6227
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md -->
|
|
6224
6228
|
|
|
6225
6229
|
# Security & privacy
|
|
6226
6230
|
|
|
@@ -6409,7 +6413,7 @@ unsent text values in addition to identity and UI state, so adapter code owns
|
|
|
6409
6413
|
their storage destination, retention, and privacy behavior. Use cases include
|
|
6410
6414
|
encrypted `localStorage`, `sessionStorage`, and in-memory consent fallbacks.
|
|
6411
6415
|
|
|
6412
|
-
[Recipes § Custom storage](https://cdn.help.ai/sdk/js/elements/
|
|
6416
|
+
[Recipes § Custom storage](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#custom-storage-adapter).
|
|
6413
6417
|
|
|
6414
6418
|
---
|
|
6415
6419
|
|
|
@@ -6828,7 +6832,7 @@ We respond within 24 hours and coordinate disclosure on your schedule.
|
|
|
6828
6832
|
|
|
6829
6833
|
---
|
|
6830
6834
|
|
|
6831
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
6835
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/browser-support.md -->
|
|
6832
6836
|
|
|
6833
6837
|
# Browser support
|
|
6834
6838
|
|
|
@@ -7164,7 +7168,7 @@ with:
|
|
|
7164
7168
|
|
|
7165
7169
|
---
|
|
7166
7170
|
|
|
7167
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
7171
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md -->
|
|
7168
7172
|
|
|
7169
7173
|
# Troubleshooting
|
|
7170
7174
|
|
|
@@ -7260,7 +7264,7 @@ for (const k of Object.keys(localStorage)) {
|
|
|
7260
7264
|
3. **Any CSP errors in the console?** — `"Refused to connect to
|
|
7261
7265
|
https://help.ai/api/agent because it violates the following Content
|
|
7262
7266
|
Security Policy…"` means you need to add `help.ai` to your
|
|
7263
|
-
`connect-src`. See [Security § CSP](https://cdn.help.ai/sdk/js/elements/
|
|
7267
|
+
`connect-src`. See [Security § CSP](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#content-security-policy).
|
|
7264
7268
|
|
|
7265
7269
|
---
|
|
7266
7270
|
|
|
@@ -7343,7 +7347,7 @@ first.
|
|
|
7343
7347
|
### Symptom: widget ignores my CSS
|
|
7344
7348
|
|
|
7345
7349
|
That's by design. The widget lives inside a shadow root — your page
|
|
7346
|
-
CSS can't reach inside. Use the [theming options](https://cdn.help.ai/sdk/js/elements/
|
|
7350
|
+
CSS can't reach inside. Use the [theming options](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md)
|
|
7347
7351
|
instead.
|
|
7348
7352
|
|
|
7349
7353
|
For advanced customization, override CSS custom properties on the
|
|
@@ -7608,7 +7612,7 @@ font-src 'self' https:;
|
|
|
7608
7612
|
media-src 'self' blob:; # For voice recording
|
|
7609
7613
|
```
|
|
7610
7614
|
|
|
7611
|
-
Full CSP guide: [Security § CSP](https://cdn.help.ai/sdk/js/elements/
|
|
7615
|
+
Full CSP guide: [Security § CSP](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#content-security-policy).
|
|
7612
7616
|
|
|
7613
7617
|
---
|
|
7614
7618
|
|
|
@@ -7673,7 +7677,7 @@ provide `i18n.availableLocales` and include `language` in `header.actions`.
|
|
|
7673
7677
|
|
|
7674
7678
|
## Getting more help
|
|
7675
7679
|
|
|
7676
|
-
1. **Read the [FAQ](https://cdn.help.ai/sdk/js/elements/
|
|
7680
|
+
1. **Read the [FAQ](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/faq.md)** — most common questions answered
|
|
7677
7681
|
there.
|
|
7678
7682
|
|
|
7679
7683
|
2. **Check our GitHub issues**: [github.com/help-ai/elements](https://github.com/help-ai/elements/issues).
|
|
@@ -7692,7 +7696,7 @@ provide `i18n.availableLocales` and include `language` in `header.actions`.
|
|
|
7692
7696
|
|
|
7693
7697
|
---
|
|
7694
7698
|
|
|
7695
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
7699
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/faq.md -->
|
|
7696
7700
|
|
|
7697
7701
|
# FAQ
|
|
7698
7702
|
|
|
@@ -7732,7 +7736,7 @@ own builds. Your public key gates the backend, not the frontend.
|
|
|
7732
7736
|
### What browsers are supported?
|
|
7733
7737
|
|
|
7734
7738
|
Chrome/Edge 111+, Firefox 115+, Safari 16.2+, iOS Safari 16.2+, Samsung Internet 22+. No IE11.
|
|
7735
|
-
On an older browser the widget renders nothing. See [Browser support](https://cdn.help.ai/sdk/js/elements/
|
|
7739
|
+
On an older browser the widget renders nothing. See [Browser support](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/browser-support.md).
|
|
7736
7740
|
|
|
7737
7741
|
---
|
|
7738
7742
|
|
|
@@ -7751,11 +7755,11 @@ yourself) and serve it from your CDN. Point your `<script src>` at your hosted
|
|
|
7751
7755
|
URL. Self-hosting is also what unlocks **chunked delivery** (only changed code
|
|
7752
7756
|
re-downloads across releases) behind a single stable URL the customer never has
|
|
7753
7757
|
to change — see
|
|
7754
|
-
[Caching, versioning & self-hosting](https://cdn.help.ai/sdk/js/elements/
|
|
7758
|
+
[Caching, versioning & self-hosting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md#caching-versioning--self-hosting).
|
|
7755
7759
|
|
|
7756
7760
|
### Can I use this with a tag manager (GTM)?
|
|
7757
7761
|
|
|
7758
|
-
Yes. Use the async loader snippet ([Path B](https://cdn.help.ai/sdk/js/elements/
|
|
7762
|
+
Yes. Use the async loader snippet ([Path B](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md#path-b--async-loader-snippet))
|
|
7759
7763
|
inside a Custom HTML tag. All `HelpAI(...)` calls queue until the
|
|
7760
7764
|
bundle lands.
|
|
7761
7765
|
|
|
@@ -7767,15 +7771,15 @@ custom element on your page). Everything just works.
|
|
|
7767
7771
|
|
|
7768
7772
|
### Does it work with React / Next.js?
|
|
7769
7773
|
|
|
7770
|
-
Yes. Full walkthrough: [Framework integrations § Next.js](https://cdn.help.ai/sdk/js/elements/
|
|
7774
|
+
Yes. Full walkthrough: [Framework integrations § Next.js](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md#nextjs).
|
|
7771
7775
|
|
|
7772
7776
|
### Does it work with Vue / Svelte / SolidJS / Angular?
|
|
7773
7777
|
|
|
7774
|
-
Yes. See [Framework integrations](https://cdn.help.ai/sdk/js/elements/
|
|
7778
|
+
Yes. See [Framework integrations](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md).
|
|
7775
7779
|
|
|
7776
7780
|
### Does it work with WordPress / Shopify / Webflow / Squarespace?
|
|
7777
7781
|
|
|
7778
|
-
Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/
|
|
7782
|
+
Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md#wordpress).
|
|
7779
7783
|
|
|
7780
7784
|
---
|
|
7781
7785
|
|
|
@@ -7784,12 +7788,12 @@ Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.15.0/
|
|
|
7784
7788
|
### Can I change the launcher icon?
|
|
7785
7789
|
|
|
7786
7790
|
Yes. Pick from presets (`chat`, `spark`, `message`, `help`, `wand`)
|
|
7787
|
-
or pass raw SVG. See [Theming § Icons](https://cdn.help.ai/sdk/js/elements/
|
|
7791
|
+
or pass raw SVG. See [Theming § Icons](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md#icons).
|
|
7788
7792
|
|
|
7789
7793
|
### Can I match my brand colors?
|
|
7790
7794
|
|
|
7791
7795
|
Yes. Set `theme.accent`, `theme.accentText`, `theme.radius`,
|
|
7792
|
-
`theme.fontFamily`. See [Theming § Colors](https://cdn.help.ai/sdk/js/elements/
|
|
7796
|
+
`theme.fontFamily`. See [Theming § Colors](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md#color-overrides).
|
|
7793
7797
|
|
|
7794
7798
|
### Can I change the font?
|
|
7795
7799
|
|
|
@@ -7799,7 +7803,7 @@ respects any CSS font stack you provide.
|
|
|
7799
7803
|
### Can I hide the launcher and open the widget from my own button?
|
|
7800
7804
|
|
|
7801
7805
|
Yes. Set `launcher: { hidden: true }`, then call `chat.open()` from
|
|
7802
|
-
your button's click handler. [Recipes § Custom launcher](https://cdn.help.ai/sdk/js/elements/
|
|
7806
|
+
your button's click handler. [Recipes § Custom launcher](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#custom-launcher-button).
|
|
7803
7807
|
|
|
7804
7808
|
### Can I change the welcome message?
|
|
7805
7809
|
|
|
@@ -7808,24 +7812,24 @@ widget just renders what the backend sends.
|
|
|
7808
7812
|
|
|
7809
7813
|
### Can I override UI strings?
|
|
7810
7814
|
|
|
7811
|
-
Yes, per-locale or flat. See [Theming § Strings](https://cdn.help.ai/sdk/js/elements/
|
|
7815
|
+
Yes, per-locale or flat. See [Theming § Strings](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md#strings-overrides).
|
|
7812
7816
|
|
|
7813
7817
|
### Can I have multiple widgets on one page?
|
|
7814
7818
|
|
|
7815
7819
|
Yes — with distinct `widgetId` values. Each gets its own chat
|
|
7816
|
-
thread, storage, and events. [Recipes § Multi-widget](https://cdn.help.ai/sdk/js/elements/
|
|
7820
|
+
thread, storage, and events. [Recipes § Multi-widget](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#multiple-widgets-on-one-page).
|
|
7817
7821
|
|
|
7818
7822
|
### Can I show the widget only on certain pages?
|
|
7819
7823
|
|
|
7820
7824
|
Yes — just skip the `init()` call on pages where you don't want it.
|
|
7821
7825
|
Or conditionally mount/unmount based on the URL.
|
|
7822
|
-
[Recipes § Conditional show](https://cdn.help.ai/sdk/js/elements/
|
|
7826
|
+
[Recipes § Conditional show](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#conditionally-show-based-on-url).
|
|
7823
7827
|
|
|
7824
7828
|
### Can I use it in a specific language?
|
|
7825
7829
|
|
|
7826
7830
|
Yes. Force via `i18n.locale: 'fr-CA'`. Let users switch via
|
|
7827
7831
|
`i18n.availableLocales: ['en', 'fr', 'es']`. Full details: [Theming §
|
|
7828
|
-
Internationalization](https://cdn.help.ai/sdk/js/elements/
|
|
7832
|
+
Internationalization](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md#internationalization).
|
|
7829
7833
|
|
|
7830
7834
|
### Can I change the widget's position on mobile?
|
|
7831
7835
|
|
|
@@ -7862,7 +7866,7 @@ allowlisted event metadata through 1×1 pixel requests; it never sends message
|
|
|
7862
7866
|
text or form values and can be disabled with `tracking.enabled: false`. GPC and
|
|
7863
7867
|
DNT disable it automatically. No cookies or fingerprinting.
|
|
7864
7868
|
|
|
7865
|
-
Full breakdown: [Security & privacy § data collected](https://cdn.help.ai/sdk/js/elements/
|
|
7869
|
+
Full breakdown: [Security & privacy § data collected](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md#what-data-the-widget-collects).
|
|
7866
7870
|
|
|
7867
7871
|
### Does the widget use cookies?
|
|
7868
7872
|
|
|
@@ -7882,7 +7886,7 @@ Help AI API + your deployment's configured model provider.
|
|
|
7882
7886
|
It stores data about identified users (when you pass `user.id`) or
|
|
7883
7887
|
anonymous visitors. Your DPA (Data Processing Agreement) with Help
|
|
7884
7888
|
AI covers the processing terms. For consent management, see
|
|
7885
|
-
[Recipes § Gate behind consent](https://cdn.help.ai/sdk/js/elements/
|
|
7889
|
+
[Recipes § Gate behind consent](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#gate-the-widget-behind-consent).
|
|
7886
7890
|
|
|
7887
7891
|
### Can visitors delete their chat history?
|
|
7888
7892
|
|
|
@@ -7897,7 +7901,7 @@ Yes — pass a custom in-memory storage adapter. Adapter-managed identity,
|
|
|
7897
7901
|
conversation, draft, preference, and UI state then evaporates on reload. The
|
|
7898
7902
|
optional logger debug level is separate: calling `setDebug` persists
|
|
7899
7903
|
`helpai.debug` directly in `localStorage` until the host clears it.
|
|
7900
|
-
[Recipes § Custom storage adapter](https://cdn.help.ai/sdk/js/elements/
|
|
7904
|
+
[Recipes § Custom storage adapter](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#custom-storage-adapter).
|
|
7901
7905
|
|
|
7902
7906
|
### Does the widget track visitors across sites?
|
|
7903
7907
|
|
|
@@ -7922,7 +7926,7 @@ init({
|
|
|
7922
7926
|
not an auth credential. Browser public access uses the matching
|
|
7923
7927
|
`publicKey` + `aiAgentDeploymentId` pair, or the deployment ID alone for
|
|
7924
7928
|
intentional guest mode.
|
|
7925
|
-
See [Recipes § Logged-in user personalization](https://cdn.help.ai/sdk/js/elements/
|
|
7929
|
+
See [Recipes § Logged-in user personalization](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#logged-in-user-personalization).
|
|
7926
7930
|
|
|
7927
7931
|
### How do I integrate with my analytics (GA / Segment / Mixpanel)?
|
|
7928
7932
|
|
|
@@ -7941,7 +7945,7 @@ One-line pre-boot hook forwards every event:
|
|
|
7941
7945
|
</script>
|
|
7942
7946
|
```
|
|
7943
7947
|
|
|
7944
|
-
Full examples: [Recipes § Analytics forwarding](https://cdn.help.ai/sdk/js/elements/
|
|
7948
|
+
Full examples: [Recipes § Analytics forwarding](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md#analytics-forwarding).
|
|
7945
7949
|
|
|
7946
7950
|
### How do I capture errors in Sentry / Datadog?
|
|
7947
7951
|
|
|
@@ -8126,7 +8130,7 @@ table.
|
|
|
8126
8130
|
|
|
8127
8131
|
---
|
|
8128
8132
|
|
|
8129
|
-
<!-- https://cdn.help.ai/sdk/js/elements/
|
|
8133
|
+
<!-- https://cdn.help.ai/sdk/js/elements/7.0.0/docs/README.md -->
|
|
8130
8134
|
|
|
8131
8135
|
# Help AI Elements — SDK Documentation
|
|
8132
8136
|
|
|
@@ -8154,7 +8158,7 @@ it → the panel opens → they can chat.
|
|
|
8154
8158
|
Get the public key and deployment ID from [help.ai](https://help.ai) →
|
|
8155
8159
|
**Dashboard → Deployments**.
|
|
8156
8160
|
|
|
8157
|
-
[**Continue with the quickstart →**](https://cdn.help.ai/sdk/js/elements/
|
|
8161
|
+
[**Continue with the quickstart →**](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/quickstart.md)
|
|
8158
8162
|
|
|
8159
8163
|
---
|
|
8160
8164
|
|
|
@@ -8162,20 +8166,20 @@ Get the public key and deployment ID from [help.ai](https://help.ai) →
|
|
|
8162
8166
|
|
|
8163
8167
|
| You want to… | Read |
|
|
8164
8168
|
| ----------------------------------------------------------- | --------------------------------------------- |
|
|
8165
|
-
| Install the widget end-to-end | [**Quickstart**](https://cdn.help.ai/sdk/js/elements/
|
|
8166
|
-
| See every install method (NPM, Web Component, React) | [Installation](https://cdn.help.ai/sdk/js/elements/
|
|
8167
|
-
| Customize every option | [Configuration reference](https://cdn.help.ai/sdk/js/elements/
|
|
8168
|
-
| Match my brand colors and typography | [Theming & customization](https://cdn.help.ai/sdk/js/elements/
|
|
8169
|
-
| Send chat events to my analytics | [Events & hooks](https://cdn.help.ai/sdk/js/elements/
|
|
8170
|
-
| Wire GA4 / Mixpanel / Segment / multi-provider | [Analytics integration](https://cdn.help.ai/sdk/js/elements/
|
|
8171
|
-
| Integrate with Next.js / Vue / Svelte / WordPress / Shopify | [Framework integrations](https://cdn.help.ai/sdk/js/elements/
|
|
8172
|
-
| Copy a working example | [Recipes](https://cdn.help.ai/sdk/js/elements/
|
|
8173
|
-
| Let the AI agent act on my page | [Page tools](https://cdn.help.ai/sdk/js/elements/
|
|
8174
|
-
| Diagnose "why isn't this working" | [Troubleshooting](https://cdn.help.ai/sdk/js/elements/
|
|
8175
|
-
| Quick answer to a common question | [FAQ](https://cdn.help.ai/sdk/js/elements/
|
|
8176
|
-
| Compact API reference for lookup | [API reference](https://cdn.help.ai/sdk/js/elements/
|
|
8177
|
-
| Understand what data the widget sees | [Security & privacy](https://cdn.help.ai/sdk/js/elements/
|
|
8178
|
-
| Check browser compatibility | [Browser support](https://cdn.help.ai/sdk/js/elements/
|
|
8169
|
+
| Install the widget end-to-end | [**Quickstart**](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/quickstart.md) |
|
|
8170
|
+
| See every install method (NPM, Web Component, React) | [Installation](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md) |
|
|
8171
|
+
| Customize every option | [Configuration reference](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md) |
|
|
8172
|
+
| Match my brand colors and typography | [Theming & customization](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md) |
|
|
8173
|
+
| Send chat events to my analytics | [Events & hooks](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/events-and-hooks.md) |
|
|
8174
|
+
| Wire GA4 / Mixpanel / Segment / multi-provider | [Analytics integration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/analytics.md) |
|
|
8175
|
+
| Integrate with Next.js / Vue / Svelte / WordPress / Shopify | [Framework integrations](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/frameworks.md) |
|
|
8176
|
+
| Copy a working example | [Recipes](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/recipes.md) |
|
|
8177
|
+
| Let the AI agent act on my page | [Page tools](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/page-tools.md) |
|
|
8178
|
+
| Diagnose "why isn't this working" | [Troubleshooting](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/troubleshooting.md) |
|
|
8179
|
+
| Quick answer to a common question | [FAQ](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/faq.md) |
|
|
8180
|
+
| Compact API reference for lookup | [API reference](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/api-reference.md) |
|
|
8181
|
+
| Understand what data the widget sees | [Security & privacy](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/security-privacy.md) |
|
|
8182
|
+
| Check browser compatibility | [Browser support](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/browser-support.md) |
|
|
8179
8183
|
|
|
8180
8184
|
---
|
|
8181
8185
|
|
|
@@ -8237,7 +8241,7 @@ Five ways to install. Pick whichever fits your site:
|
|
|
8237
8241
|
| **ESM via CDN** | Plain HTML, sandboxes, MDX — no build, no NPM install | `import { mount } from 'https://cdn.jsdelivr.net/npm/@helpai/elements@<version>/elements.esm.js'` |
|
|
8238
8242
|
|
|
8239
8243
|
All five use the same underlying library. Same options, same events,
|
|
8240
|
-
same behavior. Full comparison: [Installation](https://cdn.help.ai/sdk/js/elements/
|
|
8244
|
+
same behavior. Full comparison: [Installation](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/installation.md).
|
|
8241
8245
|
|
|
8242
8246
|
---
|
|
8243
8247
|
|
|
@@ -8292,14 +8296,14 @@ fuller example showing the most common options in one place:
|
|
|
8292
8296
|
</script>
|
|
8293
8297
|
```
|
|
8294
8298
|
|
|
8295
|
-
Every option explained in [Configuration](https://cdn.help.ai/sdk/js/elements/
|
|
8296
|
-
customization path in [Theming](https://cdn.help.ai/sdk/js/elements/
|
|
8299
|
+
Every option explained in [Configuration](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/configuration.md). Every
|
|
8300
|
+
customization path in [Theming](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/theming.md).
|
|
8297
8301
|
|
|
8298
8302
|
---
|
|
8299
8303
|
|
|
8300
8304
|
## Support
|
|
8301
8305
|
|
|
8302
|
-
- **Questions?** [FAQ](https://cdn.help.ai/sdk/js/elements/
|
|
8306
|
+
- **Questions?** [FAQ](https://cdn.help.ai/sdk/js/elements/7.0.0/docs/faq.md) — common answers first. [support@help.ai](mailto:support@help.ai) for anything else.
|
|
8303
8307
|
- **Found a bug?** File an issue at [github.com/help-ai/elements](https://github.com/help-ai/elements/issues).
|
|
8304
8308
|
- **Need a feature?** Same place — we read every request.
|
|
8305
8309
|
- **Status page:** [help.ai/status](https://help.ai/status).
|