@helpai/elements 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/analytics.md +6 -1
- package/docs/api-reference.md +2 -2
- package/docs/events-and-hooks.md +1 -1
- package/docs/installation.md +4 -4
- package/docs/security-privacy.md +7 -4
- package/elements-web-component.esm.js +39 -35
- package/elements-web-component.esm.js.map +4 -4
- package/elements.cjs.js +39 -35
- package/elements.cjs.js.map +4 -4
- package/elements.esm.js +40 -36
- package/elements.esm.js.map +4 -4
- package/elements.js +38 -34
- package/elements.js.map +4 -4
- package/index.mjs +4 -3
- package/llms-full.txt +161 -153
- package/llms.txt +19 -19
- package/package.json +3 -3
- package/react.mjs +31 -30
- package/web-component.mjs +4 -3
package/llms.txt
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Help AI Elements
|
|
2
2
|
|
|
3
|
-
> Help AI's AI chat widget for any website: an AI agent that answers visitors from the customer's own help content, can hand the chat to a person, and shows Help articles and News. Install it with one script tag, the `<web-ai-chat>` element, the npm API or the React kit. These docs match @helpai/elements@1.
|
|
3
|
+
> Help AI's AI chat widget for any website: an AI agent that answers visitors from the customer's own help content, can hand the chat to a person, and shows Help articles and News. Install it with one script tag, the `<web-ai-chat>` element, the npm API or the React kit. These docs match @helpai/elements@1.12.0.
|
|
4
4
|
|
|
5
5
|
What a coding agent needs to install it right the first time:
|
|
6
6
|
|
|
7
7
|
- Two values come from the deployment's Install page in the Help AI dashboard: the public key (`agent_pk_…`) and the AI agent deployment id (a UUID). Both belong in browser code. The deployment's secret key never does.
|
|
8
|
-
- Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/1.
|
|
8
|
+
- Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/1.12.0/elements.js" data-public-key="agent_pk_…" data-ai-agent-deployment-id="…" defer></script>`.
|
|
9
9
|
- React, Next.js, Remix: install `@helpai/elements` and render `<HelpAI publicKey="…" aiAgentDeploymentId="…" />` from `@helpai/elements/react` once, in the root layout. `useHelpAI()` in any component returns `{ state, ask, open, close, reset }`. It is server-render safe; import everything from `@helpai/elements/react`.
|
|
10
10
|
- Vue, Svelte, Angular and other bundlers: `import '@helpai/elements/web-component'`, then `<web-ai-chat public-key="…" ai-agent-deployment-id="…"></web-ai-chat>`. JSX typings: `@helpai/elements/jsx/react`, `/jsx/vue`, `/jsx/svelte`.
|
|
11
11
|
- Site buttons need no JavaScript: `data-helpai-ask="Which plan fits a team of 10?"` puts the question in the chat, `data-helpai-open="help"` opens a tab (`home`, `chats`, `help`, `news`). In code, `ask(text)` fills the composer and sends only with `{ send: true }`.
|
|
@@ -18,23 +18,23 @@ What a coding agent needs to install it right the first time:
|
|
|
18
18
|
|
|
19
19
|
## Docs
|
|
20
20
|
|
|
21
|
-
- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.
|
|
22
|
-
- [Installation](https://cdn.help.ai/sdk/js/elements/1.
|
|
23
|
-
- [Frameworks](https://cdn.help.ai/sdk/js/elements/1.
|
|
24
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/1.
|
|
25
|
-
- [Option reference](https://cdn.help.ai/sdk/js/elements/1.
|
|
26
|
-
- [API reference](https://cdn.help.ai/sdk/js/elements/1.
|
|
27
|
-
- [Events and hooks](https://cdn.help.ai/sdk/js/elements/1.
|
|
28
|
-
- [Page tools](https://cdn.help.ai/sdk/js/elements/1.
|
|
29
|
-
- [Theming](https://cdn.help.ai/sdk/js/elements/1.
|
|
30
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/1.
|
|
31
|
-
- [Analytics](https://cdn.help.ai/sdk/js/elements/1.
|
|
32
|
-
- [Security and privacy](https://cdn.help.ai/sdk/js/elements/1.
|
|
33
|
-
- [Browser support](https://cdn.help.ai/sdk/js/elements/1.
|
|
34
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.
|
|
35
|
-
- [FAQ](https://cdn.help.ai/sdk/js/elements/1.
|
|
36
|
-
- [Overview](https://cdn.help.ai/sdk/js/elements/1.
|
|
21
|
+
- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
|
|
22
|
+
- [Installation](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/installation.md): every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning
|
|
23
|
+
- [Frameworks](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/frameworks.md): the React kit (`<HelpAI />`, `useHelpAI()`), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow
|
|
24
|
+
- [Configuration](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/configuration.md): every option by group, with examples
|
|
25
|
+
- [Option reference](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/options.md): the table of every option, generated from the schemas; authoritative
|
|
26
|
+
- [API reference](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/api-reference.md): exports, instance methods (`ask`, `open`, `state`, `ready`, `reset`, …), the global API, no-script triggers, deep links, JSX typings
|
|
27
|
+
- [Events and hooks](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
|
|
28
|
+
- [Page tools](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/page-tools.md): WebMCP-shaped tools the AI agent calls on your page (`registerTool`, `tools`, `useHelpAITool`, `<form toolname>`), run once in the browser
|
|
29
|
+
- [Theming](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
|
|
30
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/recipes.md): copy-paste solutions for common integrations
|
|
31
|
+
- [Analytics](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/analytics.md): sending widget activity to Google Analytics, Segment, PostHog and other trackers
|
|
32
|
+
- [Security and privacy](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
|
|
33
|
+
- [Browser support](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/browser-support.md): supported browsers and fallbacks
|
|
34
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/troubleshooting.md): an install that does not show, connect or answer
|
|
35
|
+
- [FAQ](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/faq.md): short answers to common questions
|
|
36
|
+
- [Overview](https://cdn.help.ai/sdk/js/elements/1.12.0/docs/README.md): the whole SDK on one page
|
|
37
37
|
|
|
38
38
|
## Optional
|
|
39
39
|
|
|
40
|
-
- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.
|
|
40
|
+
- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.12.0/llms-full.txt): the docs above, concatenated
|
package/package.json
CHANGED
|
@@ -95,8 +95,8 @@
|
|
|
95
95
|
"module": "./index.mjs",
|
|
96
96
|
"name": "@helpai/elements",
|
|
97
97
|
"dependencies": {
|
|
98
|
-
"@preact/signals": "^2.11.
|
|
99
|
-
"preact": "^11.0
|
|
98
|
+
"@preact/signals": "^2.11.4",
|
|
99
|
+
"preact": "^11.1.0",
|
|
100
100
|
"streaming-markdown": "^0.2.15",
|
|
101
101
|
"zod": "^4.6.7"
|
|
102
102
|
},
|
|
@@ -117,5 +117,5 @@
|
|
|
117
117
|
],
|
|
118
118
|
"type": "module",
|
|
119
119
|
"types": "./index.d.ts",
|
|
120
|
-
"version": "1.
|
|
120
|
+
"version": "1.12.0"
|
|
121
121
|
}
|