@helpai/elements 6.4.10 → 6.5.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/configurator.mjs +1 -1
- package/docs/configuration.md +1 -1
- package/docs/installation.md +1 -1
- package/docs/page-tools.md +16 -13
- package/elements-web-component.esm.js +47 -45
- package/elements-web-component.esm.js.map +4 -4
- package/elements.cjs.js +47 -45
- package/elements.cjs.js.map +4 -4
- package/elements.esm.js +47 -45
- package/elements.esm.js.map +4 -4
- package/elements.js +47 -45
- package/elements.js.map +4 -4
- package/index.d.ts +71 -15
- package/index.mjs +19 -19
- package/llms-full.txt +158 -155
- package/llms.txt +19 -19
- package/package.json +7 -1
- package/react.d.ts +71 -15
- package/react.mjs +38 -38
- package/schema.d.ts +49 -7
- package/schema.json +52 -10
- package/schema.mjs +1 -1
- package/step-display.d.ts +215 -0
- package/step-display.mjs +2 -0
- package/style.css +1 -1
- package/web-component.d.ts +49 -9
- package/web-component.mjs +19 -19
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.5.0)
|
|
2
2
|
|
|
3
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
3
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.0/docs/configuration.md).
|
|
275
|
+
- Emit the same [events](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md).
|
|
276
|
+
- Respect the same [isolation guarantees](https://cdn.help.ai/sdk/js/elements/6.5.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.
|
|
@@ -307,7 +307,7 @@ The zero-JavaScript path intentionally exposes a small, flat subset of
|
|
|
307
307
|
| `data-response-mode` | `behavior.responseMode` | `streaming` / `buffered` |
|
|
308
308
|
| `data-start-minimized` | `behavior.startMinimized` | `false` |
|
|
309
309
|
| `data-show-reasoning` | `behavior.showReasoning` | `true` |
|
|
310
|
-
| `data-
|
|
310
|
+
| `data-step-display` | `behavior.stepDisplay` (a preset) | `technical` |
|
|
311
311
|
| `data-show-sources` | `behavior.showSources` | `true` |
|
|
312
312
|
| `data-disable-message-feedback` | `behavior.disableMessageFeedback` | `true` |
|
|
313
313
|
| `data-auto-send-suggestions` | `behavior.autoSendSuggestions` | `true` |
|
|
@@ -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.5.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.5.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.5.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.5.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.5.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.5.0/docs/configuration.md) — every option explained with examples.
|
|
867
|
+
- [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md) — matching your brand.
|
|
868
|
+
- [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/frameworks.md) — framework-specific recipes.
|
|
869
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.0/docs/recipes.md) — programmatic control patterns.
|
|
1521
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md) — analytics integration.
|
|
1522
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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.5.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.5.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.5.0/docs/installation.md) and
|
|
1785
|
+
the framework recipes in [`frameworks.md`](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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
|
|
@@ -2262,7 +2262,7 @@ A message the visitor types while a reply streams waits in the composer's queue.
|
|
|
2262
2262
|
visitor can answer (an approval or questions), the queued message waits this long so a quick answer goes first, then
|
|
2263
2263
|
sends anyway: a card never blocks the visitor. Answering starts the wait again after the next reply; queuing another
|
|
2264
2264
|
message ends it at once. A message sent while nothing is queued always goes straight away, and the card it passes
|
|
2265
|
-
reads Skipped. The queue lives in the visitor's browser, so it only sends while the page is open.
|
|
2265
|
+
reads Replaced (a questions card, Skipped). The queue lives in the visitor's browser, so it only sends while the page is open.
|
|
2266
2266
|
|
|
2267
2267
|
```ts
|
|
2268
2268
|
init({ behavior: { cardAnswerWaitSeconds: 30 } }); // wait 30 s for an answer
|
|
@@ -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.5.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.5.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.5.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.5.0/docs/events-and-hooks.md)
|
|
2569
|
+
- **Theming deep-dive** → [Theming](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md)
|
|
2570
|
+
- **Framework-specific wiring** → [Frameworks](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.0/docs/configuration.md)
|
|
2931
|
+
and [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.0/docs/configuration.md) — options with examples + context.
|
|
3615
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md) — event handling deep-dive.
|
|
3616
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md) — copy-paste scenarios.
|
|
3617
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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.5.0/docs/analytics.md) — GA4, Mixpanel, Segment, Amplitude, PostHog, Sentry, multi-provider
|
|
4120
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md) — copy-paste scenarios
|
|
4121
|
+
- [API reference § events](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/api-reference.md#events) — compact lookup
|
|
4122
|
+
- [Configuration § callbacks](https://cdn.help.ai/sdk/js/elements/6.5.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.5.0/docs/page-tools.md -->
|
|
4127
4127
|
|
|
4128
4128
|
# Page tools
|
|
4129
4129
|
|
|
@@ -4181,14 +4181,15 @@ latest render's function, and React's StrictMode double mount still leaves one r
|
|
|
4181
4181
|
|
|
4182
4182
|
## A tool
|
|
4183
4183
|
|
|
4184
|
-
| Field | What it is
|
|
4185
|
-
| ------------------------------- |
|
|
4186
|
-
| `name` | Letters, digits, `_` and `-`, 58 characters at most; other characters become `_`. The agent sees `site__<name>`. A name registered again replaces the earlier tool.
|
|
4187
|
-
| `description` | When the agent should use it and what it does, 1024 characters at most. The agent picks tools by their descriptions: say when, not only what. Without one, `title` (then `name`) is used.
|
|
4188
|
-
| `title` | Optional.
|
|
4189
|
-
| `
|
|
4190
|
-
| `
|
|
4191
|
-
| `
|
|
4184
|
+
| Field | What it is |
|
|
4185
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
4186
|
+
| `name` | Letters, digits, `_` and `-`, 58 characters at most; other characters become `_`. The agent sees `site__<name>`. A name registered again replaces the earlier tool. |
|
|
4187
|
+
| `description` | When the agent should use it and what it does, 1024 characters at most. The agent picks tools by their descriptions: say when, not only what. Without one, `title` (then `name`) is used. |
|
|
4188
|
+
| `title` | Optional. The action as the visitor reads it, 120 characters at most: "Place your order". The approval asks "Place your order?"; without one the name reads in words ("Place order"). |
|
|
4189
|
+
| `preview` | Optional. `(input) => ({ lines, totals })` (a cart) or `({ number, items, totals })` (an order): what the approval card shows above the input, drawn as the chat's own cart or order card. A preview that throws or returns another shape is left out. |
|
|
4190
|
+
| `inputSchema` | Optional. [JSON Schema](https://json-schema.org/) of the input, an object. The agent fills it in; use `enum` and `required` to keep the input exact. Without one, the tool takes no input. |
|
|
4191
|
+
| `annotations.consequentialHint` | Optional. `true` for a tool with real consequences (an order, a booking, a message to someone): the visitor approves each call in the chat first, and the function runs only on Approve. |
|
|
4192
|
+
| `execute` | `(input, { signal }) => result`. Return a value or a promise of one; throw to report a failure. `signal` aborts when the visitor moves on before the call finishes. |
|
|
4192
4193
|
|
|
4193
4194
|
The `ModelContextTool` and `ToolAnnotations` types are exported for TypeScript; `ModelContextTool<{ sku: string }>`
|
|
4194
4195
|
types `execute`'s input. WebMCP's other annotations (`readOnlyHint`, `untrustedContentHint`) are accepted and not used
|
|
@@ -4282,11 +4283,13 @@ ran from one that didn't; everything else works the same.
|
|
|
4282
4283
|
|
|
4283
4284
|
## What the visitor sees
|
|
4284
4285
|
|
|
4285
|
-
A tool that runs on its own appears
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4286
|
+
A tool that runs on its own appears as a step when the deployment shows steps (`behavior.stepDisplay.showSteps`,
|
|
4287
|
+
`../features/step-display.md`), named by its `title` with your site's host as its
|
|
4288
|
+
system: "Working", then done, "Failed" (or "Didn't work" without step details), or "Stopped" when the visitor stopped
|
|
4289
|
+
it or moved on, or a reload cut it short. A tool with `consequentialHint` shows an approval card, "Place your order?",
|
|
4290
|
+
with its `preview` and every input value; Decline tells the agent the visitor chose not to go ahead, and the function
|
|
4291
|
+
never runs. When the agent's auto mode rules allow the call, there is no card: it runs at once, and reads "Approved
|
|
4292
|
+
automatically" where the deployment shows who decided.
|
|
4290
4293
|
|
|
4291
4294
|
## Events
|
|
4292
4295
|
|
|
@@ -4323,7 +4326,7 @@ on the `dev/page-tools.html` playground, with a real model or the mock backend.
|
|
|
4323
4326
|
|
|
4324
4327
|
---
|
|
4325
4328
|
|
|
4326
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
4329
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md -->
|
|
4327
4330
|
|
|
4328
4331
|
# Theming & customization
|
|
4329
4332
|
|
|
@@ -4651,7 +4654,7 @@ init({
|
|
|
4651
4654
|
|
|
4652
4655
|
## Header actions
|
|
4653
4656
|
|
|
4654
|
-
See [Configuration § Header actions](https://cdn.help.ai/sdk/js/elements/6.
|
|
4657
|
+
See [Configuration § Header actions](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/configuration.md#header-actions)
|
|
4655
4658
|
for the full semantics. Quick customization examples:
|
|
4656
4659
|
|
|
4657
4660
|
### Minimal chrome
|
|
@@ -4857,7 +4860,7 @@ are for what tokens don't cover (shadows, corners, borders).
|
|
|
4857
4860
|
|
|
4858
4861
|
For truly bespoke designs (e.g., replacing the launcher with your
|
|
4859
4862
|
own component), use `launcher.hidden: true` + custom trigger, or a
|
|
4860
|
-
[no-script trigger](https://cdn.help.ai/sdk/js/elements/6.
|
|
4863
|
+
[no-script trigger](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/api-reference.md#no-script-triggers).
|
|
4861
4864
|
|
|
4862
4865
|
---
|
|
4863
4866
|
|
|
@@ -4889,16 +4892,16 @@ can always override.
|
|
|
4889
4892
|
|
|
4890
4893
|
## Next
|
|
4891
4894
|
|
|
4892
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
4895
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md) — listening to chat
|
|
4893
4896
|
interactions, integrating with analytics.
|
|
4894
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
4897
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md) — copy-paste examples for common
|
|
4895
4898
|
customization scenarios.
|
|
4896
|
-
- [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
4899
|
+
- [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/configuration.md) — the full option
|
|
4897
4900
|
table.
|
|
4898
4901
|
|
|
4899
4902
|
---
|
|
4900
4903
|
|
|
4901
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
4904
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md -->
|
|
4902
4905
|
|
|
4903
4906
|
# Recipes
|
|
4904
4907
|
|
|
@@ -5622,13 +5625,13 @@ brand accent set in the dashboard.
|
|
|
5622
5625
|
|
|
5623
5626
|
## Next
|
|
5624
5627
|
|
|
5625
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
5626
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
5627
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
5628
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md) — full event API
|
|
5629
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/configuration.md) — every option
|
|
5630
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/troubleshooting.md) — when things go wrong
|
|
5628
5631
|
|
|
5629
5632
|
---
|
|
5630
5633
|
|
|
5631
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
5634
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/analytics.md -->
|
|
5632
5635
|
|
|
5633
5636
|
# Analytics integration
|
|
5634
5637
|
|
|
@@ -5689,7 +5692,7 @@ event.
|
|
|
5689
5692
|
|
|
5690
5693
|
Every interactive action emits one event with a typed payload. Subscribe
|
|
5691
5694
|
via `chat.on(name, fn)` (instance) or `HelpAI.hook(widgetId, name, fn)`
|
|
5692
|
-
(global, pre-boot-safe). Full schema in [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
5695
|
+
(global, pre-boot-safe). Full schema in [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md).
|
|
5693
5696
|
|
|
5694
5697
|
| Category | Event | Payload |
|
|
5695
5698
|
| ---------------- | --------------------- | -------------------------------------------------- |
|
|
@@ -6209,14 +6212,14 @@ yourself — see the snippets above.
|
|
|
6209
6212
|
|
|
6210
6213
|
## See also
|
|
6211
6214
|
|
|
6212
|
-
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
6213
|
-
- [API reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
6214
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
6215
|
-
- [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.
|
|
6215
|
+
- [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md) — full event reference, payload shapes, pre-boot queue semantics
|
|
6216
|
+
- [API reference](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/api-reference.md) — `ChatWidgetInstance` shape
|
|
6217
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md) — other end-to-end snippets
|
|
6218
|
+
- [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/security-privacy.md) — what data flows where
|
|
6216
6219
|
|
|
6217
6220
|
---
|
|
6218
6221
|
|
|
6219
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
6222
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/security-privacy.md -->
|
|
6220
6223
|
|
|
6221
6224
|
# Security & privacy
|
|
6222
6225
|
|
|
@@ -6405,7 +6408,7 @@ unsent text values in addition to identity and UI state, so adapter code owns
|
|
|
6405
6408
|
their storage destination, retention, and privacy behavior. Use cases include
|
|
6406
6409
|
encrypted `localStorage`, `sessionStorage`, and in-memory consent fallbacks.
|
|
6407
6410
|
|
|
6408
|
-
[Recipes § Custom storage](https://cdn.help.ai/sdk/js/elements/6.
|
|
6411
|
+
[Recipes § Custom storage](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#custom-storage-adapter).
|
|
6409
6412
|
|
|
6410
6413
|
---
|
|
6411
6414
|
|
|
@@ -6824,7 +6827,7 @@ We respond within 24 hours and coordinate disclosure on your schedule.
|
|
|
6824
6827
|
|
|
6825
6828
|
---
|
|
6826
6829
|
|
|
6827
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
6830
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/browser-support.md -->
|
|
6828
6831
|
|
|
6829
6832
|
# Browser support
|
|
6830
6833
|
|
|
@@ -7160,7 +7163,7 @@ with:
|
|
|
7160
7163
|
|
|
7161
7164
|
---
|
|
7162
7165
|
|
|
7163
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
7166
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/troubleshooting.md -->
|
|
7164
7167
|
|
|
7165
7168
|
# Troubleshooting
|
|
7166
7169
|
|
|
@@ -7256,7 +7259,7 @@ for (const k of Object.keys(localStorage)) {
|
|
|
7256
7259
|
3. **Any CSP errors in the console?** — `"Refused to connect to
|
|
7257
7260
|
https://help.ai/api/agent because it violates the following Content
|
|
7258
7261
|
Security Policy…"` means you need to add `help.ai` to your
|
|
7259
|
-
`connect-src`. See [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.
|
|
7262
|
+
`connect-src`. See [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/security-privacy.md#content-security-policy).
|
|
7260
7263
|
|
|
7261
7264
|
---
|
|
7262
7265
|
|
|
@@ -7339,7 +7342,7 @@ first.
|
|
|
7339
7342
|
### Symptom: widget ignores my CSS
|
|
7340
7343
|
|
|
7341
7344
|
That's by design. The widget lives inside a shadow root — your page
|
|
7342
|
-
CSS can't reach inside. Use the [theming options](https://cdn.help.ai/sdk/js/elements/6.
|
|
7345
|
+
CSS can't reach inside. Use the [theming options](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md)
|
|
7343
7346
|
instead.
|
|
7344
7347
|
|
|
7345
7348
|
For advanced customization, override CSS custom properties on the
|
|
@@ -7604,7 +7607,7 @@ font-src 'self' https:;
|
|
|
7604
7607
|
media-src 'self' blob:; # For voice recording
|
|
7605
7608
|
```
|
|
7606
7609
|
|
|
7607
|
-
Full CSP guide: [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.
|
|
7610
|
+
Full CSP guide: [Security § CSP](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/security-privacy.md#content-security-policy).
|
|
7608
7611
|
|
|
7609
7612
|
---
|
|
7610
7613
|
|
|
@@ -7669,7 +7672,7 @@ provide `i18n.availableLocales` and include `language` in `header.actions`.
|
|
|
7669
7672
|
|
|
7670
7673
|
## Getting more help
|
|
7671
7674
|
|
|
7672
|
-
1. **Read the [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
7675
|
+
1. **Read the [FAQ](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/faq.md)** — most common questions answered
|
|
7673
7676
|
there.
|
|
7674
7677
|
|
|
7675
7678
|
2. **Check our GitHub issues**: [github.com/help-ai/elements](https://github.com/help-ai/elements/issues).
|
|
@@ -7688,7 +7691,7 @@ provide `i18n.availableLocales` and include `language` in `header.actions`.
|
|
|
7688
7691
|
|
|
7689
7692
|
---
|
|
7690
7693
|
|
|
7691
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
7694
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/faq.md -->
|
|
7692
7695
|
|
|
7693
7696
|
# FAQ
|
|
7694
7697
|
|
|
@@ -7728,7 +7731,7 @@ own builds. Your public key gates the backend, not the frontend.
|
|
|
7728
7731
|
### What browsers are supported?
|
|
7729
7732
|
|
|
7730
7733
|
Chrome/Edge 111+, Firefox 115+, Safari 16.2+, iOS Safari 16.2+, Samsung Internet 22+. No IE11.
|
|
7731
|
-
On an older browser the widget renders nothing. See [Browser support](https://cdn.help.ai/sdk/js/elements/6.
|
|
7734
|
+
On an older browser the widget renders nothing. See [Browser support](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/browser-support.md).
|
|
7732
7735
|
|
|
7733
7736
|
---
|
|
7734
7737
|
|
|
@@ -7747,11 +7750,11 @@ yourself) and serve it from your CDN. Point your `<script src>` at your hosted
|
|
|
7747
7750
|
URL. Self-hosting is also what unlocks **chunked delivery** (only changed code
|
|
7748
7751
|
re-downloads across releases) behind a single stable URL the customer never has
|
|
7749
7752
|
to change — see
|
|
7750
|
-
[Caching, versioning & self-hosting](https://cdn.help.ai/sdk/js/elements/6.
|
|
7753
|
+
[Caching, versioning & self-hosting](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/installation.md#caching-versioning--self-hosting).
|
|
7751
7754
|
|
|
7752
7755
|
### Can I use this with a tag manager (GTM)?
|
|
7753
7756
|
|
|
7754
|
-
Yes. Use the async loader snippet ([Path B](https://cdn.help.ai/sdk/js/elements/6.
|
|
7757
|
+
Yes. Use the async loader snippet ([Path B](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/installation.md#path-b--async-loader-snippet))
|
|
7755
7758
|
inside a Custom HTML tag. All `HelpAI(...)` calls queue until the
|
|
7756
7759
|
bundle lands.
|
|
7757
7760
|
|
|
@@ -7763,15 +7766,15 @@ custom element on your page). Everything just works.
|
|
|
7763
7766
|
|
|
7764
7767
|
### Does it work with React / Next.js?
|
|
7765
7768
|
|
|
7766
|
-
Yes. Full walkthrough: [Framework integrations § Next.js](https://cdn.help.ai/sdk/js/elements/6.
|
|
7769
|
+
Yes. Full walkthrough: [Framework integrations § Next.js](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/frameworks.md#nextjs).
|
|
7767
7770
|
|
|
7768
7771
|
### Does it work with Vue / Svelte / SolidJS / Angular?
|
|
7769
7772
|
|
|
7770
|
-
Yes. See [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.
|
|
7773
|
+
Yes. See [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/frameworks.md).
|
|
7771
7774
|
|
|
7772
7775
|
### Does it work with WordPress / Shopify / Webflow / Squarespace?
|
|
7773
7776
|
|
|
7774
|
-
Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.
|
|
7777
|
+
Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/frameworks.md#wordpress).
|
|
7775
7778
|
|
|
7776
7779
|
---
|
|
7777
7780
|
|
|
@@ -7780,12 +7783,12 @@ Yes. [Framework integrations § CMS](https://cdn.help.ai/sdk/js/elements/6.4.10/
|
|
|
7780
7783
|
### Can I change the launcher icon?
|
|
7781
7784
|
|
|
7782
7785
|
Yes. Pick from presets (`chat`, `spark`, `message`, `help`, `wand`)
|
|
7783
|
-
or pass raw SVG. See [Theming § Icons](https://cdn.help.ai/sdk/js/elements/6.
|
|
7786
|
+
or pass raw SVG. See [Theming § Icons](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md#icons).
|
|
7784
7787
|
|
|
7785
7788
|
### Can I match my brand colors?
|
|
7786
7789
|
|
|
7787
7790
|
Yes. Set `theme.accent`, `theme.accentText`, `theme.radius`,
|
|
7788
|
-
`theme.fontFamily`. See [Theming § Colors](https://cdn.help.ai/sdk/js/elements/6.
|
|
7791
|
+
`theme.fontFamily`. See [Theming § Colors](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md#color-overrides).
|
|
7789
7792
|
|
|
7790
7793
|
### Can I change the font?
|
|
7791
7794
|
|
|
@@ -7795,7 +7798,7 @@ respects any CSS font stack you provide.
|
|
|
7795
7798
|
### Can I hide the launcher and open the widget from my own button?
|
|
7796
7799
|
|
|
7797
7800
|
Yes. Set `launcher: { hidden: true }`, then call `chat.open()` from
|
|
7798
|
-
your button's click handler. [Recipes § Custom launcher](https://cdn.help.ai/sdk/js/elements/6.
|
|
7801
|
+
your button's click handler. [Recipes § Custom launcher](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#custom-launcher-button).
|
|
7799
7802
|
|
|
7800
7803
|
### Can I change the welcome message?
|
|
7801
7804
|
|
|
@@ -7804,24 +7807,24 @@ widget just renders what the backend sends.
|
|
|
7804
7807
|
|
|
7805
7808
|
### Can I override UI strings?
|
|
7806
7809
|
|
|
7807
|
-
Yes, per-locale or flat. See [Theming § Strings](https://cdn.help.ai/sdk/js/elements/6.
|
|
7810
|
+
Yes, per-locale or flat. See [Theming § Strings](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md#strings-overrides).
|
|
7808
7811
|
|
|
7809
7812
|
### Can I have multiple widgets on one page?
|
|
7810
7813
|
|
|
7811
7814
|
Yes — with distinct `widgetId` values. Each gets its own chat
|
|
7812
|
-
thread, storage, and events. [Recipes § Multi-widget](https://cdn.help.ai/sdk/js/elements/6.
|
|
7815
|
+
thread, storage, and events. [Recipes § Multi-widget](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#multiple-widgets-on-one-page).
|
|
7813
7816
|
|
|
7814
7817
|
### Can I show the widget only on certain pages?
|
|
7815
7818
|
|
|
7816
7819
|
Yes — just skip the `init()` call on pages where you don't want it.
|
|
7817
7820
|
Or conditionally mount/unmount based on the URL.
|
|
7818
|
-
[Recipes § Conditional show](https://cdn.help.ai/sdk/js/elements/6.
|
|
7821
|
+
[Recipes § Conditional show](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#conditionally-show-based-on-url).
|
|
7819
7822
|
|
|
7820
7823
|
### Can I use it in a specific language?
|
|
7821
7824
|
|
|
7822
7825
|
Yes. Force via `i18n.locale: 'fr-CA'`. Let users switch via
|
|
7823
7826
|
`i18n.availableLocales: ['en', 'fr', 'es']`. Full details: [Theming §
|
|
7824
|
-
Internationalization](https://cdn.help.ai/sdk/js/elements/6.
|
|
7827
|
+
Internationalization](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md#internationalization).
|
|
7825
7828
|
|
|
7826
7829
|
### Can I change the widget's position on mobile?
|
|
7827
7830
|
|
|
@@ -7858,7 +7861,7 @@ allowlisted event metadata through 1×1 pixel requests; it never sends message
|
|
|
7858
7861
|
text or form values and can be disabled with `tracking.enabled: false`. GPC and
|
|
7859
7862
|
DNT disable it automatically. No cookies or fingerprinting.
|
|
7860
7863
|
|
|
7861
|
-
Full breakdown: [Security & privacy § data collected](https://cdn.help.ai/sdk/js/elements/6.
|
|
7864
|
+
Full breakdown: [Security & privacy § data collected](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/security-privacy.md#what-data-the-widget-collects).
|
|
7862
7865
|
|
|
7863
7866
|
### Does the widget use cookies?
|
|
7864
7867
|
|
|
@@ -7878,7 +7881,7 @@ Help AI API + your deployment's configured model provider.
|
|
|
7878
7881
|
It stores data about identified users (when you pass `user.id`) or
|
|
7879
7882
|
anonymous visitors. Your DPA (Data Processing Agreement) with Help
|
|
7880
7883
|
AI covers the processing terms. For consent management, see
|
|
7881
|
-
[Recipes § Gate behind consent](https://cdn.help.ai/sdk/js/elements/6.
|
|
7884
|
+
[Recipes § Gate behind consent](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#gate-the-widget-behind-consent).
|
|
7882
7885
|
|
|
7883
7886
|
### Can visitors delete their chat history?
|
|
7884
7887
|
|
|
@@ -7893,7 +7896,7 @@ Yes — pass a custom in-memory storage adapter. Adapter-managed identity,
|
|
|
7893
7896
|
conversation, draft, preference, and UI state then evaporates on reload. The
|
|
7894
7897
|
optional logger debug level is separate: calling `setDebug` persists
|
|
7895
7898
|
`helpai.debug` directly in `localStorage` until the host clears it.
|
|
7896
|
-
[Recipes § Custom storage adapter](https://cdn.help.ai/sdk/js/elements/6.
|
|
7899
|
+
[Recipes § Custom storage adapter](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#custom-storage-adapter).
|
|
7897
7900
|
|
|
7898
7901
|
### Does the widget track visitors across sites?
|
|
7899
7902
|
|
|
@@ -7918,7 +7921,7 @@ init({
|
|
|
7918
7921
|
not an auth credential. Browser public access uses the matching
|
|
7919
7922
|
`publicKey` + `aiAgentDeploymentId` pair, or the deployment ID alone for
|
|
7920
7923
|
intentional guest mode.
|
|
7921
|
-
See [Recipes § Logged-in user personalization](https://cdn.help.ai/sdk/js/elements/6.
|
|
7924
|
+
See [Recipes § Logged-in user personalization](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#logged-in-user-personalization).
|
|
7922
7925
|
|
|
7923
7926
|
### How do I integrate with my analytics (GA / Segment / Mixpanel)?
|
|
7924
7927
|
|
|
@@ -7937,7 +7940,7 @@ One-line pre-boot hook forwards every event:
|
|
|
7937
7940
|
</script>
|
|
7938
7941
|
```
|
|
7939
7942
|
|
|
7940
|
-
Full examples: [Recipes § Analytics forwarding](https://cdn.help.ai/sdk/js/elements/6.
|
|
7943
|
+
Full examples: [Recipes § Analytics forwarding](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md#analytics-forwarding).
|
|
7941
7944
|
|
|
7942
7945
|
### How do I capture errors in Sentry / Datadog?
|
|
7943
7946
|
|
|
@@ -8122,7 +8125,7 @@ table.
|
|
|
8122
8125
|
|
|
8123
8126
|
---
|
|
8124
8127
|
|
|
8125
|
-
<!-- https://cdn.help.ai/sdk/js/elements/6.
|
|
8128
|
+
<!-- https://cdn.help.ai/sdk/js/elements/6.5.0/docs/README.md -->
|
|
8126
8129
|
|
|
8127
8130
|
# Help AI Elements — SDK Documentation
|
|
8128
8131
|
|
|
@@ -8150,7 +8153,7 @@ it → the panel opens → they can chat.
|
|
|
8150
8153
|
Get the public key and deployment ID from [help.ai](https://help.ai) →
|
|
8151
8154
|
**Dashboard → Deployments**.
|
|
8152
8155
|
|
|
8153
|
-
[**Continue with the quickstart →**](https://cdn.help.ai/sdk/js/elements/6.
|
|
8156
|
+
[**Continue with the quickstart →**](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/quickstart.md)
|
|
8154
8157
|
|
|
8155
8158
|
---
|
|
8156
8159
|
|
|
@@ -8158,20 +8161,20 @@ Get the public key and deployment ID from [help.ai](https://help.ai) →
|
|
|
8158
8161
|
|
|
8159
8162
|
| You want to… | Read |
|
|
8160
8163
|
| ----------------------------------------------------------- | --------------------------------------------- |
|
|
8161
|
-
| Install the widget end-to-end | [**Quickstart**](https://cdn.help.ai/sdk/js/elements/6.
|
|
8162
|
-
| See every install method (NPM, Web Component, React) | [Installation](https://cdn.help.ai/sdk/js/elements/6.
|
|
8163
|
-
| Customize every option | [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
8164
|
-
| Match my brand colors and typography | [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.
|
|
8165
|
-
| Send chat events to my analytics | [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
8166
|
-
| Wire GA4 / Mixpanel / Segment / multi-provider | [Analytics integration](https://cdn.help.ai/sdk/js/elements/6.
|
|
8167
|
-
| Integrate with Next.js / Vue / Svelte / WordPress / Shopify | [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.
|
|
8168
|
-
| Copy a working example | [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
8169
|
-
| Let the AI agent act on my page | [Page tools](https://cdn.help.ai/sdk/js/elements/6.
|
|
8170
|
-
| Diagnose "why isn't this working" | [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
8171
|
-
| Quick answer to a common question | [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
8172
|
-
| Compact API reference for lookup | [API reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
8173
|
-
| Understand what data the widget sees | [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.
|
|
8174
|
-
| Check browser compatibility | [Browser support](https://cdn.help.ai/sdk/js/elements/6.
|
|
8164
|
+
| Install the widget end-to-end | [**Quickstart**](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/quickstart.md) |
|
|
8165
|
+
| See every install method (NPM, Web Component, React) | [Installation](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/installation.md) |
|
|
8166
|
+
| Customize every option | [Configuration reference](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/configuration.md) |
|
|
8167
|
+
| Match my brand colors and typography | [Theming & customization](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md) |
|
|
8168
|
+
| Send chat events to my analytics | [Events & hooks](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/events-and-hooks.md) |
|
|
8169
|
+
| Wire GA4 / Mixpanel / Segment / multi-provider | [Analytics integration](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/analytics.md) |
|
|
8170
|
+
| Integrate with Next.js / Vue / Svelte / WordPress / Shopify | [Framework integrations](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/frameworks.md) |
|
|
8171
|
+
| Copy a working example | [Recipes](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md) |
|
|
8172
|
+
| Let the AI agent act on my page | [Page tools](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/page-tools.md) |
|
|
8173
|
+
| Diagnose "why isn't this working" | [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/troubleshooting.md) |
|
|
8174
|
+
| Quick answer to a common question | [FAQ](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/faq.md) |
|
|
8175
|
+
| Compact API reference for lookup | [API reference](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/api-reference.md) |
|
|
8176
|
+
| Understand what data the widget sees | [Security & privacy](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/security-privacy.md) |
|
|
8177
|
+
| Check browser compatibility | [Browser support](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/browser-support.md) |
|
|
8175
8178
|
|
|
8176
8179
|
---
|
|
8177
8180
|
|
|
@@ -8233,7 +8236,7 @@ Five ways to install. Pick whichever fits your site:
|
|
|
8233
8236
|
| **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'` |
|
|
8234
8237
|
|
|
8235
8238
|
All five use the same underlying library. Same options, same events,
|
|
8236
|
-
same behavior. Full comparison: [Installation](https://cdn.help.ai/sdk/js/elements/6.
|
|
8239
|
+
same behavior. Full comparison: [Installation](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/installation.md).
|
|
8237
8240
|
|
|
8238
8241
|
---
|
|
8239
8242
|
|
|
@@ -8288,14 +8291,14 @@ fuller example showing the most common options in one place:
|
|
|
8288
8291
|
</script>
|
|
8289
8292
|
```
|
|
8290
8293
|
|
|
8291
|
-
Every option explained in [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
8292
|
-
customization path in [Theming](https://cdn.help.ai/sdk/js/elements/6.
|
|
8294
|
+
Every option explained in [Configuration](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/configuration.md). Every
|
|
8295
|
+
customization path in [Theming](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/theming.md).
|
|
8293
8296
|
|
|
8294
8297
|
---
|
|
8295
8298
|
|
|
8296
8299
|
## Support
|
|
8297
8300
|
|
|
8298
|
-
- **Questions?** [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
8301
|
+
- **Questions?** [FAQ](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/faq.md) — common answers first. [support@help.ai](mailto:support@help.ai) for anything else.
|
|
8299
8302
|
- **Found a bug?** File an issue at [github.com/help-ai/elements](https://github.com/help-ai/elements/issues).
|
|
8300
8303
|
- **Need a feature?** Same place — we read every request.
|
|
8301
8304
|
- **Status page:** [help.ai/status](https://help.ai/status).
|