@helpai/elements 6.13.0 → 6.14.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/elements-web-component.esm.js +23 -23
- package/elements-web-component.esm.js.map +4 -4
- package/elements.cjs.js +24 -24
- package/elements.cjs.js.map +4 -4
- package/elements.esm.js +27 -27
- package/elements.esm.js.map +4 -4
- package/elements.js +24 -24
- package/elements.js.map +4 -4
- package/index.mjs +18 -18
- package/llms-full.txt +140 -140
- package/llms.txt +19 -19
- package/package.json +1 -1
- package/react.mjs +17 -17
- package/style.css +1 -1
- package/web-component.mjs +17 -17
package/llms-full.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Help AI Elements: the full SDK docs (@helpai/elements@6.
|
|
1
|
+
# Help AI Elements: the full SDK docs (@helpai/elements@6.14.0)
|
|
2
2
|
|
|
3
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
3
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
70
|
+
Full list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
152
|
+
Full framework-by-framework walkthrough: [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
189
|
+
Something not showing up? → [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
195
|
+
- **Match your brand** — [Theming](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
197
|
+
- **Change the launcher label / icon** — [`launcher` options](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
200
|
+
- **Forward chat events to analytics** — [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
202
|
+
§ Multiple widgets](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
233
|
+
Full security notes: [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md).
|
|
234
234
|
|
|
235
235
|
---
|
|
236
236
|
|
|
237
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
237
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
241
|
+
Deep-dive for every install path. See [Quickstart](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
253
|
+
| [React kit](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
275
|
-
- Emit the same [events](https://cdn.help.ai/sdk/js/elements/6.
|
|
276
|
-
- Respect the same [isolation guarantees](https://cdn.help.ai/sdk/js/elements/6.
|
|
274
|
+
- Accept the same [configuration options](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md).
|
|
275
|
+
- Emit the same [events](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md).
|
|
276
|
+
- Respect the same [isolation guarantees](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
331
|
+
[Configuration](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
337
|
+
> [`instance.setUserContext(...)` / `setPageContext(...)`](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
444
|
+
Full details: [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
466
|
+
[Framework integrations](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
658
|
+
Framework-by-framework details: [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md).
|
|
659
659
|
|
|
660
660
|
---
|
|
661
661
|
|
|
@@ -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/6.
|
|
867
|
-
- [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.
|
|
868
|
-
- [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.
|
|
869
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
866
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) — every option explained with examples.
|
|
867
|
+
- [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md) — matching your brand.
|
|
868
|
+
- [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md) — framework-specific recipes.
|
|
869
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md) — "my widget isn't showing up".
|
|
870
870
|
|
|
871
871
|
---
|
|
872
872
|
|
|
873
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
873
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md -->
|
|
874
874
|
|
|
875
875
|
# Framework integrations
|
|
876
876
|
|
|
@@ -959,12 +959,12 @@ function PricingHelp() {
|
|
|
959
959
|
}
|
|
960
960
|
```
|
|
961
961
|
|
|
962
|
-
- **`<HelpAI {...options} />`** takes every [widget option](https://cdn.help.ai/sdk/js/elements/6.
|
|
962
|
+
- **`<HelpAI {...options} />`** takes every [widget option](https://cdn.help.ai/sdk/js/elements/6.14.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/6.
|
|
967
|
+
[`{ open, ready, unread, conversationId? }`](https://cdn.help.ai/sdk/js/elements/6.14.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.
|
|
@@ -972,10 +972,10 @@ function PricingHelp() {
|
|
|
972
972
|
from `@helpai/elements/react`; the package's other entries are separate copies with their own widgets.
|
|
973
973
|
- **Two widgets** on one page: give each `<HelpAI widgetId='support' … />` and read it with `useHelpAI('support')`.
|
|
974
974
|
- **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/6.
|
|
975
|
+
`<HelpAI tools={[...]} />` ([Page tools](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/page-tools.md)). `execute` can be a new function on every render; the
|
|
976
976
|
agent's call runs the latest one, and only a changed definition registers or configures anything again.
|
|
977
977
|
- **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/6.
|
|
978
|
+
([Verified users](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#verified-users-usertoken)). Keep a function stable for one user (a module
|
|
979
979
|
function, or `useCallback` keyed on your user id): a different function logs in afresh, and dropping it logs out.
|
|
980
980
|
To open your own login modal from the widget's Log in button, `hook('default', 'loginRequested', fn)`
|
|
981
981
|
(Logging in).
|
|
@@ -1000,7 +1000,7 @@ function Chat() {
|
|
|
1000
1000
|
`import type {} from '@helpai/elements/jsx/react';` once (in your entry file or a `.d.ts`) registers `<web-ai-chat>`
|
|
1001
1001
|
in React 19's JSX: every attribute the element reads autocompletes, `ai-agent-deployment-id` is required, and a `ref`
|
|
1002
1002
|
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/6.
|
|
1003
|
+
and `@helpai/elements/jsx/svelte` ([JSX typings](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md#jsx-typings)).
|
|
1004
1004
|
|
|
1005
1005
|
```tsx
|
|
1006
1006
|
import { useRef } from 'react';
|
|
@@ -1509,21 +1509,21 @@ sometimes mounts duplicate instances. Always pair your `useEffect` /
|
|
|
1509
1509
|
|
|
1510
1510
|
**CSP blocks the widget** — the widget inlines styles inside a shadow
|
|
1511
1511
|
root (requires `style-src 'unsafe-inline'` or a nonce pattern). See
|
|
1512
|
-
[Security & privacy § CSP](https://cdn.help.ai/sdk/js/elements/6.
|
|
1512
|
+
[Security & privacy § CSP](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#content-security-policy).
|
|
1513
1513
|
|
|
1514
|
-
More: [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
1514
|
+
More: [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md).
|
|
1515
1515
|
|
|
1516
1516
|
---
|
|
1517
1517
|
|
|
1518
1518
|
## Next
|
|
1519
1519
|
|
|
1520
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
1521
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
1522
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
1520
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md) — programmatic control patterns.
|
|
1521
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) — analytics integration.
|
|
1522
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) — every option in detail.
|
|
1523
1523
|
|
|
1524
1524
|
---
|
|
1525
1525
|
|
|
1526
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
1526
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md -->
|
|
1527
1527
|
|
|
1528
1528
|
# Configuration reference
|
|
1529
1529
|
|
|
@@ -1531,7 +1531,7 @@ Every option you can pass to `init(...)` / `mount(...)` / set via
|
|
|
1531
1531
|
`data-*` attributes / set via web-component attributes.
|
|
1532
1532
|
|
|
1533
1533
|
Group-by-group walkthrough with realistic examples. For an at-a-glance
|
|
1534
|
-
lookup, see [API reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
1534
|
+
lookup, see [API reference](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md).
|
|
1535
1535
|
|
|
1536
1536
|
---
|
|
1537
1537
|
|
|
@@ -1616,7 +1616,7 @@ init({ widgetId: 'support', publicKey: SUPPORT_KEY, aiAgentDeploymentId: SUPPORT
|
|
|
1616
1616
|
init({ widgetId: 'sales', publicKey: SALES_KEY, aiAgentDeploymentId: SALES_DEPLOYMENT_ID });
|
|
1617
1617
|
```
|
|
1618
1618
|
|
|
1619
|
-
See [Recipes § Multiple widgets](https://cdn.help.ai/sdk/js/elements/6.
|
|
1619
|
+
See [Recipes § Multiple widgets](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#multiple-widgets-on-one-page).
|
|
1620
1620
|
|
|
1621
1621
|
### `baseUrl`
|
|
1622
1622
|
|
|
@@ -1636,7 +1636,7 @@ Override if you use:
|
|
|
1636
1636
|
Logs the visitor in as your logged-in user: a JWT your server signs with the deployment's secret key, or a function
|
|
1637
1637
|
returning a fresh one. Their conversations then follow them to any device, and the AI gets their name and email as
|
|
1638
1638
|
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/6.
|
|
1639
|
+
[Security → Verified users](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#verified-users-usertoken) for signing it and
|
|
1640
1640
|
Logging in for the Log in bar and screen.
|
|
1641
1641
|
|
|
1642
1642
|
```ts
|
|
@@ -1652,7 +1652,7 @@ Tools the AI agent can use on your page, in the WebMCP tool shape: a name, a des
|
|
|
1652
1652
|
and an `execute` function the widget runs in the visitor's browser when the agent calls it
|
|
1653
1653
|
(`annotations: { consequentialHint: true }` asks the visitor first). Runtime-only, like `userToken`;
|
|
1654
1654
|
`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/6.
|
|
1655
|
+
guide: [Page tools](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/page-tools.md).
|
|
1656
1656
|
|
|
1657
1657
|
```ts
|
|
1658
1658
|
init({
|
|
@@ -1781,8 +1781,8 @@ widget.clearUserContext();
|
|
|
1781
1781
|
```
|
|
1782
1782
|
|
|
1783
1783
|
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/6.
|
|
1785
|
-
the framework recipes in [`frameworks.md`](https://cdn.help.ai/sdk/js/elements/6.
|
|
1784
|
+
`data-page-*` tag attributes — see [Installation](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md) and
|
|
1785
|
+
the framework recipes in [`frameworks.md`](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md).
|
|
1786
1786
|
|
|
1787
1787
|
---
|
|
1788
1788
|
|
|
@@ -1887,7 +1887,7 @@ mode via the header picker regardless of palette overrides.
|
|
|
1887
1887
|
Visitors can flip the theme via the header picker. Their choice is
|
|
1888
1888
|
persisted per device + synced cross-device.
|
|
1889
1889
|
|
|
1890
|
-
Full customization guide: [Theming](https://cdn.help.ai/sdk/js/elements/6.
|
|
1890
|
+
Full customization guide: [Theming](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md).
|
|
1891
1891
|
|
|
1892
1892
|
---
|
|
1893
1893
|
|
|
@@ -1987,7 +1987,7 @@ init({
|
|
|
1987
1987
|
```
|
|
1988
1988
|
|
|
1989
1989
|
Variants + callout fully explained in
|
|
1990
|
-
[Theming § Launcher](https://cdn.help.ai/sdk/js/elements/6.
|
|
1990
|
+
[Theming § Launcher](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md#launcher).
|
|
1991
1991
|
|
|
1992
1992
|
### `launcher.hidden`
|
|
1993
1993
|
|
|
@@ -2237,7 +2237,7 @@ Full behavior + wire contract:
|
|
|
2237
2237
|
`boolean` · default: `false`
|
|
2238
2238
|
|
|
2239
2239
|
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/6.
|
|
2240
|
+
shown, a choice fires the [`messageFeedback`](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) event and is sent to the backend.
|
|
2241
2241
|
|
|
2242
2242
|
```ts
|
|
2243
2243
|
init({ behavior: { disableMessageFeedback: true } }); // hide the controls
|
|
@@ -2340,7 +2340,7 @@ init({
|
|
|
2340
2340
|
});
|
|
2341
2341
|
```
|
|
2342
2342
|
|
|
2343
|
-
Full key list: [i18n](https://cdn.help.ai/sdk/js/elements/6.
|
|
2343
|
+
Full key list: [i18n](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md#internationalization) or
|
|
2344
2344
|
`src/i18n/strings.ts` in the source.
|
|
2345
2345
|
|
|
2346
2346
|
---
|
|
@@ -2423,7 +2423,7 @@ init({
|
|
|
2423
2423
|
});
|
|
2424
2424
|
```
|
|
2425
2425
|
|
|
2426
|
-
For richer event handling, see [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
2426
|
+
For richer event handling, see [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md).
|
|
2427
2427
|
|
|
2428
2428
|
---
|
|
2429
2429
|
|
|
@@ -2459,7 +2459,7 @@ The widget itself does not include drafts in Help AI network requests before
|
|
|
2459
2459
|
Send. Use an encrypted adapter when same-origin plaintext storage is not
|
|
2460
2460
|
acceptable; an in-memory adapter disables reload restoration.
|
|
2461
2461
|
|
|
2462
|
-
Full adapter contract: [Security & privacy § custom storage](https://cdn.help.ai/sdk/js/elements/6.
|
|
2462
|
+
Full adapter contract: [Security & privacy § custom storage](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#custom-storage).
|
|
2463
2463
|
|
|
2464
2464
|
---
|
|
2465
2465
|
|
|
@@ -2565,14 +2565,14 @@ const chat = init({
|
|
|
2565
2565
|
|
|
2566
2566
|
## Not covered here
|
|
2567
2567
|
|
|
2568
|
-
- **Events** → [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
2569
|
-
- **Theming deep-dive** → [Theming](https://cdn.help.ai/sdk/js/elements/6.
|
|
2570
|
-
- **Framework-specific wiring** → [Frameworks](https://cdn.help.ai/sdk/js/elements/6.
|
|
2568
|
+
- **Events** → [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md)
|
|
2569
|
+
- **Theming deep-dive** → [Theming](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md)
|
|
2570
|
+
- **Framework-specific wiring** → [Frameworks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md)
|
|
2571
2571
|
- **Backend API** → Backend contract (internal)
|
|
2572
2572
|
|
|
2573
2573
|
---
|
|
2574
2574
|
|
|
2575
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
2575
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/options.md -->
|
|
2576
2576
|
|
|
2577
2577
|
# Configuration — `ChatWidgetOptions`
|
|
2578
2578
|
|
|
@@ -2922,13 +2922,13 @@ Pass `footer: { poweredBy: { text: "" } }` to opt out of the brand attribution.
|
|
|
2922
2922
|
|
|
2923
2923
|
---
|
|
2924
2924
|
|
|
2925
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
2925
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md -->
|
|
2926
2926
|
|
|
2927
2927
|
# API reference
|
|
2928
2928
|
|
|
2929
2929
|
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/6.
|
|
2931
|
-
and [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
2930
|
+
For explanations + examples, see the [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md)
|
|
2931
|
+
and [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) guides.
|
|
2932
2932
|
|
|
2933
2933
|
---
|
|
2934
2934
|
|
|
@@ -2979,7 +2979,7 @@ import {
|
|
|
2979
2979
|
} from '@helpai/elements/react';
|
|
2980
2980
|
```
|
|
2981
2981
|
|
|
2982
|
-
See [Frameworks → React](https://cdn.help.ai/sdk/js/elements/6.
|
|
2982
|
+
See [Frameworks → React](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md#react).
|
|
2983
2983
|
|
|
2984
2984
|
---
|
|
2985
2985
|
|
|
@@ -3094,7 +3094,7 @@ interface ChatWidgetInstance {
|
|
|
3094
3094
|
## `ChatWidgetOptions`
|
|
3095
3095
|
|
|
3096
3096
|
The generated, schema-backed field reference is
|
|
3097
|
-
[`docs/api/configuration.md`](https://cdn.help.ai/sdk/js/elements/6.
|
|
3097
|
+
[`docs/api/configuration.md`](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/options.md); it is authoritative.
|
|
3098
3098
|
The public input keeps embed identity, context, endpoint overrides, storage,
|
|
3099
3099
|
and callbacks at the top level. Serializable widget settings use focused
|
|
3100
3100
|
nested sections. `mount()` and `init()` require `aiAgentDeploymentId`; the
|
|
@@ -3134,11 +3134,11 @@ init({
|
|
|
3134
3134
|
```
|
|
3135
3135
|
|
|
3136
3136
|
The complete type also exposes `features`, `modules`, and `tracking`.
|
|
3137
|
-
See [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
3137
|
+
See [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) for behavior and examples.
|
|
3138
3138
|
|
|
3139
3139
|
### `ModelContextTool`
|
|
3140
3140
|
|
|
3141
|
-
A tool the agent can use on your page, in the WebMCP tool shape ([Page tools](https://cdn.help.ai/sdk/js/elements/6.
|
|
3141
|
+
A tool the agent can use on your page, in the WebMCP tool shape ([Page tools](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/page-tools.md)). On `<web-ai-chat>`
|
|
3142
3142
|
it's the `tools` property or `registerTool()`, since functions can't be attributes.
|
|
3143
3143
|
|
|
3144
3144
|
```ts
|
|
@@ -3292,7 +3292,7 @@ any device join the history. A fresh token for the same person (the same `sub`),
|
|
|
3292
3292
|
"Your login expired", is applied in place; a token for another user starts over as `reset()` does. To switch user,
|
|
3293
3293
|
call `reset()` then `login(token)`. Also `HelpAI('login', userToken)`, `element.login(userToken)` on `<web-ai-chat>`
|
|
3294
3294
|
(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/6.
|
|
3295
|
+
`<HelpAI userToken={…} />`. Signing and the guarantees: [Security → Verified users](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#verified-users-usertoken);
|
|
3296
3296
|
the Log in bar, screen and `loginRequested`: Logging in.
|
|
3297
3297
|
|
|
3298
3298
|
```ts
|
|
@@ -3306,7 +3306,7 @@ chat.login(tokenFromYourServer);
|
|
|
3306
3306
|
|
|
3307
3307
|
Gives the agent a tool on this page, for every widget on it: the latest registration of a name wins, and aborting
|
|
3308
3308
|
`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/6.
|
|
3309
|
+
`element.registerTool(tool)` and the React kit's `useHelpAITool(tool)`. Details: [Page tools](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/page-tools.md).
|
|
3310
3310
|
|
|
3311
3311
|
```ts
|
|
3312
3312
|
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 +3320,7 @@ Reports something the visitor did on your site, outside the chat. It sends a `ho
|
|
|
3320
3320
|
(not when tracking is off), and the widget keeps the last 10 for the agent, which reads them with the visitor's next
|
|
3321
3321
|
message. The name is 1–64 characters; the data is flat (strings, numbers, booleans; 256 characters of JSON at most).
|
|
3322
3322
|
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/6.
|
|
3323
|
+
[Analytics → Your own events](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/analytics.md#your-own-events-chattrack).
|
|
3324
3324
|
|
|
3325
3325
|
```ts
|
|
3326
3326
|
chat.track('plan_viewed', { plan: 'pro' });
|
|
@@ -3403,10 +3403,10 @@ The auto-boot parser exposes the documented flat `data-*` subset.
|
|
|
3403
3403
|
></script>
|
|
3404
3404
|
```
|
|
3405
3405
|
|
|
3406
|
-
Full attribute list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/6.
|
|
3406
|
+
Full attribute list: [Installation § script data attributes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md#attributes).
|
|
3407
3407
|
|
|
3408
3408
|
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/6.
|
|
3409
|
+
`HelpAI.init({ … })` from JavaScript ([Installation § Load without mounting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md#load-without-mounting)).
|
|
3410
3410
|
|
|
3411
3411
|
---
|
|
3412
3412
|
|
|
@@ -3611,14 +3611,14 @@ Or use `/v1/` for the latest 1.x.x (auto-patches, no major breaks).
|
|
|
3611
3611
|
|
|
3612
3612
|
## See also
|
|
3613
3613
|
|
|
3614
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
3615
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
3616
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
3617
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
3614
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) — options with examples + context.
|
|
3615
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) — event handling deep-dive.
|
|
3616
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md) — copy-paste scenarios.
|
|
3617
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md) — when things go wrong.
|
|
3618
3618
|
|
|
3619
3619
|
---
|
|
3620
3620
|
|
|
3621
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
3621
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md -->
|
|
3622
3622
|
|
|
3623
3623
|
# Events & lifecycle hooks
|
|
3624
3624
|
|
|
@@ -3652,7 +3652,7 @@ Both deliver the same event stream. Both are safe to mix.
|
|
|
3652
3652
|
| `localeChange` | User picks a different language | `string` (new BCP-47 tag) |
|
|
3653
3653
|
| `messageFeedback` | User rates a reply 👍/👎 (or clears it) | `{ messageId: string; value: "up" \| "down" \| null }` |
|
|
3654
3654
|
| `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/6.
|
|
3655
|
+
| `toolResult` | A [page tool](https://cdn.help.ai/sdk/js/elements/6.14.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
3656
|
|
|
3657
3657
|
---
|
|
3658
3658
|
|
|
@@ -4109,21 +4109,21 @@ explicit `off()` is belt-and-suspenders. Either way works.
|
|
|
4109
4109
|
| No events at all | `.on()` called before the instance was fully constructed. Use `init()`'s return value or a pre-boot hook |
|
|
4110
4110
|
| Pre-boot hook never fires | Widget never mounted — check the public-key/deployment-id pair |
|
|
4111
4111
|
|
|
4112
|
-
[Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
4112
|
+
[Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md) has the full diagnostic
|
|
4113
4113
|
checklist.
|
|
4114
4114
|
|
|
4115
4115
|
---
|
|
4116
4116
|
|
|
4117
4117
|
## Next
|
|
4118
4118
|
|
|
4119
|
-
- [Analytics integration](https://cdn.help.ai/sdk/js/elements/6.
|
|
4120
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
4121
|
-
- [API reference § events](https://cdn.help.ai/sdk/js/elements/6.
|
|
4122
|
-
- [Configuration § callbacks](https://cdn.help.ai/sdk/js/elements/6.
|
|
4119
|
+
- [Analytics integration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/analytics.md) — GA4, Mixpanel, Segment, Amplitude, PostHog, Sentry, multi-provider
|
|
4120
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md) — copy-paste scenarios
|
|
4121
|
+
- [API reference § events](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md#events) — compact lookup
|
|
4122
|
+
- [Configuration § callbacks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md#callbacks-shortcut-for-events)
|
|
4123
4123
|
|
|
4124
4124
|
---
|
|
4125
4125
|
|
|
4126
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
4126
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/page-tools.md -->
|
|
4127
4127
|
|
|
4128
4128
|
# Page tools
|
|
4129
4129
|
|
|
@@ -4327,7 +4327,7 @@ on the `dev/page-tools.html` playground, with a real model or the mock backend.
|
|
|
4327
4327
|
|
|
4328
4328
|
---
|
|
4329
4329
|
|
|
4330
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
4330
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md -->
|
|
4331
4331
|
|
|
4332
4332
|
# Theming & customization
|
|
4333
4333
|
|
|
@@ -4655,7 +4655,7 @@ init({
|
|
|
4655
4655
|
|
|
4656
4656
|
## Header actions
|
|
4657
4657
|
|
|
4658
|
-
See [Configuration § Header actions](https://cdn.help.ai/sdk/js/elements/6.
|
|
4658
|
+
See [Configuration § Header actions](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md#header-actions)
|
|
4659
4659
|
for the full semantics. Quick customization examples:
|
|
4660
4660
|
|
|
4661
4661
|
### Minimal chrome
|
|
@@ -4861,7 +4861,7 @@ are for what tokens don't cover (shadows, corners, borders).
|
|
|
4861
4861
|
|
|
4862
4862
|
For truly bespoke designs (e.g., replacing the launcher with your
|
|
4863
4863
|
own component), use `launcher.hidden: true` + custom trigger, or a
|
|
4864
|
-
[no-script trigger](https://cdn.help.ai/sdk/js/elements/6.
|
|
4864
|
+
[no-script trigger](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md#no-script-triggers).
|
|
4865
4865
|
|
|
4866
4866
|
---
|
|
4867
4867
|
|
|
@@ -4893,16 +4893,16 @@ can always override.
|
|
|
4893
4893
|
|
|
4894
4894
|
## Next
|
|
4895
4895
|
|
|
4896
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
4896
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) — listening to chat
|
|
4897
4897
|
interactions, integrating with analytics.
|
|
4898
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
4898
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md) — copy-paste examples for common
|
|
4899
4899
|
customization scenarios.
|
|
4900
|
-
- [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
4900
|
+
- [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) — the full option
|
|
4901
4901
|
table.
|
|
4902
4902
|
|
|
4903
4903
|
---
|
|
4904
4904
|
|
|
4905
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
4905
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md -->
|
|
4906
4906
|
|
|
4907
4907
|
# Recipes
|
|
4908
4908
|
|
|
@@ -5626,13 +5626,13 @@ brand accent set in the dashboard.
|
|
|
5626
5626
|
|
|
5627
5627
|
## Next
|
|
5628
5628
|
|
|
5629
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
5630
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
5631
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
5629
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) — full event API
|
|
5630
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) — every option
|
|
5631
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md) — when things go wrong
|
|
5632
5632
|
|
|
5633
5633
|
---
|
|
5634
5634
|
|
|
5635
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
5635
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/analytics.md -->
|
|
5636
5636
|
|
|
5637
5637
|
# Analytics integration
|
|
5638
5638
|
|
|
@@ -5693,7 +5693,7 @@ event.
|
|
|
5693
5693
|
|
|
5694
5694
|
Every interactive action emits one event with a typed payload. Subscribe
|
|
5695
5695
|
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/6.
|
|
5696
|
+
(global, pre-boot-safe). Full schema in [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md).
|
|
5697
5697
|
|
|
5698
5698
|
| Category | Event | Payload |
|
|
5699
5699
|
| ---------------- | --------------------- | -------------------------------------------------- |
|
|
@@ -6213,14 +6213,14 @@ yourself — see the snippets above.
|
|
|
6213
6213
|
|
|
6214
6214
|
## See also
|
|
6215
6215
|
|
|
6216
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
6217
|
-
- [API reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
6218
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
6219
|
-
- [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.
|
|
6216
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) — full event reference, payload shapes, pre-boot queue semantics
|
|
6217
|
+
- [API reference](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md) — `ChatWidgetInstance` shape
|
|
6218
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md) — other end-to-end snippets
|
|
6219
|
+
- [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md) — what data flows where
|
|
6220
6220
|
|
|
6221
6221
|
---
|
|
6222
6222
|
|
|
6223
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
6223
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md -->
|
|
6224
6224
|
|
|
6225
6225
|
# Security & privacy
|
|
6226
6226
|
|
|
@@ -6409,7 +6409,7 @@ unsent text values in addition to identity and UI state, so adapter code owns
|
|
|
6409
6409
|
their storage destination, retention, and privacy behavior. Use cases include
|
|
6410
6410
|
encrypted `localStorage`, `sessionStorage`, and in-memory consent fallbacks.
|
|
6411
6411
|
|
|
6412
|
-
[Recipes § Custom storage](https://cdn.help.ai/sdk/js/elements/6.
|
|
6412
|
+
[Recipes § Custom storage](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#custom-storage-adapter).
|
|
6413
6413
|
|
|
6414
6414
|
---
|
|
6415
6415
|
|
|
@@ -6828,7 +6828,7 @@ We respond within 24 hours and coordinate disclosure on your schedule.
|
|
|
6828
6828
|
|
|
6829
6829
|
---
|
|
6830
6830
|
|
|
6831
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
6831
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/browser-support.md -->
|
|
6832
6832
|
|
|
6833
6833
|
# Browser support
|
|
6834
6834
|
|
|
@@ -7164,7 +7164,7 @@ with:
|
|
|
7164
7164
|
|
|
7165
7165
|
---
|
|
7166
7166
|
|
|
7167
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
7167
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md -->
|
|
7168
7168
|
|
|
7169
7169
|
# Troubleshooting
|
|
7170
7170
|
|
|
@@ -7260,7 +7260,7 @@ for (const k of Object.keys(localStorage)) {
|
|
|
7260
7260
|
3. **Any CSP errors in the console?** — `"Refused to connect to
|
|
7261
7261
|
https://help.ai/api/agent because it violates the following Content
|
|
7262
7262
|
Security Policy…"` means you need to add `help.ai` to your
|
|
7263
|
-
`connect-src`. See [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.
|
|
7263
|
+
`connect-src`. See [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#content-security-policy).
|
|
7264
7264
|
|
|
7265
7265
|
---
|
|
7266
7266
|
|
|
@@ -7343,7 +7343,7 @@ first.
|
|
|
7343
7343
|
### Symptom: widget ignores my CSS
|
|
7344
7344
|
|
|
7345
7345
|
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/6.
|
|
7346
|
+
CSS can't reach inside. Use the [theming options](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md)
|
|
7347
7347
|
instead.
|
|
7348
7348
|
|
|
7349
7349
|
For advanced customization, override CSS custom properties on the
|
|
@@ -7608,7 +7608,7 @@ font-src 'self' https:;
|
|
|
7608
7608
|
media-src 'self' blob:; # For voice recording
|
|
7609
7609
|
```
|
|
7610
7610
|
|
|
7611
|
-
Full CSP guide: [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.
|
|
7611
|
+
Full CSP guide: [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#content-security-policy).
|
|
7612
7612
|
|
|
7613
7613
|
---
|
|
7614
7614
|
|
|
@@ -7673,7 +7673,7 @@ provide `i18n.availableLocales` and include `language` in `header.actions`.
|
|
|
7673
7673
|
|
|
7674
7674
|
## Getting more help
|
|
7675
7675
|
|
|
7676
|
-
1. **Read the [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
7676
|
+
1. **Read the [FAQ](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/faq.md)** — most common questions answered
|
|
7677
7677
|
there.
|
|
7678
7678
|
|
|
7679
7679
|
2. **Check our GitHub issues**: [github.com/help-ai/elements](https://github.com/help-ai/elements/issues).
|
|
@@ -7692,7 +7692,7 @@ provide `i18n.availableLocales` and include `language` in `header.actions`.
|
|
|
7692
7692
|
|
|
7693
7693
|
---
|
|
7694
7694
|
|
|
7695
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
7695
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/faq.md -->
|
|
7696
7696
|
|
|
7697
7697
|
# FAQ
|
|
7698
7698
|
|
|
@@ -7732,7 +7732,7 @@ own builds. Your public key gates the backend, not the frontend.
|
|
|
7732
7732
|
### What browsers are supported?
|
|
7733
7733
|
|
|
7734
7734
|
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/6.
|
|
7735
|
+
On an older browser the widget renders nothing. See [Browser support](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/browser-support.md).
|
|
7736
7736
|
|
|
7737
7737
|
---
|
|
7738
7738
|
|
|
@@ -7751,11 +7751,11 @@ yourself) and serve it from your CDN. Point your `<script src>` at your hosted
|
|
|
7751
7751
|
URL. Self-hosting is also what unlocks **chunked delivery** (only changed code
|
|
7752
7752
|
re-downloads across releases) behind a single stable URL the customer never has
|
|
7753
7753
|
to change — see
|
|
7754
|
-
[Caching, versioning & self-hosting](https://cdn.help.ai/sdk/js/elements/6.
|
|
7754
|
+
[Caching, versioning & self-hosting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md#caching-versioning--self-hosting).
|
|
7755
7755
|
|
|
7756
7756
|
### Can I use this with a tag manager (GTM)?
|
|
7757
7757
|
|
|
7758
|
-
Yes. Use the async loader snippet ([Path B](https://cdn.help.ai/sdk/js/elements/6.
|
|
7758
|
+
Yes. Use the async loader snippet ([Path B](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md#path-b--async-loader-snippet))
|
|
7759
7759
|
inside a Custom HTML tag. All `HelpAI(...)` calls queue until the
|
|
7760
7760
|
bundle lands.
|
|
7761
7761
|
|
|
@@ -7767,15 +7767,15 @@ custom element on your page). Everything just works.
|
|
|
7767
7767
|
|
|
7768
7768
|
### Does it work with React / Next.js?
|
|
7769
7769
|
|
|
7770
|
-
Yes. Full walkthrough: [Framework integrations § Next.js](https://cdn.help.ai/sdk/js/elements/6.
|
|
7770
|
+
Yes. Full walkthrough: [Framework integrations § Next.js](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md#nextjs).
|
|
7771
7771
|
|
|
7772
7772
|
### Does it work with Vue / Svelte / SolidJS / Angular?
|
|
7773
7773
|
|
|
7774
|
-
Yes. See [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.
|
|
7774
|
+
Yes. See [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md).
|
|
7775
7775
|
|
|
7776
7776
|
### Does it work with WordPress / Shopify / Webflow / Squarespace?
|
|
7777
7777
|
|
|
7778
|
-
Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.
|
|
7778
|
+
Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md#wordpress).
|
|
7779
7779
|
|
|
7780
7780
|
---
|
|
7781
7781
|
|
|
@@ -7784,12 +7784,12 @@ Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.13.0/
|
|
|
7784
7784
|
### Can I change the launcher icon?
|
|
7785
7785
|
|
|
7786
7786
|
Yes. Pick from presets (`chat`, `spark`, `message`, `help`, `wand`)
|
|
7787
|
-
or pass raw SVG. See [Theming § Icons](https://cdn.help.ai/sdk/js/elements/6.
|
|
7787
|
+
or pass raw SVG. See [Theming § Icons](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md#icons).
|
|
7788
7788
|
|
|
7789
7789
|
### Can I match my brand colors?
|
|
7790
7790
|
|
|
7791
7791
|
Yes. Set `theme.accent`, `theme.accentText`, `theme.radius`,
|
|
7792
|
-
`theme.fontFamily`. See [Theming § Colors](https://cdn.help.ai/sdk/js/elements/6.
|
|
7792
|
+
`theme.fontFamily`. See [Theming § Colors](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md#color-overrides).
|
|
7793
7793
|
|
|
7794
7794
|
### Can I change the font?
|
|
7795
7795
|
|
|
@@ -7799,7 +7799,7 @@ respects any CSS font stack you provide.
|
|
|
7799
7799
|
### Can I hide the launcher and open the widget from my own button?
|
|
7800
7800
|
|
|
7801
7801
|
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/6.
|
|
7802
|
+
your button's click handler. [Recipes § Custom launcher](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#custom-launcher-button).
|
|
7803
7803
|
|
|
7804
7804
|
### Can I change the welcome message?
|
|
7805
7805
|
|
|
@@ -7808,24 +7808,24 @@ widget just renders what the backend sends.
|
|
|
7808
7808
|
|
|
7809
7809
|
### Can I override UI strings?
|
|
7810
7810
|
|
|
7811
|
-
Yes, per-locale or flat. See [Theming § Strings](https://cdn.help.ai/sdk/js/elements/6.
|
|
7811
|
+
Yes, per-locale or flat. See [Theming § Strings](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md#strings-overrides).
|
|
7812
7812
|
|
|
7813
7813
|
### Can I have multiple widgets on one page?
|
|
7814
7814
|
|
|
7815
7815
|
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/6.
|
|
7816
|
+
thread, storage, and events. [Recipes § Multi-widget](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#multiple-widgets-on-one-page).
|
|
7817
7817
|
|
|
7818
7818
|
### Can I show the widget only on certain pages?
|
|
7819
7819
|
|
|
7820
7820
|
Yes — just skip the `init()` call on pages where you don't want it.
|
|
7821
7821
|
Or conditionally mount/unmount based on the URL.
|
|
7822
|
-
[Recipes § Conditional show](https://cdn.help.ai/sdk/js/elements/6.
|
|
7822
|
+
[Recipes § Conditional show](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#conditionally-show-based-on-url).
|
|
7823
7823
|
|
|
7824
7824
|
### Can I use it in a specific language?
|
|
7825
7825
|
|
|
7826
7826
|
Yes. Force via `i18n.locale: 'fr-CA'`. Let users switch via
|
|
7827
7827
|
`i18n.availableLocales: ['en', 'fr', 'es']`. Full details: [Theming §
|
|
7828
|
-
Internationalization](https://cdn.help.ai/sdk/js/elements/6.
|
|
7828
|
+
Internationalization](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md#internationalization).
|
|
7829
7829
|
|
|
7830
7830
|
### Can I change the widget's position on mobile?
|
|
7831
7831
|
|
|
@@ -7862,7 +7862,7 @@ allowlisted event metadata through 1×1 pixel requests; it never sends message
|
|
|
7862
7862
|
text or form values and can be disabled with `tracking.enabled: false`. GPC and
|
|
7863
7863
|
DNT disable it automatically. No cookies or fingerprinting.
|
|
7864
7864
|
|
|
7865
|
-
Full breakdown: [Security & privacy § data collected](https://cdn.help.ai/sdk/js/elements/6.
|
|
7865
|
+
Full breakdown: [Security & privacy § data collected](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md#what-data-the-widget-collects).
|
|
7866
7866
|
|
|
7867
7867
|
### Does the widget use cookies?
|
|
7868
7868
|
|
|
@@ -7882,7 +7882,7 @@ Help AI API + your deployment's configured model provider.
|
|
|
7882
7882
|
It stores data about identified users (when you pass `user.id`) or
|
|
7883
7883
|
anonymous visitors. Your DPA (Data Processing Agreement) with Help
|
|
7884
7884
|
AI covers the processing terms. For consent management, see
|
|
7885
|
-
[Recipes § Gate behind consent](https://cdn.help.ai/sdk/js/elements/6.
|
|
7885
|
+
[Recipes § Gate behind consent](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#gate-the-widget-behind-consent).
|
|
7886
7886
|
|
|
7887
7887
|
### Can visitors delete their chat history?
|
|
7888
7888
|
|
|
@@ -7897,7 +7897,7 @@ Yes — pass a custom in-memory storage adapter. Adapter-managed identity,
|
|
|
7897
7897
|
conversation, draft, preference, and UI state then evaporates on reload. The
|
|
7898
7898
|
optional logger debug level is separate: calling `setDebug` persists
|
|
7899
7899
|
`helpai.debug` directly in `localStorage` until the host clears it.
|
|
7900
|
-
[Recipes § Custom storage adapter](https://cdn.help.ai/sdk/js/elements/6.
|
|
7900
|
+
[Recipes § Custom storage adapter](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#custom-storage-adapter).
|
|
7901
7901
|
|
|
7902
7902
|
### Does the widget track visitors across sites?
|
|
7903
7903
|
|
|
@@ -7922,7 +7922,7 @@ init({
|
|
|
7922
7922
|
not an auth credential. Browser public access uses the matching
|
|
7923
7923
|
`publicKey` + `aiAgentDeploymentId` pair, or the deployment ID alone for
|
|
7924
7924
|
intentional guest mode.
|
|
7925
|
-
See [Recipes § Logged-in user personalization](https://cdn.help.ai/sdk/js/elements/6.
|
|
7925
|
+
See [Recipes § Logged-in user personalization](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#logged-in-user-personalization).
|
|
7926
7926
|
|
|
7927
7927
|
### How do I integrate with my analytics (GA / Segment / Mixpanel)?
|
|
7928
7928
|
|
|
@@ -7941,7 +7941,7 @@ One-line pre-boot hook forwards every event:
|
|
|
7941
7941
|
</script>
|
|
7942
7942
|
```
|
|
7943
7943
|
|
|
7944
|
-
Full examples: [Recipes § Analytics forwarding](https://cdn.help.ai/sdk/js/elements/6.
|
|
7944
|
+
Full examples: [Recipes § Analytics forwarding](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md#analytics-forwarding).
|
|
7945
7945
|
|
|
7946
7946
|
### How do I capture errors in Sentry / Datadog?
|
|
7947
7947
|
|
|
@@ -8126,7 +8126,7 @@ table.
|
|
|
8126
8126
|
|
|
8127
8127
|
---
|
|
8128
8128
|
|
|
8129
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
8129
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.14.0/docs/README.md -->
|
|
8130
8130
|
|
|
8131
8131
|
# Help AI Elements — SDK Documentation
|
|
8132
8132
|
|
|
@@ -8154,7 +8154,7 @@ it → the panel opens → they can chat.
|
|
|
8154
8154
|
Get the public key and deployment ID from [help.ai](https://help.ai) →
|
|
8155
8155
|
**Dashboard → Deployments**.
|
|
8156
8156
|
|
|
8157
|
-
[**Continue with the quickstart →**](https://cdn.help.ai/sdk/js/elements/6.
|
|
8157
|
+
[**Continue with the quickstart →**](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/quickstart.md)
|
|
8158
8158
|
|
|
8159
8159
|
---
|
|
8160
8160
|
|
|
@@ -8162,20 +8162,20 @@ Get the public key and deployment ID from [help.ai](https://help.ai) →
|
|
|
8162
8162
|
|
|
8163
8163
|
| You want to… | Read |
|
|
8164
8164
|
| ----------------------------------------------------------- | --------------------------------------------- |
|
|
8165
|
-
| Install the widget end-to-end | [**Quickstart**](https://cdn.help.ai/sdk/js/elements/6.
|
|
8166
|
-
| See every install method (NPM, Web Component, React) | [Installation](https://cdn.help.ai/sdk/js/elements/6.
|
|
8167
|
-
| Customize every option | [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
8168
|
-
| Match my brand colors and typography | [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.
|
|
8169
|
-
| Send chat events to my analytics | [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
8170
|
-
| Wire GA4 / Mixpanel / Segment / multi-provider | [Analytics integration](https://cdn.help.ai/sdk/js/elements/6.
|
|
8171
|
-
| Integrate with Next.js / Vue / Svelte / WordPress / Shopify | [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.
|
|
8172
|
-
| Copy a working example | [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
8173
|
-
| Let the AI agent act on my page | [Page tools](https://cdn.help.ai/sdk/js/elements/6.
|
|
8174
|
-
| Diagnose "why isn't this working" | [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
8175
|
-
| Quick answer to a common question | [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
8176
|
-
| Compact API reference for lookup | [API reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
8177
|
-
| Understand what data the widget sees | [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.
|
|
8178
|
-
| Check browser compatibility | [Browser support](https://cdn.help.ai/sdk/js/elements/6.
|
|
8165
|
+
| Install the widget end-to-end | [**Quickstart**](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/quickstart.md) |
|
|
8166
|
+
| See every install method (NPM, Web Component, React) | [Installation](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md) |
|
|
8167
|
+
| Customize every option | [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md) |
|
|
8168
|
+
| Match my brand colors and typography | [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md) |
|
|
8169
|
+
| Send chat events to my analytics | [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/events-and-hooks.md) |
|
|
8170
|
+
| Wire GA4 / Mixpanel / Segment / multi-provider | [Analytics integration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/analytics.md) |
|
|
8171
|
+
| Integrate with Next.js / Vue / Svelte / WordPress / Shopify | [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/frameworks.md) |
|
|
8172
|
+
| Copy a working example | [Recipes](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/recipes.md) |
|
|
8173
|
+
| Let the AI agent act on my page | [Page tools](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/page-tools.md) |
|
|
8174
|
+
| Diagnose "why isn't this working" | [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/troubleshooting.md) |
|
|
8175
|
+
| Quick answer to a common question | [FAQ](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/faq.md) |
|
|
8176
|
+
| Compact API reference for lookup | [API reference](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/api-reference.md) |
|
|
8177
|
+
| Understand what data the widget sees | [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/security-privacy.md) |
|
|
8178
|
+
| Check browser compatibility | [Browser support](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/browser-support.md) |
|
|
8179
8179
|
|
|
8180
8180
|
---
|
|
8181
8181
|
|
|
@@ -8237,7 +8237,7 @@ Five ways to install. Pick whichever fits your site:
|
|
|
8237
8237
|
| **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
8238
|
|
|
8239
8239
|
All five use the same underlying library. Same options, same events,
|
|
8240
|
-
same behavior. Full comparison: [Installation](https://cdn.help.ai/sdk/js/elements/6.
|
|
8240
|
+
same behavior. Full comparison: [Installation](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/installation.md).
|
|
8241
8241
|
|
|
8242
8242
|
---
|
|
8243
8243
|
|
|
@@ -8292,14 +8292,14 @@ fuller example showing the most common options in one place:
|
|
|
8292
8292
|
</script>
|
|
8293
8293
|
```
|
|
8294
8294
|
|
|
8295
|
-
Every option explained in [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
8296
|
-
customization path in [Theming](https://cdn.help.ai/sdk/js/elements/6.
|
|
8295
|
+
Every option explained in [Configuration](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/configuration.md). Every
|
|
8296
|
+
customization path in [Theming](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/theming.md).
|
|
8297
8297
|
|
|
8298
8298
|
---
|
|
8299
8299
|
|
|
8300
8300
|
## Support
|
|
8301
8301
|
|
|
8302
|
-
- **Questions?** [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
8302
|
+
- **Questions?** [FAQ](https://cdn.help.ai/sdk/js/elements/6.14.0/docs/faq.md) — common answers first. [support@help.ai](mailto:support@help.ai) for anything else.
|
|
8303
8303
|
- **Found a bug?** File an issue at [github.com/help-ai/elements](https://github.com/help-ai/elements/issues).
|
|
8304
8304
|
- **Need a feature?** Same place — we read every request.
|
|
8305
8305
|
- **Status page:** [help.ai/status](https://help.ai/status).
|