@kitn.ai/ui 0.14.1
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/LICENSE +21 -0
- package/README.md +394 -0
- package/dist/bash-InADTalH.js +1 -0
- package/dist/core-AYMC6_lb.js +12 -0
- package/dist/css-M7EaDHN_.js +1 -0
- package/dist/custom-elements.json +4739 -0
- package/dist/engine-javascript-vq0WuIJl.js +141 -0
- package/dist/github-dark-dimmed-DUshB20C.js +1 -0
- package/dist/github-light-JYsPkUQd.js +1 -0
- package/dist/host-embed.d.ts +33 -0
- package/dist/html-CPZ3oZQ7.js +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/javascript-C25yR2R2.js +1 -0
- package/dist/json-DxJze_jm.js +1 -0
- package/dist/kitn-chat-provider.d.ts +2 -0
- package/dist/kitn-chat-provider.es.js +240 -0
- package/dist/kitn-chat.es.js +77 -0
- package/dist/llms/llms-full.txt +1018 -0
- package/dist/llms/llms.txt +104 -0
- package/dist/origin.d.ts +5 -0
- package/dist/provider-runtime.d.ts +27 -0
- package/dist/schemas/card-envelope.schema.json +14 -0
- package/dist/schemas/card-event.schema.json +12 -0
- package/dist/schemas/choice.schema.json +70 -0
- package/dist/schemas/confirm.schema.json +65 -0
- package/dist/schemas/embed.schema.json +65 -0
- package/dist/schemas/form.result.schema.json +7 -0
- package/dist/schemas/form.schema.json +33 -0
- package/dist/schemas/link.schema.json +56 -0
- package/dist/schemas/tasks.result.schema.json +16 -0
- package/dist/schemas/tasks.schema.json +78 -0
- package/dist/svelte--5p79yCD.js +1 -0
- package/dist/theme.tokens.css +176 -0
- package/dist/tsx-B8rCNbgL.js +1 -0
- package/dist/typescript-RycA9KXf.js +1 -0
- package/dist/validate.d.ts +4 -0
- package/dist/version.d.ts +4 -0
- package/dist/vue-BmIZj4XD.js +1 -0
- package/dist/wire.d.ts +53 -0
- package/frameworks/react/index.tsx +948 -0
- package/frameworks/react/runtime.tsx +94 -0
- package/llms-full.txt +1018 -0
- package/llms.txt +104 -0
- package/package.json +141 -0
- package/src/components/artifact.stories.tsx +138 -0
- package/src/components/artifact.tsx +743 -0
- package/src/components/attachments.stories.tsx +303 -0
- package/src/components/attachments.test.tsx +64 -0
- package/src/components/attachments.tsx +399 -0
- package/src/components/card-fallback.tsx +28 -0
- package/src/components/card-renderer.tsx +52 -0
- package/src/components/card.tsx +110 -0
- package/src/components/chain-of-thought.stories.tsx +211 -0
- package/src/components/chain-of-thought.tsx +139 -0
- package/src/components/chat-container.stories.tsx +187 -0
- package/src/components/chat-container.tsx +82 -0
- package/src/components/chat-scope-picker.tsx +47 -0
- package/src/components/chat-thread.test.tsx +58 -0
- package/src/components/chat-thread.tsx +249 -0
- package/src/components/checkpoint.stories.tsx +102 -0
- package/src/components/checkpoint.tsx +88 -0
- package/src/components/choice-card.tsx +569 -0
- package/src/components/code-block.stories.tsx +150 -0
- package/src/components/code-block.tsx +105 -0
- package/src/components/component-meta.json +3735 -0
- package/src/components/confirm-card.stories.tsx +74 -0
- package/src/components/confirm-card.tsx +315 -0
- package/src/components/context.stories.tsx +229 -0
- package/src/components/context.test.tsx +133 -0
- package/src/components/context.tsx +363 -0
- package/src/components/conversation-item.stories.tsx +125 -0
- package/src/components/conversation-item.tsx +16 -0
- package/src/components/conversation-list.stories.tsx +133 -0
- package/src/components/conversation-list.tsx +101 -0
- package/src/components/default-input.test.tsx +111 -0
- package/src/components/embed.tsx +196 -0
- package/src/components/empty.stories.tsx +434 -0
- package/src/components/empty.tsx +166 -0
- package/src/components/feedback-bar.stories.tsx +138 -0
- package/src/components/feedback-bar.test.tsx +103 -0
- package/src/components/feedback-bar.tsx +166 -0
- package/src/components/file-tree.stories.tsx +73 -0
- package/src/components/file-tree.tsx +383 -0
- package/src/components/file-upload.stories.tsx +156 -0
- package/src/components/file-upload.tsx +161 -0
- package/src/components/form-widgets.tsx +461 -0
- package/src/components/form.tsx +873 -0
- package/src/components/image.stories.tsx +89 -0
- package/src/components/image.tsx +67 -0
- package/src/components/link-preview.tsx +194 -0
- package/src/components/loader.stories.tsx +181 -0
- package/src/components/loader.tsx +333 -0
- package/src/components/markdown.stories.tsx +180 -0
- package/src/components/markdown.tsx +81 -0
- package/src/components/message-action-bar.test.tsx +128 -0
- package/src/components/message-narrow.stories.tsx +329 -0
- package/src/components/message-skills.stories.tsx +211 -0
- package/src/components/message-skills.tsx +36 -0
- package/src/components/message.stories.tsx +281 -0
- package/src/components/message.tsx +227 -0
- package/src/components/model-switcher.stories.tsx +123 -0
- package/src/components/model-switcher.test.tsx +65 -0
- package/src/components/model-switcher.tsx +87 -0
- package/src/components/prompt-input.stories.tsx +222 -0
- package/src/components/prompt-input.tsx +211 -0
- package/src/components/prompt-suggestion.stories.tsx +142 -0
- package/src/components/prompt-suggestion.tsx +115 -0
- package/src/components/reasoning.stories.tsx +140 -0
- package/src/components/reasoning.tsx +156 -0
- package/src/components/resizable.test.tsx +226 -0
- package/src/components/response-stream.tsx +103 -0
- package/src/components/scroll-button.stories.tsx +100 -0
- package/src/components/scroll-button.tsx +34 -0
- package/src/components/slash-command.stories.tsx +163 -0
- package/src/components/slash-command.tsx +232 -0
- package/src/components/source-list.test.tsx +152 -0
- package/src/components/source.stories.tsx +124 -0
- package/src/components/source.tsx +129 -0
- package/src/components/tasks-card.stories.tsx +78 -0
- package/src/components/tasks-card.tsx +432 -0
- package/src/components/text-shimmer.stories.tsx +87 -0
- package/src/components/text-shimmer.tsx +37 -0
- package/src/components/thinking-bar.stories.tsx +87 -0
- package/src/components/thinking-bar.tsx +50 -0
- package/src/components/tool.stories.tsx +153 -0
- package/src/components/tool.tsx +184 -0
- package/src/components/use-card-resolution.ts +28 -0
- package/src/components/voice-input.stories.tsx +83 -0
- package/src/components/voice-input.tsx +107 -0
- package/src/elements/artifact.stories.tsx +506 -0
- package/src/elements/artifact.tsx +137 -0
- package/src/elements/attachments.stories.tsx +190 -0
- package/src/elements/attachments.tsx +136 -0
- package/src/elements/card.stories.tsx +113 -0
- package/src/elements/card.tsx +40 -0
- package/src/elements/cards.stories.tsx +59 -0
- package/src/elements/cards.tsx +97 -0
- package/src/elements/catalog.stories.tsx +491 -0
- package/src/elements/chain-of-thought.declarative.test.tsx +153 -0
- package/src/elements/chain-of-thought.stories.tsx +113 -0
- package/src/elements/chain-of-thought.tsx +92 -0
- package/src/elements/chat-scope-picker.stories.tsx +73 -0
- package/src/elements/chat-scope-picker.tsx +36 -0
- package/src/elements/chat-types.ts +42 -0
- package/src/elements/chat-workspace.stories.tsx +288 -0
- package/src/elements/chat-workspace.tsx +161 -0
- package/src/elements/chat.stories.tsx +151 -0
- package/src/elements/chat.tsx +80 -0
- package/src/elements/checkpoint.stories.tsx +72 -0
- package/src/elements/checkpoint.tsx +47 -0
- package/src/elements/choice.stories.tsx +240 -0
- package/src/elements/choice.tsx +48 -0
- package/src/elements/code-block.stories.tsx +83 -0
- package/src/elements/code-block.tsx +42 -0
- package/src/elements/compiled.css +2 -0
- package/src/elements/composed-shell.stories.tsx +316 -0
- package/src/elements/confirm-card.stories.tsx +227 -0
- package/src/elements/confirm-card.tsx +51 -0
- package/src/elements/context-meter.stories.tsx +151 -0
- package/src/elements/context-meter.tsx +121 -0
- package/src/elements/conversation-list.declarative.test.tsx +137 -0
- package/src/elements/conversation-list.stories.tsx +243 -0
- package/src/elements/conversation-list.tsx +80 -0
- package/src/elements/css.ts +5 -0
- package/src/elements/default-input.tsx +247 -0
- package/src/elements/define.tsx +171 -0
- package/src/elements/element-meta.json +3314 -0
- package/src/elements/element-types.d.ts +710 -0
- package/src/elements/embed.stories.tsx +213 -0
- package/src/elements/embed.tsx +35 -0
- package/src/elements/empty.stories.tsx +111 -0
- package/src/elements/empty.tsx +29 -0
- package/src/elements/feedback-bar.stories.tsx +114 -0
- package/src/elements/feedback-bar.tsx +61 -0
- package/src/elements/file-tree.stories.tsx +134 -0
- package/src/elements/file-tree.tsx +52 -0
- package/src/elements/file-upload.stories.tsx +82 -0
- package/src/elements/file-upload.tsx +44 -0
- package/src/elements/form.stories.tsx +248 -0
- package/src/elements/form.tsx +43 -0
- package/src/elements/framework-usage.json +563 -0
- package/src/elements/image.stories.tsx +71 -0
- package/src/elements/image.tsx +32 -0
- package/src/elements/link-preview.stories.tsx +209 -0
- package/src/elements/link-preview.tsx +34 -0
- package/src/elements/loader.stories.tsx +88 -0
- package/src/elements/loader.tsx +25 -0
- package/src/elements/markdown.stories.tsx +76 -0
- package/src/elements/markdown.tsx +38 -0
- package/src/elements/message-skills.declarative.test.tsx +104 -0
- package/src/elements/message-skills.stories.tsx +114 -0
- package/src/elements/message-skills.tsx +85 -0
- package/src/elements/message.stories.tsx +218 -0
- package/src/elements/message.tsx +162 -0
- package/src/elements/model-switcher.declarative.test.tsx +130 -0
- package/src/elements/model-switcher.stories.tsx +198 -0
- package/src/elements/model-switcher.tsx +93 -0
- package/src/elements/popover.stories.tsx +80 -0
- package/src/elements/popover.tsx +59 -0
- package/src/elements/prompt-input-slash-command.test.tsx +128 -0
- package/src/elements/prompt-input-stoppable.test.tsx +88 -0
- package/src/elements/prompt-input-toolbar-actions.test.tsx +120 -0
- package/src/elements/prompt-input.stories.tsx +331 -0
- package/src/elements/prompt-input.tsx +185 -0
- package/src/elements/prompt-suggestions.declarative.test.tsx +164 -0
- package/src/elements/prompt-suggestions.stories.tsx +213 -0
- package/src/elements/prompt-suggestions.tsx +94 -0
- package/src/elements/reasoning.stories.tsx +77 -0
- package/src/elements/reasoning.tsx +50 -0
- package/src/elements/register.ts +56 -0
- package/src/elements/remote.stories.tsx +314 -0
- package/src/elements/remote.tsx +221 -0
- package/src/elements/resizable.d.ts +27 -0
- package/src/elements/resizable.stories.tsx +426 -0
- package/src/elements/resizable.tsx +553 -0
- package/src/elements/response-stream.stories.tsx +79 -0
- package/src/elements/response-stream.tsx +40 -0
- package/src/elements/scroll-button.stories.tsx +202 -0
- package/src/elements/scroll-button.test.tsx +148 -0
- package/src/elements/scroll-button.tsx +126 -0
- package/src/elements/source-list.stories.tsx +143 -0
- package/src/elements/source.stories.tsx +88 -0
- package/src/elements/source.tsx +120 -0
- package/src/elements/styles.css +199 -0
- package/src/elements/switch.stories.tsx +56 -0
- package/src/elements/switch.tsx +43 -0
- package/src/elements/tasks.stories.tsx +237 -0
- package/src/elements/tasks.tsx +46 -0
- package/src/elements/text-shimmer.stories.tsx +64 -0
- package/src/elements/text-shimmer.tsx +28 -0
- package/src/elements/thinking-bar.stories.tsx +72 -0
- package/src/elements/thinking-bar.tsx +34 -0
- package/src/elements/tool.stories.tsx +89 -0
- package/src/elements/tool.tsx +23 -0
- package/src/elements/voice-input.stories.tsx +88 -0
- package/src/elements/voice-input.tsx +41 -0
- package/src/index.ts +253 -0
- package/src/primitives/card-contract.ts +71 -0
- package/src/primitives/card-host.tsx +35 -0
- package/src/primitives/card-registry.tsx +67 -0
- package/src/primitives/card-resolution.ts +36 -0
- package/src/primitives/card-routing.ts +79 -0
- package/src/primitives/card-schemas/card-envelope.schema.json +14 -0
- package/src/primitives/card-schemas/card-event.schema.json +12 -0
- package/src/primitives/card-schemas/choice.schema.json +70 -0
- package/src/primitives/card-schemas/confirm.schema.json +65 -0
- package/src/primitives/card-schemas/embed.schema.json +65 -0
- package/src/primitives/card-schemas/form.result.schema.json +7 -0
- package/src/primitives/card-schemas/form.schema.json +33 -0
- package/src/primitives/card-schemas/link.schema.json +56 -0
- package/src/primitives/card-schemas/tasks.result.schema.json +16 -0
- package/src/primitives/card-schemas/tasks.schema.json +78 -0
- package/src/primitives/card-validate.ts +95 -0
- package/src/primitives/chat-config.tsx +76 -0
- package/src/primitives/controllable.test.ts +47 -0
- package/src/primitives/controllable.ts +21 -0
- package/src/primitives/embed-providers.ts +254 -0
- package/src/primitives/highlighter.ts +157 -0
- package/src/primitives/link-preview.ts +87 -0
- package/src/primitives/pdf-preview.ts +121 -0
- package/src/primitives/use-auto-resize.ts +31 -0
- package/src/primitives/use-resize-observer.ts +12 -0
- package/src/primitives/use-stick-to-bottom.ts +43 -0
- package/src/primitives/use-text-stream.ts +112 -0
- package/src/primitives/use-voice-recorder.ts +50 -0
- package/src/remote/host-embed.ts +345 -0
- package/src/remote/index.ts +2 -0
- package/src/remote/origin.ts +30 -0
- package/src/remote/provider-runtime.ts +259 -0
- package/src/remote/provider.ts +2 -0
- package/src/remote/validate.ts +22 -0
- package/src/remote/version.ts +12 -0
- package/src/remote/wire.ts +48 -0
- package/src/stories/chat-panel-layout.stories.tsx +145 -0
- package/src/stories/chat-scene.tsx +571 -0
- package/src/stories/checkpoint-restore.stories.tsx +256 -0
- package/src/stories/context-usage.stories.tsx +212 -0
- package/src/stories/conversation-with-reasoning.stories.tsx +182 -0
- package/src/stories/conversation-with-sources.stories.tsx +471 -0
- package/src/stories/docs/Accessibility.mdx +119 -0
- package/src/stories/docs/ChildElements.mdx +269 -0
- package/src/stories/docs/ForAIAgents.mdx +162 -0
- package/src/stories/docs/GettingStarted.mdx +65 -0
- package/src/stories/docs/Installation.mdx +83 -0
- package/src/stories/docs/Introduction.mdx +50 -0
- package/src/stories/docs/SolidJsAdvanced.mdx +17 -0
- package/src/stories/docs/Theming.mdx +85 -0
- package/src/stories/docs/element-controls.ts +121 -0
- package/src/stories/docs/frameworks/Angular.mdx +245 -0
- package/src/stories/docs/frameworks/Html.mdx +227 -0
- package/src/stories/docs/frameworks/Overview.mdx +47 -0
- package/src/stories/docs/frameworks/React.mdx +227 -0
- package/src/stories/docs/frameworks/Solid.mdx +173 -0
- package/src/stories/docs/frameworks/Svelte.mdx +194 -0
- package/src/stories/docs/frameworks/Vue.mdx +238 -0
- package/src/stories/docs/generative-ui-overview.mdx +186 -0
- package/src/stories/docs/recipes/SpeechToText.mdx +7 -0
- package/src/stories/docs/recipes/Streaming.mdx +68 -0
- package/src/stories/docs/recipes/TextToSpeech.mdx +35 -0
- package/src/stories/docs/theme-editor/canvas.tsx +32 -0
- package/src/stories/docs/theme-editor/inspector.tsx +66 -0
- package/src/stories/docs/theme-editor/presets.test.ts +32 -0
- package/src/stories/docs/theme-editor/presets.ts +64 -0
- package/src/stories/docs/theme-editor/theme-css.test.ts +19 -0
- package/src/stories/docs/theme-editor/theme-css.ts +15 -0
- package/src/stories/docs/theme-editor/theme-editor.tsx +146 -0
- package/src/stories/docs/theme-tokens.tsx +174 -0
- package/src/stories/examples/ChoosingComponents.mdx +106 -0
- package/src/stories/examples/sample-data.ts +79 -0
- package/src/stories/examples/usage/checkpoint-restore.ts +156 -0
- package/src/stories/examples/usage/context-usage.ts +591 -0
- package/src/stories/examples/usage/conversation-with-reasoning.ts +224 -0
- package/src/stories/examples/usage/conversation-with-sources.ts +589 -0
- package/src/stories/examples/usage/empty-state.ts +144 -0
- package/src/stories/examples/usage/full-chat-app.ts +277 -0
- package/src/stories/examples/usage/index.ts +63 -0
- package/src/stories/examples/usage/message-actions.ts +704 -0
- package/src/stories/examples/usage/pattern-centered-conversation.ts +446 -0
- package/src/stories/examples/usage/pattern-chat-panel-layout.ts +442 -0
- package/src/stories/examples/usage/pattern-docked-widget.ts +479 -0
- package/src/stories/examples/usage/prompt-input-variants.ts +1356 -0
- package/src/stories/examples/usage/streaming-response.ts +687 -0
- package/src/stories/examples/usage/types.ts +33 -0
- package/src/stories/full-chat.stories.tsx +18 -0
- package/src/stories/message-actions.stories.tsx +230 -0
- package/src/stories/pattern-centered-conversation.stories.tsx +93 -0
- package/src/stories/pattern-docked-widget.stories.tsx +93 -0
- package/src/stories/pattern-empty-state.stories.tsx +76 -0
- package/src/stories/prompt-input-variants.stories.tsx +456 -0
- package/src/stories/streaming-response.stories.tsx +438 -0
- package/src/stories/theme-editor.stories.tsx +16 -0
- package/src/stories/token-reference.stories.tsx +18 -0
- package/src/stories/typography.stories.tsx +78 -0
- package/src/types.ts +47 -0
- package/src/ui/action-icons.ts +52 -0
- package/src/ui/avatar.stories.tsx +103 -0
- package/src/ui/avatar.tsx +23 -0
- package/src/ui/badge.stories.tsx +86 -0
- package/src/ui/badge.tsx +21 -0
- package/src/ui/button.stories.tsx +145 -0
- package/src/ui/button.tsx +38 -0
- package/src/ui/collapsible.stories.tsx +69 -0
- package/src/ui/collapsible.tsx +125 -0
- package/src/ui/dropdown.stories.tsx +59 -0
- package/src/ui/dropdown.tsx +196 -0
- package/src/ui/hover-card.stories.tsx +77 -0
- package/src/ui/hover-card.test.tsx +30 -0
- package/src/ui/hover-card.tsx +172 -0
- package/src/ui/overlay.stories.tsx +115 -0
- package/src/ui/overlay.tsx +158 -0
- package/src/ui/popover.stories.tsx +81 -0
- package/src/ui/popover.test.tsx +99 -0
- package/src/ui/popover.tsx +92 -0
- package/src/ui/resizable.stories.tsx +236 -0
- package/src/ui/resizable.tsx +576 -0
- package/src/ui/scroll-area.stories.tsx +50 -0
- package/src/ui/scroll-area.tsx +15 -0
- package/src/ui/separator.stories.tsx +81 -0
- package/src/ui/separator.tsx +10 -0
- package/src/ui/skeleton.stories.tsx +337 -0
- package/src/ui/skeleton.tsx +16 -0
- package/src/ui/switch.stories.tsx +51 -0
- package/src/ui/switch.test.tsx +59 -0
- package/src/ui/switch.tsx +62 -0
- package/src/ui/textarea.stories.tsx +76 -0
- package/src/ui/textarea.tsx +21 -0
- package/src/ui/tooltip.stories.tsx +74 -0
- package/src/ui/tooltip.tsx +68 -0
- package/src/utils/cn.ts +24 -0
- package/theme.css +187 -0
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from 'storybook-solidjs-vite';
|
|
2
|
+
import { createSignal, onMount, type JSX } from 'solid-js';
|
|
3
|
+
import './embed'; // side effect: registers <kai-embed>
|
|
4
|
+
import { argTypesFor, specDescription } from '../stories/docs/element-controls';
|
|
5
|
+
import type { EmbedCardData } from '../primitives/embed-providers';
|
|
6
|
+
import { configureEmbedAllowlist } from '../primitives/embed-providers';
|
|
7
|
+
import type { CardEvent } from '../primitives/card-contract';
|
|
8
|
+
|
|
9
|
+
// Custom DOM element — declare the tag for JSX.
|
|
10
|
+
declare module 'solid-js' {
|
|
11
|
+
// eslint-disable-next-line @typescript-eslint/no-namespace
|
|
12
|
+
namespace JSX {
|
|
13
|
+
interface IntrinsicElements {
|
|
14
|
+
'kai-embed': JSX.HTMLAttributes<HTMLElement> & {
|
|
15
|
+
'card-id'?: string;
|
|
16
|
+
ref?: (el: HTMLElement) => void;
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
type EmbedEl = HTMLElement & { cardId?: string; data?: EmbedCardData };
|
|
23
|
+
|
|
24
|
+
/** A sized box the embed sits in. */
|
|
25
|
+
function Frame(props: { children: JSX.Element }) {
|
|
26
|
+
return <div style={{ width: '100%', 'max-width': '560px' }}>{props.children}</div>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** Mounts a <kai-embed>, sets `.data`, logs emitted CardEvents under the render. */
|
|
30
|
+
function EmbedDemo(props: { cardId: string; data: EmbedCardData }) {
|
|
31
|
+
const [log, setLog] = createSignal<CardEvent[]>([]);
|
|
32
|
+
let el: EmbedEl | undefined;
|
|
33
|
+
onMount(() => {
|
|
34
|
+
if (!el) return;
|
|
35
|
+
el.cardId = props.cardId;
|
|
36
|
+
el.data = props.data;
|
|
37
|
+
el.addEventListener('kai-card', (e) => {
|
|
38
|
+
const detail = (e as CustomEvent<CardEvent>).detail;
|
|
39
|
+
setLog((prev) => [...prev, detail]);
|
|
40
|
+
if (detail.kind === 'open' && detail.target === 'tab') {
|
|
41
|
+
window.open(detail.url, '_blank', 'noopener,noreferrer');
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
});
|
|
45
|
+
return (
|
|
46
|
+
<Frame>
|
|
47
|
+
<div style={{ display: 'flex', 'flex-direction': 'column', gap: '12px' }}>
|
|
48
|
+
<kai-embed ref={(e) => (el = e as EmbedEl)} card-id={props.cardId} />
|
|
49
|
+
<pre
|
|
50
|
+
style={{
|
|
51
|
+
margin: 0,
|
|
52
|
+
'max-height': '180px',
|
|
53
|
+
overflow: 'auto',
|
|
54
|
+
background: 'var(--color-muted, #f4f4f5)',
|
|
55
|
+
'border-radius': '8px',
|
|
56
|
+
padding: '8px',
|
|
57
|
+
'font-size': '12px',
|
|
58
|
+
}}
|
|
59
|
+
>
|
|
60
|
+
{log().length === 0 ? '// emitted CardEvents appear here' : JSON.stringify(log(), null, 2)}
|
|
61
|
+
</pre>
|
|
62
|
+
</div>
|
|
63
|
+
</Frame>
|
|
64
|
+
);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const YT_ENVELOPE = {
|
|
68
|
+
type: 'embed',
|
|
69
|
+
id: 'card-embed-1',
|
|
70
|
+
title: 'Intro video',
|
|
71
|
+
data: { provider: 'youtube', id: 'dQw4w9WgXcQ', title: 'Product intro', aspectRatio: '16:9' },
|
|
72
|
+
} satisfies { type: string; id: string; title: string; data: EmbedCardData };
|
|
73
|
+
|
|
74
|
+
const HTML_SNIPPET = `<!-- Works in any framework or plain HTML -->
|
|
75
|
+
<kai-embed id="em"></kai-embed>
|
|
76
|
+
|
|
77
|
+
<script type="module">
|
|
78
|
+
import '@kitn.ai/ui/elements'; // registers the custom elements
|
|
79
|
+
|
|
80
|
+
const em = document.getElementById('em');
|
|
81
|
+
em.cardId = 'card-embed-1';
|
|
82
|
+
// \`data\` is a JS property (the CardEnvelope \`data\`):
|
|
83
|
+
em.data = { provider: 'youtube', id: 'dQw4w9WgXcQ', title: 'Product intro' };
|
|
84
|
+
|
|
85
|
+
// NO network to YouTube until the user clicks play (privacy-first lazy facade).
|
|
86
|
+
// kai-embed emits: ready (on mount), open (on "Open on provider" click), error (blocked/invalid).
|
|
87
|
+
// The optional "Open on YouTube" affordance bubbles a composed \`kai-card\` open event:
|
|
88
|
+
em.addEventListener('kai-card', (e) => {
|
|
89
|
+
const ev = e.detail;
|
|
90
|
+
if (ev.kind === 'open' && ev.target === 'tab') {
|
|
91
|
+
window.open(ev.url, '_blank', 'noopener,noreferrer');
|
|
92
|
+
}
|
|
93
|
+
});
|
|
94
|
+
</script>`;
|
|
95
|
+
|
|
96
|
+
const meta = {
|
|
97
|
+
title: 'Generative UI/Cards/kai-embed',
|
|
98
|
+
tags: ['autodocs'],
|
|
99
|
+
argTypes: argTypesFor('kai-embed'),
|
|
100
|
+
parameters: {
|
|
101
|
+
layout: 'padded',
|
|
102
|
+
docs: {
|
|
103
|
+
description: specDescription('kai-embed', [
|
|
104
|
+
'`<kai-embed>` is a **privacy-first lazy media embed** (YouTube / Vimeo / allowlisted generic player) for the generative-UI feature. It speaks the **Card Contract**: data down (an `embed` `CardEnvelope`), events up (only the `open` verb, plus lifecycle `ready` / failure `error`).',
|
|
105
|
+
'**Lazy facade:** the initial render is just a **poster + play button** — NO provider iframe, NO third-party JS, NO cookies until the user clicks play. YouTube loads via `youtube-nocookie.com`; Vimeo with `dnt=1`. This buys privacy (no tracking until opt-in) and performance (no player JS on load).',
|
|
106
|
+
'**Security:** `generic` embeds frame an arbitrary https URL, so they are **rejected unless the app allowlists their origin** with `configureEmbedAllowlist([...])` (defaults to empty — an agent cannot frame an arbitrary origin). The player iframe is sandboxed for a *trusted provider* (`allow-scripts allow-same-origin` on a cross-origin player) — contrast `<kai-artifact>`, which trusts nothing.',
|
|
107
|
+
'**Never a dead end:** a persistent "Open on {provider}" affordance dispatches the `open` verb (so a provider that refuses framing still has a way out). Set `data` as a JS property; `card-id` via attribute.',
|
|
108
|
+
'See the **Code** tab for the `CardEnvelope` JSON + HTML wiring.',
|
|
109
|
+
]),
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
} satisfies Meta;
|
|
113
|
+
|
|
114
|
+
export default meta;
|
|
115
|
+
type Story = StoryObj;
|
|
116
|
+
|
|
117
|
+
/** YouTube (lazy) — poster + play; the iframe loads (youtube-nocookie) only on click. `ready` fires on mount; `open` fires if the "Open on YouTube" link is used. */
|
|
118
|
+
export const YouTube: Story = {
|
|
119
|
+
name: 'YouTube (lazy)',
|
|
120
|
+
render: () => <EmbedDemo cardId={YT_ENVELOPE.id} data={YT_ENVELOPE.data} />,
|
|
121
|
+
parameters: { docs: { source: { code: HTML_SNIPPET, language: 'html' } } },
|
|
122
|
+
};
|
|
123
|
+
|
|
124
|
+
/** Vimeo — supply a `poster` (Vimeo has no static thumbnail URL). */
|
|
125
|
+
export const Vimeo: Story = {
|
|
126
|
+
render: () => (
|
|
127
|
+
<EmbedDemo
|
|
128
|
+
cardId="card-embed-2"
|
|
129
|
+
data={{
|
|
130
|
+
provider: 'vimeo',
|
|
131
|
+
id: '76979871',
|
|
132
|
+
title: 'Vimeo staff pick',
|
|
133
|
+
poster: 'https://placehold.co/1280x720/1ab7ea/ffffff/png?text=Vimeo',
|
|
134
|
+
}}
|
|
135
|
+
/>
|
|
136
|
+
),
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
/** Generic player — an https embed URL whose origin the app has allowlisted. */
|
|
140
|
+
export const Generic: Story = {
|
|
141
|
+
name: 'Generic player',
|
|
142
|
+
render: () => {
|
|
143
|
+
configureEmbedAllowlist(['https://www.youtube-nocookie.com']);
|
|
144
|
+
return (
|
|
145
|
+
<EmbedDemo
|
|
146
|
+
cardId="card-embed-3"
|
|
147
|
+
data={{
|
|
148
|
+
provider: 'generic',
|
|
149
|
+
url: 'https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ',
|
|
150
|
+
title: 'Generic embed',
|
|
151
|
+
poster: 'https://placehold.co/1280x720/444/fff/png?text=Generic+player',
|
|
152
|
+
}}
|
|
153
|
+
/>
|
|
154
|
+
);
|
|
155
|
+
},
|
|
156
|
+
parameters: {
|
|
157
|
+
docs: {
|
|
158
|
+
source: {
|
|
159
|
+
code: `import { configureEmbedAllowlist } from '@kitn.ai/ui';
|
|
160
|
+
|
|
161
|
+
// Generic embeds are blocked by default — allowlist the trusted origin first:
|
|
162
|
+
configureEmbedAllowlist(['https://your-player.example.com']);
|
|
163
|
+
|
|
164
|
+
em.data = {
|
|
165
|
+
provider: 'generic',
|
|
166
|
+
url: 'https://your-player.example.com/embed/abc',
|
|
167
|
+
title: 'Generic embed',
|
|
168
|
+
poster: 'https://your-cdn.example.com/poster.jpg',
|
|
169
|
+
};`,
|
|
170
|
+
language: 'ts',
|
|
171
|
+
},
|
|
172
|
+
},
|
|
173
|
+
},
|
|
174
|
+
};
|
|
175
|
+
|
|
176
|
+
/** Custom aspect ratio — a vertical 9:16 short. */
|
|
177
|
+
export const CustomAspectRatio: Story = {
|
|
178
|
+
name: 'Custom aspect ratio (9:16)',
|
|
179
|
+
render: () => (
|
|
180
|
+
<div style={{ width: '100%', 'max-width': '280px' }}>
|
|
181
|
+
<EmbedRaw
|
|
182
|
+
cardId="card-embed-4"
|
|
183
|
+
data={{ provider: 'youtube', id: 'dQw4w9WgXcQ', title: 'Short', aspectRatio: '9:16' }}
|
|
184
|
+
/>
|
|
185
|
+
</div>
|
|
186
|
+
),
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
/** Blocked-embed fallback — the "Open on provider" affordance is always present. */
|
|
190
|
+
export const BlockedFallback: Story = {
|
|
191
|
+
name: 'Blocked-embed fallback',
|
|
192
|
+
render: () => <EmbedDemo cardId="card-embed-5" data={{ provider: 'youtube', id: 'dQw4w9WgXcQ', title: 'Maybe blocked' }} />,
|
|
193
|
+
parameters: {
|
|
194
|
+
docs: {
|
|
195
|
+
description: {
|
|
196
|
+
story:
|
|
197
|
+
'Some providers refuse framing (X-Frame-Options / CSP `frame-ancestors`). We can\'t detect that cross-origin in JS, so the **"Open on {provider}"** affordance is *always* available — a blocked embed is never a dead end.',
|
|
198
|
+
},
|
|
199
|
+
},
|
|
200
|
+
},
|
|
201
|
+
};
|
|
202
|
+
|
|
203
|
+
// A frame-less variant so the 9:16 story controls its own width.
|
|
204
|
+
function EmbedRaw(props: { cardId: string; data: EmbedCardData }) {
|
|
205
|
+
let el: EmbedEl | undefined;
|
|
206
|
+
onMount(() => {
|
|
207
|
+
if (el) {
|
|
208
|
+
el.cardId = props.cardId;
|
|
209
|
+
el.data = props.data;
|
|
210
|
+
}
|
|
211
|
+
});
|
|
212
|
+
return <kai-embed ref={(e) => (el = e as EmbedEl)} />;
|
|
213
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { defineWebComponent } from './define';
|
|
2
|
+
import { Embed } from '../components/embed';
|
|
3
|
+
import type { EmbedCardData } from '../primitives/embed-providers';
|
|
4
|
+
import { emitCardEvent } from '../primitives/card-routing';
|
|
5
|
+
|
|
6
|
+
interface Props extends Record<string, unknown> {
|
|
7
|
+
/** Stable card id correlating every emitted event. Set as an attribute or property. */
|
|
8
|
+
cardId?: string;
|
|
9
|
+
/** The embed payload (provider + id/url + options). Set as a JS **property** (object). */
|
|
10
|
+
data?: EmbedCardData;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* `<kai-embed>` — a privacy-first **lazy media embed** (YouTube / Vimeo / allowlisted
|
|
15
|
+
* generic player). Initial render is a poster + play button: NO provider iframe, JS,
|
|
16
|
+
* or cookies until the user clicks play (YouTube via `youtube-nocookie`, Vimeo with
|
|
17
|
+
* `dnt=1`). A persistent "Open on {provider}" affordance dispatches the contract
|
|
18
|
+
* `open` verb via the bubbling `kai-card` event. `generic` URLs are rejected unless
|
|
19
|
+
* their origin was allowlisted with `configureEmbedAllowlist`. Set `data` as a JS
|
|
20
|
+
* property; `card-id` via attribute.
|
|
21
|
+
*/
|
|
22
|
+
defineWebComponent<Props>(
|
|
23
|
+
'kai-embed',
|
|
24
|
+
{
|
|
25
|
+
cardId: undefined,
|
|
26
|
+
data: undefined,
|
|
27
|
+
},
|
|
28
|
+
(props, { element }) => (
|
|
29
|
+
<Embed
|
|
30
|
+
cardId={props.cardId ?? ''}
|
|
31
|
+
data={props.data ?? ({ provider: 'generic' } as EmbedCardData)}
|
|
32
|
+
onEmit={(event) => emitCardEvent(element, event)}
|
|
33
|
+
/>
|
|
34
|
+
),
|
|
35
|
+
);
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from 'storybook-solidjs-vite';
|
|
2
|
+
import { onMount } from 'solid-js';
|
|
3
|
+
import './register'; // side effect: registers the custom elements
|
|
4
|
+
import { argTypesFor, specDescription } from '../stories/docs/element-controls';
|
|
5
|
+
|
|
6
|
+
// The web components are custom DOM elements, so declare the tags for JSX.
|
|
7
|
+
declare module 'solid-js' {
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/no-namespace
|
|
9
|
+
namespace JSX {
|
|
10
|
+
interface IntrinsicElements {
|
|
11
|
+
'kai-empty': JSX.HTMLAttributes<HTMLElement>;
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
const HTML_SNIPPET = `<!-- Works in any framework or plain HTML -->
|
|
17
|
+
<kai-empty
|
|
18
|
+
empty-title="No conversations yet"
|
|
19
|
+
description="Start a new chat to see it appear here."
|
|
20
|
+
>
|
|
21
|
+
<!-- Route 2 slots: your own icon and actions -->
|
|
22
|
+
<svg slot="media" width="28" height="28" viewBox="0 0 24 24" fill="none"
|
|
23
|
+
stroke="currentColor" stroke-width="2">
|
|
24
|
+
<path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z" />
|
|
25
|
+
</svg>
|
|
26
|
+
|
|
27
|
+
<!-- Slotted actions are light DOM, so style them with your own page CSS
|
|
28
|
+
(a ghost button with a + icon, here styled inline for portability). -->
|
|
29
|
+
<button
|
|
30
|
+
style="display:inline-flex; align-items:center; gap:.45rem;
|
|
31
|
+
font:500 13.5px/1 system-ui,sans-serif; padding:.5rem .85rem;
|
|
32
|
+
border-radius:9px; border:1px solid var(--color-border, #e5e5e5);
|
|
33
|
+
background:transparent; color:inherit; cursor:pointer;"
|
|
34
|
+
>
|
|
35
|
+
<svg width="16" height="16" viewBox="0 0 24 24" fill="none"
|
|
36
|
+
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
|
37
|
+
<path d="M5 12h14" /><path d="M12 5v14" />
|
|
38
|
+
</svg>
|
|
39
|
+
New chat
|
|
40
|
+
</button>
|
|
41
|
+
</kai-empty>
|
|
42
|
+
|
|
43
|
+
<script type="module">
|
|
44
|
+
import '@kitn.ai/ui/elements'; // registers the custom elements
|
|
45
|
+
</script>`;
|
|
46
|
+
|
|
47
|
+
const meta = {
|
|
48
|
+
title: 'Components/Empty',
|
|
49
|
+
tags: ['autodocs'],
|
|
50
|
+
argTypes: argTypesFor('kai-empty'),
|
|
51
|
+
parameters: {
|
|
52
|
+
layout: 'fullscreen',
|
|
53
|
+
docs: {
|
|
54
|
+
description: specDescription('kai-empty', [
|
|
55
|
+
'`<kai-empty>` is the framework-agnostic **web component** for an empty-state block — an icon, a title, a description, and actions — isolated in **Shadow DOM**.',
|
|
56
|
+
'**When to use:** placeholder UI for an empty list/thread in a non-Solid app. In SolidJS, compose the `Empty*` primitives.',
|
|
57
|
+
'**Placement:** filling the main content area where a conversation list or message thread would appear; give it (or its parent) a height so the centered layout renders correctly.',
|
|
58
|
+
"**How to use:** register once with `import '@kitn.ai/ui/elements'`, set `empty-title` (note `empty-title`, not `title`) and `description` via attributes, and use the **slots** (\"Route 2\") to project your own icon (`slot=\"media\"`) and actions (the default slot).",
|
|
59
|
+
'See the **Code** tab for HTML usage.',
|
|
60
|
+
]),
|
|
61
|
+
},
|
|
62
|
+
},
|
|
63
|
+
} satisfies Meta;
|
|
64
|
+
|
|
65
|
+
export default meta;
|
|
66
|
+
type Story = StoryObj;
|
|
67
|
+
|
|
68
|
+
/** Render the actual `<kai-empty>` custom element with slotted children. */
|
|
69
|
+
function EmptyElement() {
|
|
70
|
+
let el: HTMLElement | undefined;
|
|
71
|
+
onMount(() => {
|
|
72
|
+
if (!el) return;
|
|
73
|
+
el.setAttribute('empty-title', 'No conversations yet');
|
|
74
|
+
el.setAttribute('description', 'Start a new chat to see it appear here.');
|
|
75
|
+
});
|
|
76
|
+
return (
|
|
77
|
+
<kai-empty ref={(e) => (el = e as HTMLElement)} style={{ display: 'block', padding: '24px' }}>
|
|
78
|
+
<svg slot="media" width="28" height="28" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
|
79
|
+
<path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z" />
|
|
80
|
+
</svg>
|
|
81
|
+
{/* Slotted actions are light DOM — style them with the host page's own
|
|
82
|
+
CSS. Here a ghost "+ New chat" button, styled inline so it renders
|
|
83
|
+
correctly in any context (mirrors the composable example's pill-btn). */}
|
|
84
|
+
<button
|
|
85
|
+
style={{
|
|
86
|
+
display: 'inline-flex',
|
|
87
|
+
'align-items': 'center',
|
|
88
|
+
gap: '0.45rem',
|
|
89
|
+
font: '500 13.5px/1 system-ui, sans-serif',
|
|
90
|
+
padding: '0.5rem 0.85rem',
|
|
91
|
+
'border-radius': '9px',
|
|
92
|
+
border: '1px solid var(--color-border, #e5e5e5)',
|
|
93
|
+
background: 'transparent',
|
|
94
|
+
color: 'inherit',
|
|
95
|
+
cursor: 'pointer',
|
|
96
|
+
}}
|
|
97
|
+
>
|
|
98
|
+
<svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
|
99
|
+
<path d="M5 12h14" /><path d="M12 5v14" />
|
|
100
|
+
</svg>
|
|
101
|
+
New chat
|
|
102
|
+
</button>
|
|
103
|
+
</kai-empty>
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/** An empty state with a slotted icon and an action button. */
|
|
108
|
+
export const Default: Story = {
|
|
109
|
+
render: () => <EmptyElement />,
|
|
110
|
+
parameters: { docs: { source: { code: HTML_SNIPPET, language: 'html' } } },
|
|
111
|
+
};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { Show } from 'solid-js';
|
|
2
|
+
import { defineWebComponent } from './define';
|
|
3
|
+
import { Empty, EmptyHeader, EmptyMedia, EmptyTitle, EmptyDescription, EmptyContent } from '../components/empty';
|
|
4
|
+
|
|
5
|
+
interface Props extends Record<string, unknown> {
|
|
6
|
+
/** Title text. Attribute: `empty-title` (`title` is a global HTML attribute). */
|
|
7
|
+
emptyTitle?: string;
|
|
8
|
+
/** Description text. */
|
|
9
|
+
description?: string;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* `<kai-empty>` — an empty-state block. `empty-title`/`description` via
|
|
14
|
+
* attributes; slot your own icon into `slot="media"` and actions into the
|
|
15
|
+
* default slot (Route 2 slots).
|
|
16
|
+
*/
|
|
17
|
+
defineWebComponent<Props>('kai-empty', {
|
|
18
|
+
emptyTitle: '',
|
|
19
|
+
description: '',
|
|
20
|
+
}, (props) => (
|
|
21
|
+
<Empty>
|
|
22
|
+
<EmptyHeader>
|
|
23
|
+
<EmptyMedia variant="icon"><slot name="media" /></EmptyMedia>
|
|
24
|
+
<Show when={props.emptyTitle}><EmptyTitle>{props.emptyTitle}</EmptyTitle></Show>
|
|
25
|
+
<Show when={props.description}><EmptyDescription>{props.description}</EmptyDescription></Show>
|
|
26
|
+
</EmptyHeader>
|
|
27
|
+
<EmptyContent><slot /></EmptyContent>
|
|
28
|
+
</Empty>
|
|
29
|
+
));
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from 'storybook-solidjs-vite';
|
|
2
|
+
import { onMount } from 'solid-js';
|
|
3
|
+
import './register'; // side effect: registers the custom elements
|
|
4
|
+
import { argTypesFor, specDescription } from '../stories/docs/element-controls';
|
|
5
|
+
|
|
6
|
+
// The web components are custom DOM elements, so declare the tags for JSX.
|
|
7
|
+
declare module 'solid-js' {
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/no-namespace
|
|
9
|
+
namespace JSX {
|
|
10
|
+
interface IntrinsicElements {
|
|
11
|
+
'kai-feedback-bar': JSX.HTMLAttributes<HTMLElement> & {
|
|
12
|
+
'bar-title'?: string;
|
|
13
|
+
'collect-detail'?: boolean | string;
|
|
14
|
+
'detail-title'?: string;
|
|
15
|
+
'thanks-message'?: string;
|
|
16
|
+
'on:kai-feedback'?: (e: CustomEvent<{ value: 'helpful' | 'not-helpful' }>) => void;
|
|
17
|
+
'on:kai-feedback-detail'?: (e: CustomEvent<{ value: 'helpful' | 'not-helpful'; category?: string; comment?: string }>) => void;
|
|
18
|
+
'on:kai-close'?: (e: CustomEvent) => void;
|
|
19
|
+
};
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const HTML_SNIPPET = `<!-- Works in any framework or plain HTML -->
|
|
25
|
+
<kai-feedback-bar bar-title="Was this helpful?"></kai-feedback-bar>
|
|
26
|
+
|
|
27
|
+
<script type="module">
|
|
28
|
+
import '@kitn.ai/ui/elements'; // registers the custom elements
|
|
29
|
+
|
|
30
|
+
const bar = document.querySelector('kai-feedback-bar');
|
|
31
|
+
bar.addEventListener('kai-feedback', (e) => console.log('feedback:', e.detail.value)); // 'helpful' | 'not-helpful'
|
|
32
|
+
bar.addEventListener('kai-close', () => bar.remove());
|
|
33
|
+
</script>`;
|
|
34
|
+
|
|
35
|
+
const meta = {
|
|
36
|
+
title: 'Components/FeedbackBar',
|
|
37
|
+
tags: ['autodocs'],
|
|
38
|
+
argTypes: argTypesFor('kai-feedback-bar'),
|
|
39
|
+
parameters: {
|
|
40
|
+
layout: 'fullscreen',
|
|
41
|
+
docs: {
|
|
42
|
+
description: specDescription('kai-feedback-bar', [
|
|
43
|
+
'`<kai-feedback-bar>` is the framework-agnostic **web component** for an inline thumbs up/down feedback banner — isolated in **Shadow DOM**. It owns its own flow: it asks, optionally collects a category + comment on a not-helpful vote (`collect-detail`), then confirms with a thank-you in place. It does **not** disappear on a vote; only the close (X) dismisses it.',
|
|
44
|
+
'**When to use:** collecting a quick reaction (optionally with a reason) after an answer or a completed task. In SolidJS, use the `FeedbackBar` primitive.',
|
|
45
|
+
"**How to use:** register once with `import '@kitn.ai/ui/elements'`, set the label via the `bar-title` attribute (`title` is avoided — it's a global HTML attribute). For the richer flow add `collect-detail` and set the `categories` **property** (array). Listen for `kai-feedback` (`{ value }`), `kai-feedback-detail` (`{ value, category?, comment? }`), and `kai-close` **CustomEvents**.",
|
|
46
|
+
'See the **Code** tab for HTML usage.',
|
|
47
|
+
]),
|
|
48
|
+
},
|
|
49
|
+
},
|
|
50
|
+
} satisfies Meta;
|
|
51
|
+
|
|
52
|
+
export default meta;
|
|
53
|
+
type Story = StoryObj;
|
|
54
|
+
|
|
55
|
+
/** The default feedback prompt. */
|
|
56
|
+
export const Default: Story = {
|
|
57
|
+
render: () => (
|
|
58
|
+
<div style={{ padding: '24px', 'max-width': '480px' }}>
|
|
59
|
+
<kai-feedback-bar
|
|
60
|
+
on:kai-feedback={(e) => console.log('feedback:', e.detail.value)}
|
|
61
|
+
on:kai-close={() => console.log('closed')}
|
|
62
|
+
/>
|
|
63
|
+
</div>
|
|
64
|
+
),
|
|
65
|
+
parameters: { docs: { source: { code: HTML_SNIPPET, language: 'html' } } },
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
/** A custom label via the `bar-title` attribute. */
|
|
69
|
+
export const CustomTitle: Story = {
|
|
70
|
+
render: () => (
|
|
71
|
+
<div style={{ padding: '24px', 'max-width': '480px' }}>
|
|
72
|
+
<kai-feedback-bar bar-title="Did this answer your question?" />
|
|
73
|
+
</div>
|
|
74
|
+
),
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
/** The full flow with `collect-detail` — a 👎 vote opens an optional detail form
|
|
78
|
+
* (category chips from the `categories` property + a comment) before the thanks. */
|
|
79
|
+
export const WithDetail: Story = {
|
|
80
|
+
render: () => {
|
|
81
|
+
let el: (HTMLElement & { categories?: string[] }) | undefined;
|
|
82
|
+
onMount(() => {
|
|
83
|
+
if (el) el.categories = ['Inaccurate', 'Not helpful', 'Unsafe', 'Other'];
|
|
84
|
+
});
|
|
85
|
+
return (
|
|
86
|
+
<div style={{ padding: '24px', 'max-width': '480px' }}>
|
|
87
|
+
<kai-feedback-bar
|
|
88
|
+
ref={(e) => (el = e as HTMLElement)}
|
|
89
|
+
bar-title="Was this response helpful?"
|
|
90
|
+
collect-detail
|
|
91
|
+
on:kai-feedback={(e) => console.log('vote:', e.detail.value)}
|
|
92
|
+
on:kai-feedback-detail={(e) => console.log('detail:', e.detail)}
|
|
93
|
+
on:kai-close={() => console.log('closed')}
|
|
94
|
+
/>
|
|
95
|
+
</div>
|
|
96
|
+
);
|
|
97
|
+
},
|
|
98
|
+
parameters: {
|
|
99
|
+
docs: {
|
|
100
|
+
source: {
|
|
101
|
+
code: `<kai-feedback-bar id="fb" bar-title="Was this response helpful?" collect-detail></kai-feedback-bar>
|
|
102
|
+
<script type="module">
|
|
103
|
+
import '@kitn.ai/ui/elements';
|
|
104
|
+
const fb = document.getElementById('fb');
|
|
105
|
+
fb.categories = ['Inaccurate', 'Not helpful', 'Unsafe', 'Other']; // chips (a JS property)
|
|
106
|
+
fb.addEventListener('kai-feedback', (e) => console.log('vote:', e.detail.value));
|
|
107
|
+
fb.addEventListener('kai-feedback-detail', (e) => console.log('detail:', e.detail)); // { value, category?, comment? }
|
|
108
|
+
fb.addEventListener('kai-close', () => fb.remove());
|
|
109
|
+
</script>`,
|
|
110
|
+
language: 'html',
|
|
111
|
+
},
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { defineWebComponent } from './define';
|
|
2
|
+
import { FeedbackBar, type FeedbackValue, type FeedbackDetail } from '../components/feedback-bar';
|
|
3
|
+
|
|
4
|
+
interface Props extends Record<string, unknown> {
|
|
5
|
+
/** The banner label (e.g. "Was this helpful?"). Attribute: `bar-title`
|
|
6
|
+
* (`title` is avoided — it's a global HTML attribute). */
|
|
7
|
+
barTitle?: string;
|
|
8
|
+
/** When set, a not-helpful vote opens an optional detail form before the
|
|
9
|
+
* thank-you confirmation. Attribute: `collect-detail`. */
|
|
10
|
+
collectDetail?: boolean;
|
|
11
|
+
/** Optional category chips for the detail form. Set as a JS property (array). */
|
|
12
|
+
categories?: string[];
|
|
13
|
+
/** Heading for the detail form. Attribute: `detail-title`. */
|
|
14
|
+
detailTitle?: string;
|
|
15
|
+
/** Placeholder for the detail comment box. Attribute: `detail-placeholder`. */
|
|
16
|
+
detailPlaceholder?: string;
|
|
17
|
+
/** Submit button label in the detail form. Attribute: `submit-label`. */
|
|
18
|
+
submitLabel?: string;
|
|
19
|
+
/** Confirmation copy shown after a vote/submit. Attribute: `thanks-message`. */
|
|
20
|
+
thanksMessage?: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/** Events fired by `<kai-feedback-bar>`. */
|
|
24
|
+
interface Events {
|
|
25
|
+
/** The user rated the response. `value` is `'helpful'` or `'not-helpful'`. */
|
|
26
|
+
'kai-feedback': { value: FeedbackValue };
|
|
27
|
+
/** The user submitted the optional detail form (`collect-detail`). */
|
|
28
|
+
'kai-feedback-detail': FeedbackDetail;
|
|
29
|
+
/** The user dismissed the banner. */
|
|
30
|
+
'kai-close': void;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* `<kai-feedback-bar>` — an inline thumbs up/down feedback banner that owns its
|
|
35
|
+
* own flow: it asks, optionally collects a category + comment on a not-helpful
|
|
36
|
+
* vote (`collect-detail`), then confirms with a thank-you — all in place. Emits
|
|
37
|
+
* `kai-feedback` (`{ value }`), `kai-feedback-detail` (`{ value, category?, comment? }`),
|
|
38
|
+
* and `kai-close`.
|
|
39
|
+
*/
|
|
40
|
+
defineWebComponent<Props, Events>('kai-feedback-bar', {
|
|
41
|
+
barTitle: 'Was this helpful?',
|
|
42
|
+
collectDetail: undefined,
|
|
43
|
+
categories: undefined,
|
|
44
|
+
detailTitle: undefined,
|
|
45
|
+
detailPlaceholder: undefined,
|
|
46
|
+
submitLabel: undefined,
|
|
47
|
+
thanksMessage: undefined,
|
|
48
|
+
}, (props, { dispatch, flag }) => (
|
|
49
|
+
<FeedbackBar
|
|
50
|
+
title={props.barTitle}
|
|
51
|
+
collectDetail={flag('collectDetail')}
|
|
52
|
+
categories={props.categories}
|
|
53
|
+
detailTitle={props.detailTitle}
|
|
54
|
+
detailPlaceholder={props.detailPlaceholder}
|
|
55
|
+
submitLabel={props.submitLabel}
|
|
56
|
+
thanksMessage={props.thanksMessage}
|
|
57
|
+
onFeedback={(value) => dispatch('kai-feedback', { value })}
|
|
58
|
+
onSubmitDetail={(detail) => dispatch('kai-feedback-detail', detail)}
|
|
59
|
+
onClose={() => dispatch('kai-close')}
|
|
60
|
+
/>
|
|
61
|
+
));
|