@assistant-ui/mcp-docs-server 0.2.2 → 0.3.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/README.md +16 -43
- package/dist/index.d.ts +2 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -91
- package/dist/index.js.map +1 -1
- package/dist/proxy.d.ts +9 -0
- package/dist/proxy.d.ts.map +1 -0
- package/dist/proxy.js +76 -0
- package/dist/proxy.js.map +1 -0
- package/package.json +9 -13
- package/src/index.ts +3 -115
- package/src/proxy.test.ts +250 -0
- package/src/proxy.ts +111 -0
- package/.docs/organized/code-examples/waterfall.md +0 -807
- package/.docs/organized/code-examples/with-a2a.md +0 -674
- package/.docs/organized/code-examples/with-ag-ui.md +0 -552
- package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -465
- package/.docs/organized/code-examples/with-artifacts.md +0 -814
- package/.docs/organized/code-examples/with-assistant-transport.md +0 -575
- package/.docs/organized/code-examples/with-browser-extension.md +0 -371
- package/.docs/organized/code-examples/with-chain-of-thought.md +0 -960
- package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
- package/.docs/organized/code-examples/with-cloud.md +0 -438
- package/.docs/organized/code-examples/with-custom-thread-list.md +0 -568
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -526
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -696
- package/.docs/organized/code-examples/with-eve.md +0 -404
- package/.docs/organized/code-examples/with-expo.md +0 -2063
- package/.docs/organized/code-examples/with-external-store.md +0 -420
- package/.docs/organized/code-examples/with-ffmpeg.md +0 -828
- package/.docs/organized/code-examples/with-generative-ui.md +0 -1812
- package/.docs/organized/code-examples/with-google-adk.md +0 -367
- package/.docs/organized/code-examples/with-heat-graph.md +0 -304
- package/.docs/organized/code-examples/with-image-generation.md +0 -462
- package/.docs/organized/code-examples/with-interactables.md +0 -732
- package/.docs/organized/code-examples/with-langchain.md +0 -445
- package/.docs/organized/code-examples/with-langgraph.md +0 -854
- package/.docs/organized/code-examples/with-livekit.md +0 -642
- package/.docs/organized/code-examples/with-mcp.md +0 -780
- package/.docs/organized/code-examples/with-nuxt.md +0 -2428
- package/.docs/organized/code-examples/with-opencode.md +0 -1974
- package/.docs/organized/code-examples/with-openui.md +0 -449
- package/.docs/organized/code-examples/with-pi.md +0 -2083
- package/.docs/organized/code-examples/with-react-hook-form.md +0 -724
- package/.docs/organized/code-examples/with-react-ink-web.md +0 -690
- package/.docs/organized/code-examples/with-react-ink.md +0 -472
- package/.docs/organized/code-examples/with-react-router.md +0 -935
- package/.docs/organized/code-examples/with-resumable-stream.md +0 -667
- package/.docs/organized/code-examples/with-store.md +0 -679
- package/.docs/organized/code-examples/with-svelte.md +0 -415
- package/.docs/organized/code-examples/with-sveltekit.md +0 -1061
- package/.docs/organized/code-examples/with-tanstack.md +0 -811
- package/.docs/organized/code-examples/with-tap-runtime.md +0 -812
- package/.docs/organized/code-examples/with-virtualized-thread.md +0 -680
- package/.docs/organized/code-examples/with-vue.md +0 -408
- package/.docs/raw/docs/(docs)/architecture.mdx +0 -146
- package/.docs/raw/docs/(docs)/base-ui.mdx +0 -39
- package/.docs/raw/docs/(docs)/cli.mdx +0 -542
- package/.docs/raw/docs/(docs)/devtools.mdx +0 -79
- package/.docs/raw/docs/(docs)/index.mdx +0 -21
- package/.docs/raw/docs/(docs)/installation.mdx +0 -483
- package/.docs/raw/docs/(docs)/llm.mdx +0 -211
- package/.docs/raw/docs/(docs)/rtl.mdx +0 -78
- package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +0 -36
- package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +0 -34
- package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +0 -44
- package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +0 -59
- package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +0 -84
- package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +0 -64
- package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +0 -52
- package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +0 -49
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/a2ui.mdx +0 -40
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/actions.mdx +0 -56
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/components.mdx +0 -86
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +0 -39
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/json-generative-ui.mdx +0 -42
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +0 -84
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +0 -85
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/spec.mdx +0 -45
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +0 -93
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/tokens.mdx +0 -62
- package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +0 -129
- package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +0 -31
- package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +0 -34
- package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +0 -350
- package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +0 -28
- package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +0 -97
- package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -97
- package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +0 -200
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -37
- package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +0 -50
- package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/overview.mdx +0 -566
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +0 -152
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +0 -239
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +0 -208
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +0 -108
- package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +0 -99
- package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +0 -145
- package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +0 -82
- package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +0 -619
- package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +0 -65
- package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +0 -73
- package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +0 -117
- package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +0 -339
- package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +0 -77
- package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +0 -88
- package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +0 -81
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +0 -129
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +0 -138
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +0 -122
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +0 -289
- package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +0 -32
- package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +0 -43
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +0 -43
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +0 -36
- package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +0 -85
- package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +0 -45
- package/.docs/raw/docs/(reference)/api-reference/tools/interactables-legacy.mdx +0 -55
- package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx +0 -151
- package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +0 -106
- package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +0 -62
- package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +0 -178
- package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +0 -48
- package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +0 -62
- package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +0 -19
- package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +0 -149
- package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +0 -54
- package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +0 -36
- package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +0 -527
- package/.docs/raw/docs/cloud/ai-sdk.mdx +0 -602
- package/.docs/raw/docs/cloud/authorization.mdx +0 -252
- package/.docs/raw/docs/cloud/index.mdx +0 -46
- package/.docs/raw/docs/cloud/langgraph.mdx +0 -554
- package/.docs/raw/docs/copilots/assistant-frame.mdx +0 -400
- package/.docs/raw/docs/copilots/make-assistant-visible.mdx +0 -82
- package/.docs/raw/docs/copilots/model-context.mdx +0 -156
- package/.docs/raw/docs/copilots/motivation.mdx +0 -202
- package/.docs/raw/docs/copilots/use-assistant-instructions.mdx +0 -64
- package/.docs/raw/docs/guides/attachments.mdx +0 -619
- package/.docs/raw/docs/guides/branching.mdx +0 -76
- package/.docs/raw/docs/guides/chain-of-thought.mdx +0 -164
- package/.docs/raw/docs/guides/chatgpt-subscription.mdx +0 -108
- package/.docs/raw/docs/guides/context-api.mdx +0 -619
- package/.docs/raw/docs/guides/dictation.mdx +0 -298
- package/.docs/raw/docs/guides/editing.mdx +0 -102
- package/.docs/raw/docs/guides/electron.mdx +0 -369
- package/.docs/raw/docs/guides/headless-composer-input.mdx +0 -113
- package/.docs/raw/docs/guides/image-generation.mdx +0 -74
- package/.docs/raw/docs/guides/index.mdx +0 -117
- package/.docs/raw/docs/guides/input-history.mdx +0 -55
- package/.docs/raw/docs/guides/latex.mdx +0 -158
- package/.docs/raw/docs/guides/mentions.mdx +0 -575
- package/.docs/raw/docs/guides/message-timing.mdx +0 -209
- package/.docs/raw/docs/guides/quoting.mdx +0 -169
- package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +0 -212
- package/.docs/raw/docs/guides/resumable-stream-stores.mdx +0 -152
- package/.docs/raw/docs/guides/resumable-streams.mdx +0 -292
- package/.docs/raw/docs/guides/slash-commands.mdx +0 -358
- package/.docs/raw/docs/guides/speech.mdx +0 -172
- package/.docs/raw/docs/guides/suggestions.mdx +0 -384
- package/.docs/raw/docs/guides/virtualization.mdx +0 -133
- package/.docs/raw/docs/guides/voice.mdx +0 -310
- package/.docs/raw/docs/ink/adapters.mdx +0 -99
- package/.docs/raw/docs/ink/custom-backend.mdx +0 -254
- package/.docs/raw/docs/ink/hooks.mdx +0 -469
- package/.docs/raw/docs/ink/index.mdx +0 -236
- package/.docs/raw/docs/ink/migration.mdx +0 -138
- package/.docs/raw/docs/ink/primitives.mdx +0 -1259
- package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +0 -528
- package/.docs/raw/docs/integrations/auth/better-auth.mdx +0 -188
- package/.docs/raw/docs/integrations/auth/clerk.mdx +0 -166
- package/.docs/raw/docs/integrations/auth/next-auth.mdx +0 -191
- package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +0 -88
- package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +0 -282
- package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +0 -188
- package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +0 -57
- package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +0 -201
- package/.docs/raw/docs/integrations/gateways/index.mdx +0 -162
- package/.docs/raw/docs/integrations/index.mdx +0 -178
- package/.docs/raw/docs/integrations/observability/helicone.mdx +0 -129
- package/.docs/raw/docs/integrations/observability/langfuse.mdx +0 -161
- package/.docs/raw/docs/integrations/observability/langsmith.mdx +0 -151
- package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +0 -773
- package/.docs/raw/docs/migrations/deprecation-policy.mdx +0 -42
- package/.docs/raw/docs/migrations/index.mdx +0 -50
- package/.docs/raw/docs/migrations/react-compatibility.mdx +0 -74
- package/.docs/raw/docs/migrations/react-langgraph-v0-7.mdx +0 -328
- package/.docs/raw/docs/migrations/toolkit-tools.mdx +0 -236
- package/.docs/raw/docs/migrations/v0-11.mdx +0 -172
- package/.docs/raw/docs/migrations/v0-12.mdx +0 -302
- package/.docs/raw/docs/migrations/v0-14.mdx +0 -297
- package/.docs/raw/docs/migrations/v0-15.mdx +0 -270
- package/.docs/raw/docs/primitives/action-bar.mdx +0 -352
- package/.docs/raw/docs/primitives/assistant-modal.mdx +0 -216
- package/.docs/raw/docs/primitives/attachment.mdx +0 -217
- package/.docs/raw/docs/primitives/branch-picker.mdx +0 -222
- package/.docs/raw/docs/primitives/chain-of-thought.mdx +0 -315
- package/.docs/raw/docs/primitives/composer.mdx +0 -659
- package/.docs/raw/docs/primitives/error.mdx +0 -142
- package/.docs/raw/docs/primitives/index.mdx +0 -99
- package/.docs/raw/docs/primitives/message.mdx +0 -618
- package/.docs/raw/docs/primitives/selection-toolbar.mdx +0 -191
- package/.docs/raw/docs/primitives/suggestion.mdx +0 -254
- package/.docs/raw/docs/primitives/thread-list.mdx +0 -467
- package/.docs/raw/docs/primitives/thread.mdx +0 -509
- package/.docs/raw/docs/react-native/adapters.mdx +0 -94
- package/.docs/raw/docs/react-native/custom-backend.mdx +0 -207
- package/.docs/raw/docs/react-native/hooks.mdx +0 -339
- package/.docs/raw/docs/react-native/index.mdx +0 -289
- package/.docs/raw/docs/react-native/migration.mdx +0 -142
- package/.docs/raw/docs/react-native/primitives.mdx +0 -839
- package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +0 -399
- package/.docs/raw/docs/runtimes/a2a/overview.mdx +0 -60
- package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +0 -216
- package/.docs/raw/docs/runtimes/ag-ui/agent-state.mdx +0 -124
- package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +0 -70
- package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +0 -243
- package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +0 -255
- package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +0 -61
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +0 -122
- package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +0 -135
- package/.docs/raw/docs/runtimes/ai-sdk/v6-legacy.mdx +0 -636
- package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +0 -716
- package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +0 -118
- package/.docs/raw/docs/runtimes/concepts/adapters.mdx +0 -265
- package/.docs/raw/docs/runtimes/concepts/architecture.mdx +0 -167
- package/.docs/raw/docs/runtimes/concepts/stability.mdx +0 -68
- package/.docs/raw/docs/runtimes/concepts/threads.mdx +0 -513
- package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +0 -763
- package/.docs/raw/docs/runtimes/custom/data-stream.mdx +0 -339
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +0 -957
- package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +0 -902
- package/.docs/raw/docs/runtimes/custom/overview.mdx +0 -71
- package/.docs/raw/docs/runtimes/eve/overview.mdx +0 -151
- package/.docs/raw/docs/runtimes/eve/quickstart.mdx +0 -192
- package/.docs/raw/docs/runtimes/google-adk/api.mdx +0 -256
- package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +0 -784
- package/.docs/raw/docs/runtimes/google-adk/overview.mdx +0 -69
- package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +0 -229
- package/.docs/raw/docs/runtimes/langchain.mdx +0 -901
- package/.docs/raw/docs/runtimes/langgraph/agent-state.mdx +0 -181
- package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +0 -305
- package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +0 -104
- package/.docs/raw/docs/runtimes/langgraph/overview.mdx +0 -84
- package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +0 -496
- package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +0 -144
- package/.docs/raw/docs/runtimes/langgraph/threads.mdx +0 -113
- package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +0 -29
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -93
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +0 -347
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +0 -393
- package/.docs/raw/docs/runtimes/opencode/hooks.mdx +0 -194
- package/.docs/raw/docs/runtimes/opencode/overview.mdx +0 -58
- package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +0 -119
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +0 -133
- package/.docs/raw/docs/tools/a2ui.mdx +0 -107
- package/.docs/raw/docs/tools/backend.mdx +0 -147
- package/.docs/raw/docs/tools/defining-tools.mdx +0 -574
- package/.docs/raw/docs/tools/dynamic-tools.mdx +0 -112
- package/.docs/raw/docs/tools/generative-ui-primitive.mdx +0 -180
- package/.docs/raw/docs/tools/generative-ui-slack.mdx +0 -167
- package/.docs/raw/docs/tools/generative-ui-teams.mdx +0 -160
- package/.docs/raw/docs/tools/generative-ui.mdx +0 -322
- package/.docs/raw/docs/tools/index.mdx +0 -72
- package/.docs/raw/docs/tools/interactables.mdx +0 -1084
- package/.docs/raw/docs/tools/mcp-apps.mdx +0 -346
- package/.docs/raw/docs/tools/mcp.mdx +0 -466
- package/.docs/raw/docs/tools/multi-agent.mdx +0 -237
- package/.docs/raw/docs/tools/openui.mdx +0 -175
- package/.docs/raw/docs/tools/tool-ui.mdx +0 -1008
- package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
- package/.docs/raw/docs/ui/accordion.mdx +0 -266
- package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
- package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
- package/.docs/raw/docs/ui/attachment.mdx +0 -259
- package/.docs/raw/docs/ui/badge.mdx +0 -150
- package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -212
- package/.docs/raw/docs/ui/context-display.mdx +0 -148
- package/.docs/raw/docs/ui/diff-viewer.mdx +0 -280
- package/.docs/raw/docs/ui/directive-text.mdx +0 -114
- package/.docs/raw/docs/ui/dot-matrix.mdx +0 -133
- package/.docs/raw/docs/ui/file.mdx +0 -159
- package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
- package/.docs/raw/docs/ui/image.mdx +0 -102
- package/.docs/raw/docs/ui/markdown.mdx +0 -64
- package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
- package/.docs/raw/docs/ui/mermaid.mdx +0 -92
- package/.docs/raw/docs/ui/message-timing.mdx +0 -93
- package/.docs/raw/docs/ui/model-selector.mdx +0 -455
- package/.docs/raw/docs/ui/number-roll.mdx +0 -154
- package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
- package/.docs/raw/docs/ui/quote.mdx +0 -211
- package/.docs/raw/docs/ui/reasoning.mdx +0 -186
- package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
- package/.docs/raw/docs/ui/select.mdx +0 -254
- package/.docs/raw/docs/ui/sources.mdx +0 -177
- package/.docs/raw/docs/ui/streamdown.mdx +0 -392
- package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
- package/.docs/raw/docs/ui/tabs.mdx +0 -271
- package/.docs/raw/docs/ui/thread-list.mdx +0 -372
- package/.docs/raw/docs/ui/thread.mdx +0 -512
- package/.docs/raw/docs/ui/tool-fallback.mdx +0 -127
- package/.docs/raw/docs/ui/tool-group.mdx +0 -240
- package/.docs/raw/docs/ui/voice.mdx +0 -173
- package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
- package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
- package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
- package/dist/constants.d.ts +0 -14
- package/dist/constants.d.ts.map +0 -1
- package/dist/constants.js +0 -19
- package/dist/constants.js.map +0 -1
- package/dist/prepare-docs/code-examples.d.ts +0 -5
- package/dist/prepare-docs/code-examples.d.ts.map +0 -1
- package/dist/prepare-docs/code-examples.js +0 -117
- package/dist/prepare-docs/code-examples.js.map +0 -1
- package/dist/prepare-docs/copy-raw.d.ts +0 -5
- package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
- package/dist/prepare-docs/copy-raw.js +0 -49
- package/dist/prepare-docs/copy-raw.js.map +0 -1
- package/dist/prepare-docs/prepare.d.ts +0 -1
- package/dist/prepare-docs/prepare.js +0 -22
- package/dist/prepare-docs/prepare.js.map +0 -1
- package/dist/prompts/xulux-playground.d.ts +0 -12
- package/dist/prompts/xulux-playground.d.ts.map +0 -1
- package/dist/prompts/xulux-playground.js +0 -33
- package/dist/prompts/xulux-playground.js.map +0 -1
- package/dist/tools/docs.d.ts +0 -22
- package/dist/tools/docs.d.ts.map +0 -1
- package/dist/tools/docs.js +0 -177
- package/dist/tools/docs.js.map +0 -1
- package/dist/tools/examples.d.ts +0 -24
- package/dist/tools/examples.d.ts.map +0 -1
- package/dist/tools/examples.js +0 -87
- package/dist/tools/examples.js.map +0 -1
- package/dist/tools/resources.d.ts +0 -6
- package/dist/tools/resources.d.ts.map +0 -1
- package/dist/tools/resources.js +0 -75
- package/dist/tools/resources.js.map +0 -1
- package/dist/tools/search.d.ts +0 -24
- package/dist/tools/search.d.ts.map +0 -1
- package/dist/tools/search.js +0 -39
- package/dist/tools/search.js.map +0 -1
- package/dist/tools/tests/mcp-test-client.d.ts +0 -15
- package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
- package/dist/tools/tests/mcp-test-client.js +0 -68
- package/dist/tools/tests/mcp-test-client.js.map +0 -1
- package/dist/tools/tests/test-setup.d.ts +0 -7
- package/dist/tools/tests/test-setup.d.ts.map +0 -1
- package/dist/tools/tests/test-setup.js +0 -36
- package/dist/tools/tests/test-setup.js.map +0 -1
- package/dist/tools/xulux-templates.d.ts +0 -58
- package/dist/tools/xulux-templates.d.ts.map +0 -1
- package/dist/tools/xulux-templates.js +0 -84
- package/dist/tools/xulux-templates.js.map +0 -1
- package/dist/utils/cache.d.ts +0 -5
- package/dist/utils/cache.d.ts.map +0 -1
- package/dist/utils/cache.js +0 -18
- package/dist/utils/cache.js.map +0 -1
- package/dist/utils/logger.d.ts +0 -10
- package/dist/utils/logger.d.ts.map +0 -1
- package/dist/utils/logger.js +0 -20
- package/dist/utils/logger.js.map +0 -1
- package/dist/utils/mcp-format.d.ts +0 -11
- package/dist/utils/mcp-format.d.ts.map +0 -1
- package/dist/utils/mcp-format.js +0 -14
- package/dist/utils/mcp-format.js.map +0 -1
- package/dist/utils/mdx.d.ts +0 -12
- package/dist/utils/mdx.d.ts.map +0 -1
- package/dist/utils/mdx.js +0 -45
- package/dist/utils/mdx.js.map +0 -1
- package/dist/utils/paths.d.ts +0 -12
- package/dist/utils/paths.d.ts.map +0 -1
- package/dist/utils/paths.js +0 -93
- package/dist/utils/paths.js.map +0 -1
- package/dist/utils/search.d.ts +0 -10
- package/dist/utils/search.d.ts.map +0 -1
- package/dist/utils/search.js +0 -97
- package/dist/utils/search.js.map +0 -1
- package/dist/utils/security.d.ts +0 -5
- package/dist/utils/security.d.ts.map +0 -1
- package/dist/utils/security.js +0 -22
- package/dist/utils/security.js.map +0 -1
- package/dist/xulux/catalog-client.d.ts +0 -14
- package/dist/xulux/catalog-client.d.ts.map +0 -1
- package/dist/xulux/catalog-client.js +0 -67
- package/dist/xulux/catalog-client.js.map +0 -1
- package/dist/xulux/fallback-catalog.d.ts +0 -7
- package/dist/xulux/fallback-catalog.d.ts.map +0 -1
- package/dist/xulux/fallback-catalog.js +0 -47
- package/dist/xulux/fallback-catalog.js.map +0 -1
- package/dist/xulux/fetch-sandbox.d.ts +0 -5
- package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
- package/dist/xulux/fetch-sandbox.js +0 -40
- package/dist/xulux/fetch-sandbox.js.map +0 -1
- package/dist/xulux/template-service.d.ts +0 -84
- package/dist/xulux/template-service.d.ts.map +0 -1
- package/dist/xulux/template-service.js +0 -223
- package/dist/xulux/template-service.js.map +0 -1
- package/dist/xulux/types.d.ts +0 -55
- package/dist/xulux/types.d.ts.map +0 -1
- package/dist/xulux/types.js +0 -6
- package/dist/xulux/types.js.map +0 -1
- package/src/constants.ts +0 -24
- package/src/prepare-docs/code-examples.ts +0 -158
- package/src/prepare-docs/copy-raw.ts +0 -50
- package/src/prepare-docs/prepare.ts +0 -24
- package/src/prompts/xulux-playground.ts +0 -36
- package/src/tools/docs.ts +0 -255
- package/src/tools/examples.ts +0 -114
- package/src/tools/resources.ts +0 -111
- package/src/tools/search.ts +0 -46
- package/src/tools/tests/completions.test.ts +0 -60
- package/src/tools/tests/directory-size-cap.test.ts +0 -50
- package/src/tools/tests/docs.test.ts +0 -144
- package/src/tools/tests/examples.test.ts +0 -94
- package/src/tools/tests/integration.test.ts +0 -45
- package/src/tools/tests/json-parsing.test.ts +0 -23
- package/src/tools/tests/listings-cache.test.ts +0 -19
- package/src/tools/tests/mcp-protocol.test.ts +0 -216
- package/src/tools/tests/mcp-test-client.ts +0 -111
- package/src/tools/tests/path-traversal.test.ts +0 -81
- package/src/tools/tests/resources.test.ts +0 -133
- package/src/tools/tests/search.test.ts +0 -37
- package/src/tools/tests/test-setup.ts +0 -50
- package/src/tools/tests/xulux-templates.test.ts +0 -262
- package/src/tools/xulux-templates.ts +0 -141
- package/src/utils/cache.ts +0 -20
- package/src/utils/logger.ts +0 -20
- package/src/utils/mcp-format.ts +0 -14
- package/src/utils/mdx.ts +0 -59
- package/src/utils/paths.ts +0 -139
- package/src/utils/search.ts +0 -131
- package/src/utils/security.ts +0 -52
- package/src/utils/tests/cache.test.ts +0 -51
- package/src/utils/tests/mcp-format.test.ts +0 -22
- package/src/utils/tests/security.test.ts +0 -119
- package/src/xulux/catalog-client.ts +0 -105
- package/src/xulux/fallback-catalog.ts +0 -63
- package/src/xulux/fetch-sandbox.ts +0 -56
- package/src/xulux/template-service.ts +0 -406
- package/src/xulux/types.ts +0 -60
|
@@ -1,212 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Composer Trigger Popover
|
|
3
|
-
description: Reusable picker UI for @ mentions, / slash commands, and any other character-triggered popover.
|
|
4
|
-
platforms: ["react"]
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
import { ComposerTriggerPopoverSample } from "@/components/docs/samples/composer-trigger-popover";
|
|
8
|
-
|
|
9
|
-
<ComposerTriggerPopoverSample />
|
|
10
|
-
|
|
11
|
-
## Getting Started
|
|
12
|
-
|
|
13
|
-
<Steps>
|
|
14
|
-
<Step>
|
|
15
|
-
|
|
16
|
-
### Add `composer-trigger-popover`
|
|
17
|
-
|
|
18
|
-
<InstallCommand shadcn={["composer-trigger-popover"]} />
|
|
19
|
-
|
|
20
|
-
This adds `/components/assistant-ui/composer-trigger-popover.tsx` — a generic picker UI (Categories + Items + Back) driven by an adapter and one of two behavior props: `directive` (insert a chip) or `action` (run a callback).
|
|
21
|
-
|
|
22
|
-
</Step>
|
|
23
|
-
<Step>
|
|
24
|
-
|
|
25
|
-
### Wrap the composer
|
|
26
|
-
|
|
27
|
-
Place `ComposerPrimitive.Unstable_TriggerPopoverRoot` around your composer. Any number of `ComposerTriggerPopover` declarations can live inside — each with its own trigger character, adapter, and behavior prop.
|
|
28
|
-
|
|
29
|
-
```tsx title="components/assistant-ui/thread.tsx"
|
|
30
|
-
import { ComposerPrimitive } from "@assistant-ui/react";
|
|
31
|
-
import { ComposerTriggerPopover } from "@/components/assistant-ui/composer-trigger-popover";
|
|
32
|
-
|
|
33
|
-
const Composer = () => (
|
|
34
|
-
<ComposerPrimitive.Unstable_TriggerPopoverRoot>
|
|
35
|
-
<ComposerPrimitive.Root>
|
|
36
|
-
<ComposerPrimitive.Input placeholder="Type @ to mention, / for commands..." />
|
|
37
|
-
<ComposerPrimitive.Send />
|
|
38
|
-
|
|
39
|
-
{/* triggers declared here */}
|
|
40
|
-
</ComposerPrimitive.Root>
|
|
41
|
-
</ComposerPrimitive.Unstable_TriggerPopoverRoot>
|
|
42
|
-
);
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
</Step>
|
|
46
|
-
</Steps>
|
|
47
|
-
|
|
48
|
-
## @ Mention
|
|
49
|
-
|
|
50
|
-
Pair the popover with `unstable_useMentionAdapter` — the hook returns a spreadable `{ adapter, directive }` bundle so selecting an item writes a `:tool[Label]{name=id}` directive into the composer text.
|
|
51
|
-
|
|
52
|
-
```tsx
|
|
53
|
-
import { unstable_useMentionAdapter } from "@assistant-ui/react";
|
|
54
|
-
import { WrenchIcon } from "lucide-react";
|
|
55
|
-
|
|
56
|
-
const mention = unstable_useMentionAdapter();
|
|
57
|
-
|
|
58
|
-
<ComposerTriggerPopover
|
|
59
|
-
char="@"
|
|
60
|
-
{...mention}
|
|
61
|
-
fallbackIcon={WrenchIcon}
|
|
62
|
-
/>;
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Override formatter or add an `onInserted` callback via hook options: `unstable_useMentionAdapter({ formatter, onInserted })`.
|
|
66
|
-
|
|
67
|
-
`unstable_useMentionAdapter` also accepts `items` (flat custom list), `categories` (multi-category drill-down), and `includeModelContextTools` for fine-grained control. See the [Mentions guide](/docs/guides/mentions#built-in-mention-adapter).
|
|
68
|
-
|
|
69
|
-
Render selected mentions as chips in user messages with [`DirectiveText`](/docs/ui/directive-text). For inline chips **inside** the composer, use [`LexicalComposerInput`](/docs/guides/mentions#textarea-vs-lexical).
|
|
70
|
-
|
|
71
|
-
## / Slash Command
|
|
72
|
-
|
|
73
|
-
Use [`unstable_useSlashCommandAdapter`](/docs/guides/slash-commands) to bundle commands (data + `execute`) into `{ adapter, action }` — then plug both into `ComposerTriggerPopover`. By default a directive chip is left in the composer as an audit trail; pass `removeOnExecute` to strip the `/command` text entirely. `iconMap` maps `metadata.icon` strings on items and categories to Lucide icons.
|
|
74
|
-
|
|
75
|
-
```tsx
|
|
76
|
-
import {
|
|
77
|
-
unstable_useSlashCommandAdapter,
|
|
78
|
-
type Unstable_SlashCommand,
|
|
79
|
-
} from "@assistant-ui/react";
|
|
80
|
-
import { FileTextIcon, GlobeIcon, LanguagesIcon, SlashIcon } from "lucide-react";
|
|
81
|
-
|
|
82
|
-
const SLASH_COMMANDS: readonly Unstable_SlashCommand[] = [
|
|
83
|
-
{
|
|
84
|
-
id: "summarize",
|
|
85
|
-
description: "Summarize the conversation",
|
|
86
|
-
icon: "FileText",
|
|
87
|
-
execute: () => {/* ... */},
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
id: "translate",
|
|
91
|
-
description: "Translate to another language",
|
|
92
|
-
icon: "Languages",
|
|
93
|
-
execute: () => {/* ... */},
|
|
94
|
-
},
|
|
95
|
-
{
|
|
96
|
-
id: "search",
|
|
97
|
-
description: "Search the web",
|
|
98
|
-
icon: "Globe",
|
|
99
|
-
execute: () => {/* ... */},
|
|
100
|
-
},
|
|
101
|
-
];
|
|
102
|
-
|
|
103
|
-
function SlashComposer() {
|
|
104
|
-
const slash = unstable_useSlashCommandAdapter({ commands: SLASH_COMMANDS });
|
|
105
|
-
|
|
106
|
-
return (
|
|
107
|
-
<ComposerTriggerPopover
|
|
108
|
-
char="/"
|
|
109
|
-
{...slash}
|
|
110
|
-
iconMap={{
|
|
111
|
-
FileText: FileTextIcon,
|
|
112
|
-
Languages: LanguagesIcon,
|
|
113
|
-
Globe: GlobeIcon,
|
|
114
|
-
}}
|
|
115
|
-
fallbackIcon={SlashIcon}
|
|
116
|
-
/>
|
|
117
|
-
);
|
|
118
|
-
}
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
## Combining Triggers
|
|
122
|
-
|
|
123
|
-
Multiple popovers coexist under one `TriggerPopoverRoot`. Each reads state from its own declaration, so `@` and `/` never collide.
|
|
124
|
-
|
|
125
|
-
```tsx
|
|
126
|
-
const commandHandlers: Record<string, () => void> = {
|
|
127
|
-
summarize: () => {/* ... */},
|
|
128
|
-
translate: () => {/* ... */},
|
|
129
|
-
};
|
|
130
|
-
|
|
131
|
-
<ComposerPrimitive.Unstable_TriggerPopoverRoot>
|
|
132
|
-
<ComposerPrimitive.Root>
|
|
133
|
-
<ComposerPrimitive.Input placeholder="Type @ to mention, / for commands..." />
|
|
134
|
-
|
|
135
|
-
<ComposerTriggerPopover
|
|
136
|
-
char="@"
|
|
137
|
-
adapter={mentionAdapter}
|
|
138
|
-
directive={{ formatter: unstable_defaultDirectiveFormatter }}
|
|
139
|
-
fallbackIcon={WrenchIcon}
|
|
140
|
-
/>
|
|
141
|
-
<ComposerTriggerPopover
|
|
142
|
-
char="/"
|
|
143
|
-
adapter={slashAdapter}
|
|
144
|
-
action={{
|
|
145
|
-
formatter: unstable_defaultDirectiveFormatter,
|
|
146
|
-
onExecute: (item) => commandHandlers[item.id]?.(),
|
|
147
|
-
}}
|
|
148
|
-
iconMap={slashIcons}
|
|
149
|
-
fallbackIcon={SlashIcon}
|
|
150
|
-
/>
|
|
151
|
-
</ComposerPrimitive.Root>
|
|
152
|
-
</ComposerPrimitive.Unstable_TriggerPopoverRoot>
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
## Keyboard Navigation
|
|
156
|
-
|
|
157
|
-
| Key | Action |
|
|
158
|
-
| --- | --- |
|
|
159
|
-
| <Kbd>ArrowDown</Kbd> | Highlight next item |
|
|
160
|
-
| <Kbd>ArrowUp</Kbd> | Highlight previous item |
|
|
161
|
-
| <Kbd>Enter</Kbd> / <Kbd>Tab</Kbd> | Select highlighted item / drill into category |
|
|
162
|
-
| <Kbd>Shift + Enter</Kbd> | Insert newline (popover stays open) |
|
|
163
|
-
| <Kbd>Shift + Tab</Kbd> | Pass through (native focus traversal) |
|
|
164
|
-
| <Kbd>Escape</Kbd> | Close popover |
|
|
165
|
-
| <Kbd>Backspace</Kbd> | Go back to categories (when query is empty) |
|
|
166
|
-
|
|
167
|
-
## Accessibility
|
|
168
|
-
|
|
169
|
-
The popover implements the WAI-ARIA editable combobox pattern.
|
|
170
|
-
|
|
171
|
-
- The listbox container has `role="listbox"` and each item has `role="option"` plus `aria-selected`.
|
|
172
|
-
- When a popover is open, `ComposerPrimitive.Input` (the underlying `<textarea>`) automatically receives `aria-controls`, `aria-expanded="true"`, `aria-haspopup="listbox"`, and `aria-activedescendant` pointing at the highlighted option. Attributes are removed when the popover closes.
|
|
173
|
-
- When `ComposerPrimitive.Input` is rendered outside a `TriggerPopoverRoot`, no ARIA attributes are added.
|
|
174
|
-
|
|
175
|
-
## API Reference
|
|
176
|
-
|
|
177
|
-
| Prop | Type | Default | Description |
|
|
178
|
-
| --- | --- | --- | --- |
|
|
179
|
-
| `char` | `string` | — | Trigger character, e.g. `"@"` or `"/"` (required; unique within the root) |
|
|
180
|
-
| `adapter` | `Unstable_TriggerAdapter` | — | Provides categories, items, and search (required) |
|
|
181
|
-
| `directive` | `{ formatter, onInserted?, chip? }` | — | Enables directive-insert behavior. Mutually exclusive with `action`. |
|
|
182
|
-
| `action` | `{ formatter, onExecute, removeOnExecute?, chip? }` | — | Enables action behavior. Mutually exclusive with `directive`. |
|
|
183
|
-
| `iconMap` | `Record<string, IconComponent>` | — | Maps `item.metadata.icon` / `category.metadata.icon` strings to icons |
|
|
184
|
-
| `fallbackIcon` | `IconComponent` | `SparklesIcon` | Icon used when no `iconMap` entry matches |
|
|
185
|
-
| `backLabel` | `string` | `"Back"` | Back button label |
|
|
186
|
-
| `emptyCategoriesLabel` | `string` | `"No items available"` | Shown when no categories are available |
|
|
187
|
-
| `emptyItemsLabel` | `string` | `"No matching items"` | Shown when no items match |
|
|
188
|
-
| `isLoading` | `boolean` | `false` | Whether the adapter is resolving items (async sources). Pair with `unstable_useLiveCompletionAdapter`. |
|
|
189
|
-
| `loadingLabel` | `string` | `"Loading…"` | Shown in place of `emptyItemsLabel` while `isLoading` and no items are present |
|
|
190
|
-
|
|
191
|
-
All other props (`className`, etc.) forward to the underlying popover `div`.
|
|
192
|
-
|
|
193
|
-
### `directive` object
|
|
194
|
-
|
|
195
|
-
| Field | Type | Description |
|
|
196
|
-
| --- | --- | --- |
|
|
197
|
-
| `formatter` | `Unstable_DirectiveFormatter` | Serializes the selected item into the directive text written to the composer |
|
|
198
|
-
| `onInserted` | `(item) => void` | Optional callback fired after the directive has been inserted |
|
|
199
|
-
|
|
200
|
-
### `action` object
|
|
201
|
-
|
|
202
|
-
| Field | Type | Description |
|
|
203
|
-
| --- | --- | --- |
|
|
204
|
-
| `formatter` | `Unstable_DirectiveFormatter` | Serializes the selected item into the chip left behind (unused when `removeOnExecute`) |
|
|
205
|
-
| `onExecute` | `(item) => void` | Callback fired when an item is selected |
|
|
206
|
-
| `removeOnExecute` | `boolean` | When `true`, strips the trigger text instead of leaving a chip. Default `false`. |
|
|
207
|
-
|
|
208
|
-
## Related
|
|
209
|
-
|
|
210
|
-
- [Directive Text](/docs/ui/directive-text) — renderer for mention chips in user messages
|
|
211
|
-
- [Mentions guide](/docs/guides/mentions) — `@`-mention architecture and formatter details
|
|
212
|
-
- [Slash Commands guide](/docs/guides/slash-commands) — `/`-command architecture
|
|
@@ -1,148 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Context Display
|
|
3
|
-
description: Visualize token usage relative to a model's context window — ring, bar, or text — with a detailed hover popover.
|
|
4
|
-
platforms: ["react"]
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
import { ContextDisplaySample } from "@/components/docs/samples/context-display";
|
|
8
|
-
|
|
9
|
-
<ContextDisplaySample />
|
|
10
|
-
|
|
11
|
-
<Callout type="info">
|
|
12
|
-
This component requires server-side setup to [forward token usage metadata](#forward-token-usage-from-your-route-handler). Without it, ContextDisplay will show 0 usage and no breakdown data.
|
|
13
|
-
</Callout>
|
|
14
|
-
|
|
15
|
-
## Getting Started
|
|
16
|
-
|
|
17
|
-
<Steps>
|
|
18
|
-
<Step>
|
|
19
|
-
|
|
20
|
-
### Add `context-display`
|
|
21
|
-
|
|
22
|
-
<InstallCommand shadcn={["context-display"]} />
|
|
23
|
-
|
|
24
|
-
This adds a `/components/assistant-ui/context-display.tsx` file to your project.
|
|
25
|
-
|
|
26
|
-
</Step>
|
|
27
|
-
<Step>
|
|
28
|
-
|
|
29
|
-
### Forward token usage from your route handler
|
|
30
|
-
|
|
31
|
-
Use `messageMetadata` in your Next.js route to attach `usage` from `finish` and `modelId` from `finish-step`:
|
|
32
|
-
|
|
33
|
-
```tsx title="app/api/chat/route.ts"
|
|
34
|
-
import { streamText, convertToModelMessages } from "ai";
|
|
35
|
-
|
|
36
|
-
export async function POST(req: Request) {
|
|
37
|
-
const { messages, config } = await req.json();
|
|
38
|
-
const result = streamText({
|
|
39
|
-
model: getModel(config?.modelName),
|
|
40
|
-
messages: await convertToModelMessages(messages),
|
|
41
|
-
});
|
|
42
|
-
return result.toUIMessageStreamResponse({
|
|
43
|
-
messageMetadata: ({ part }) => {
|
|
44
|
-
if (part.type === "finish") {
|
|
45
|
-
return {
|
|
46
|
-
usage: part.totalUsage,
|
|
47
|
-
};
|
|
48
|
-
}
|
|
49
|
-
if (part.type === "finish-step") {
|
|
50
|
-
return {
|
|
51
|
-
modelId: part.response.modelId,
|
|
52
|
-
};
|
|
53
|
-
}
|
|
54
|
-
return undefined;
|
|
55
|
-
},
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
</Step>
|
|
61
|
-
<Step>
|
|
62
|
-
|
|
63
|
-
### Use in your application
|
|
64
|
-
|
|
65
|
-
Pick a variant and place it in your thread footer, composer, or sidebar. Pass `modelContextWindow` with your model's token limit.
|
|
66
|
-
|
|
67
|
-
```tsx title="/components/assistant-ui/thread.tsx" {1,8}
|
|
68
|
-
import { ContextDisplay } from "@/components/assistant-ui/context-display";
|
|
69
|
-
|
|
70
|
-
const ThreadFooter: FC = () => {
|
|
71
|
-
return (
|
|
72
|
-
<div className="flex items-center justify-end px-3 py-1.5">
|
|
73
|
-
<ContextDisplay.Bar modelContextWindow={128000} />
|
|
74
|
-
</div>
|
|
75
|
-
);
|
|
76
|
-
};
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
</Step>
|
|
80
|
-
</Steps>
|
|
81
|
-
|
|
82
|
-
## Variants
|
|
83
|
-
|
|
84
|
-
Three preset variants are available, each wrapping the shared tooltip popover:
|
|
85
|
-
|
|
86
|
-
```tsx
|
|
87
|
-
// SVG donut ring (default, compact)
|
|
88
|
-
<ContextDisplay.Ring modelContextWindow={128000} />
|
|
89
|
-
|
|
90
|
-
// Horizontal progress bar with label
|
|
91
|
-
<ContextDisplay.Bar modelContextWindow={128000} />
|
|
92
|
-
|
|
93
|
-
// Minimal monospace text
|
|
94
|
-
<ContextDisplay.Text modelContextWindow={128000} />
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
All presets accept `className` for styling overrides and `side` to control tooltip placement (`"top"`, `"bottom"`, `"left"`, `"right"`).
|
|
98
|
-
|
|
99
|
-
## Composable API
|
|
100
|
-
|
|
101
|
-
For custom visualizations, use the building blocks directly:
|
|
102
|
-
|
|
103
|
-
```tsx
|
|
104
|
-
import { ContextDisplay } from "@/components/assistant-ui/context-display";
|
|
105
|
-
|
|
106
|
-
<ContextDisplay.Root modelContextWindow={128000}>
|
|
107
|
-
<ContextDisplay.Trigger aria-label="Context usage">
|
|
108
|
-
<MyCustomGauge />
|
|
109
|
-
</ContextDisplay.Trigger>
|
|
110
|
-
<ContextDisplay.Content side="top" />
|
|
111
|
-
</ContextDisplay.Root>
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
| Component | Description |
|
|
115
|
-
|-----------|-------------|
|
|
116
|
-
| `Root` | Uses provided `usage` when supplied, otherwise fetches token usage internally; provides shared context and wraps children in a tooltip |
|
|
117
|
-
| `Trigger` | Button that opens the tooltip on hover |
|
|
118
|
-
| `Content` | Tooltip popover with the token breakdown (Usage %, Input, Cached, Output, Reasoning, Total) |
|
|
119
|
-
|
|
120
|
-
## API Reference
|
|
121
|
-
|
|
122
|
-
### Preset Props
|
|
123
|
-
|
|
124
|
-
All preset variants (`Ring`, `Bar`, `Text`) share the same props:
|
|
125
|
-
|
|
126
|
-
| Prop | Type | Default | Description |
|
|
127
|
-
|------|------|---------|-------------|
|
|
128
|
-
| `modelContextWindow` | `number` | — | Maximum token limit of the current model (required) |
|
|
129
|
-
| `className` | `string` | — | Additional class names on the trigger button |
|
|
130
|
-
| `side` | `"top" \| "bottom" \| "left" \| "right"` | `"top"` | Tooltip placement |
|
|
131
|
-
| `usage` | `ThreadTokenUsage` | — | Optional externally-provided usage data (skips internal usage fetch when provided) |
|
|
132
|
-
|
|
133
|
-
### Color Thresholds
|
|
134
|
-
|
|
135
|
-
Ring and Bar share the same severity colors:
|
|
136
|
-
|
|
137
|
-
| Level | Threshold | Ring | Bar |
|
|
138
|
-
|-------|-----------|------|-----|
|
|
139
|
-
| Low | `< 65%` | `stroke-emerald-500` | `bg-emerald-500` |
|
|
140
|
-
| Warning | `65% – 85%` | `stroke-amber-500` | `bg-amber-500` |
|
|
141
|
-
| Critical | `> 85%` | `stroke-red-500` | `bg-red-500` |
|
|
142
|
-
|
|
143
|
-
Text displays numeric values only — no severity color.
|
|
144
|
-
|
|
145
|
-
## Related
|
|
146
|
-
|
|
147
|
-
- [Message Timing](/docs/ui/message-timing) — Streaming performance stats (TTFT, tok/s)
|
|
148
|
-
- [Thread](/docs/ui/thread) — The thread component where ContextDisplay is typically placed
|
|
@@ -1,280 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Diff Viewer"
|
|
3
|
-
description: Render code diffs with syntax highlighting for additions and deletions.
|
|
4
|
-
links:
|
|
5
|
-
- label: parse-diff
|
|
6
|
-
url: https://github.com/sergeyt/parse-diff
|
|
7
|
-
- label: diff
|
|
8
|
-
url: https://github.com/kpdecker/jsdiff
|
|
9
|
-
platforms: ["react"]
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
import { PreviewCode } from "@/components/docs/preview-code.server";
|
|
13
|
-
import {
|
|
14
|
-
DiffViewerSample,
|
|
15
|
-
DiffViewerSplitSample,
|
|
16
|
-
DiffViewerViewModesSample,
|
|
17
|
-
DiffViewerVariantsSample,
|
|
18
|
-
DiffViewerSizesSample,
|
|
19
|
-
} from "@/components/docs/samples/diff-viewer";
|
|
20
|
-
|
|
21
|
-
<Callout>
|
|
22
|
-
This is a **standalone component** that does not depend on the assistant-ui runtime.
|
|
23
|
-
</Callout>
|
|
24
|
-
|
|
25
|
-
<DiffViewerViewModesSample />
|
|
26
|
-
|
|
27
|
-
## Installation
|
|
28
|
-
|
|
29
|
-
<InstallCommand shadcn={["diff-viewer"]} />
|
|
30
|
-
|
|
31
|
-
## Usage
|
|
32
|
-
|
|
33
|
-
```tsx
|
|
34
|
-
import { DiffViewer } from "@/components/assistant-ui/diff-viewer";
|
|
35
|
-
|
|
36
|
-
// With a unified diff patch
|
|
37
|
-
<DiffViewer patch={diffString} />
|
|
38
|
-
|
|
39
|
-
// With file comparison
|
|
40
|
-
<DiffViewer
|
|
41
|
-
oldFile={{ content: "old content", name: "file.txt" }}
|
|
42
|
-
newFile={{ content: "new content", name: "file.txt" }}
|
|
43
|
-
/>
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### As Markdown Language Override
|
|
47
|
-
|
|
48
|
-
Integrate with `MarkdownTextPrimitive` to render diff code blocks:
|
|
49
|
-
|
|
50
|
-
```tsx title="/components/assistant-ui/markdown-text.tsx"
|
|
51
|
-
import { DiffViewer } from "@/components/assistant-ui/diff-viewer"; // [!code ++]
|
|
52
|
-
|
|
53
|
-
const MarkdownTextImpl = () => {
|
|
54
|
-
return (
|
|
55
|
-
<MarkdownTextPrimitive
|
|
56
|
-
remarkPlugins={[remarkGfm]}
|
|
57
|
-
className="aui-md"
|
|
58
|
-
components={defaultComponents}
|
|
59
|
-
componentsByLanguage={{ // [!code ++]
|
|
60
|
-
diff: { // [!code ++]
|
|
61
|
-
SyntaxHighlighter: ({ code }) => <DiffViewer patch={code} /> // [!code ++]
|
|
62
|
-
}, // [!code ++]
|
|
63
|
-
}} // [!code ++]
|
|
64
|
-
/>
|
|
65
|
-
);
|
|
66
|
-
};
|
|
67
|
-
|
|
68
|
-
export const MarkdownText = memo(MarkdownTextImpl);
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## Examples
|
|
72
|
-
|
|
73
|
-
### Unified View
|
|
74
|
-
|
|
75
|
-
Shows all changes in a single column with `+`/`-` indicators. This is the default mode.
|
|
76
|
-
|
|
77
|
-
<DiffViewerSample />
|
|
78
|
-
|
|
79
|
-
```tsx
|
|
80
|
-
<DiffViewer patch={diffString} viewMode="unified" />
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
### Split View
|
|
84
|
-
|
|
85
|
-
Shows old content on the left, new content on the right side-by-side.
|
|
86
|
-
|
|
87
|
-
<DiffViewerSplitSample />
|
|
88
|
-
|
|
89
|
-
```tsx
|
|
90
|
-
<DiffViewer patch={diffString} viewMode="split" />
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
### Interactive Mode Toggle
|
|
94
|
-
|
|
95
|
-
<PreviewCode file="components/docs/samples/diff-viewer" name="DiffViewerViewModesSample">
|
|
96
|
-
<DiffViewerViewModesSample />
|
|
97
|
-
</PreviewCode>
|
|
98
|
-
|
|
99
|
-
### Variants
|
|
100
|
-
|
|
101
|
-
<DiffViewerVariantsSample />
|
|
102
|
-
|
|
103
|
-
### Sizes
|
|
104
|
-
|
|
105
|
-
<DiffViewerSizesSample />
|
|
106
|
-
|
|
107
|
-
### Theming
|
|
108
|
-
|
|
109
|
-
DiffViewer uses CSS variables for colors. Override them in your CSS:
|
|
110
|
-
|
|
111
|
-
```css
|
|
112
|
-
[data-slot="diff-viewer"] {
|
|
113
|
-
--diff-add-bg: rgba(46, 160, 67, 0.15);
|
|
114
|
-
--diff-add-text: #1a7f37;
|
|
115
|
-
--diff-add-text-dark: #3fb950;
|
|
116
|
-
--diff-del-bg: rgba(248, 81, 73, 0.15);
|
|
117
|
-
--diff-del-text: #cf222e;
|
|
118
|
-
--diff-del-text-dark: #f85149;
|
|
119
|
-
}
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
| Variable | Description |
|
|
123
|
-
|----------|-------------|
|
|
124
|
-
| `--diff-add-bg` | Background for added lines |
|
|
125
|
-
| `--diff-add-text` | Text color for added lines (light mode) |
|
|
126
|
-
| `--diff-add-text-dark` | Text color for added lines (dark mode) |
|
|
127
|
-
| `--diff-del-bg` | Background for deleted lines |
|
|
128
|
-
| `--diff-del-text` | Text color for deleted lines (light mode) |
|
|
129
|
-
| `--diff-del-text-dark` | Text color for deleted lines (dark mode) |
|
|
130
|
-
|
|
131
|
-
## API Reference
|
|
132
|
-
|
|
133
|
-
### DiffViewer
|
|
134
|
-
|
|
135
|
-
The main component for rendering diffs.
|
|
136
|
-
|
|
137
|
-
<ParametersTable
|
|
138
|
-
type="DiffViewerProps"
|
|
139
|
-
parameters={[
|
|
140
|
-
{
|
|
141
|
-
name: "patch",
|
|
142
|
-
type: "string",
|
|
143
|
-
description: "Unified diff string (e.g., output from git diff).",
|
|
144
|
-
},
|
|
145
|
-
{
|
|
146
|
-
name: "code",
|
|
147
|
-
type: "string",
|
|
148
|
-
description: "Alias for patch (for markdown integration).",
|
|
149
|
-
},
|
|
150
|
-
{
|
|
151
|
-
name: "oldFile",
|
|
152
|
-
type: "{ content: string; name?: string }",
|
|
153
|
-
description: "Old file for direct comparison.",
|
|
154
|
-
},
|
|
155
|
-
{
|
|
156
|
-
name: "newFile",
|
|
157
|
-
type: "{ content: string; name?: string }",
|
|
158
|
-
description: "New file for direct comparison.",
|
|
159
|
-
},
|
|
160
|
-
{
|
|
161
|
-
name: "viewMode",
|
|
162
|
-
type: '"unified" | "split"',
|
|
163
|
-
default: '"unified"',
|
|
164
|
-
description: "Display mode for the diff.",
|
|
165
|
-
},
|
|
166
|
-
{
|
|
167
|
-
name: "variant",
|
|
168
|
-
type: '"default" | "ghost" | "muted"',
|
|
169
|
-
default: '"default"',
|
|
170
|
-
description: "Visual style variant.",
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
name: "size",
|
|
174
|
-
type: '"sm" | "default" | "lg"',
|
|
175
|
-
default: '"default"',
|
|
176
|
-
description: "Font size.",
|
|
177
|
-
},
|
|
178
|
-
{
|
|
179
|
-
name: "showLineNumbers",
|
|
180
|
-
type: "boolean",
|
|
181
|
-
default: "true",
|
|
182
|
-
description: "Show line numbers.",
|
|
183
|
-
},
|
|
184
|
-
{
|
|
185
|
-
name: "showIcon",
|
|
186
|
-
type: "boolean",
|
|
187
|
-
default: "true",
|
|
188
|
-
description: "Show file extension badge in header.",
|
|
189
|
-
},
|
|
190
|
-
{
|
|
191
|
-
name: "showStats",
|
|
192
|
-
type: "boolean",
|
|
193
|
-
default: "true",
|
|
194
|
-
description: "Show addition/deletion counts in header.",
|
|
195
|
-
},
|
|
196
|
-
{
|
|
197
|
-
name: "className",
|
|
198
|
-
type: "string",
|
|
199
|
-
description: "Additional CSS classes.",
|
|
200
|
-
},
|
|
201
|
-
]}
|
|
202
|
-
/>
|
|
203
|
-
|
|
204
|
-
### Composable API
|
|
205
|
-
|
|
206
|
-
| Component | Description |
|
|
207
|
-
|-----------|-------------|
|
|
208
|
-
| `DiffViewer` | Main component that renders the diff. |
|
|
209
|
-
| `DiffViewerFile` | Wrapper for each file in multi-file diffs. |
|
|
210
|
-
| `DiffViewerHeader` | File name header with icon and stats. |
|
|
211
|
-
| `DiffViewerContent` | Scrollable content area. |
|
|
212
|
-
| `DiffViewerLine` | Individual line in unified mode. |
|
|
213
|
-
| `DiffViewerSplitLine` | Side-by-side line pair in split mode. |
|
|
214
|
-
| `DiffViewerFileBadge` | File extension badge (e.g., "TS"). |
|
|
215
|
-
| `DiffViewerStats` | Addition/deletion count display. |
|
|
216
|
-
|
|
217
|
-
### Style Variants (CVA)
|
|
218
|
-
|
|
219
|
-
| Export | Description |
|
|
220
|
-
|--------|-------------|
|
|
221
|
-
| `diffViewerVariants` | Styles for the root container. |
|
|
222
|
-
| `diffLineVariants` | Background styles for diff lines. |
|
|
223
|
-
| `diffLineTextVariants` | Text color styles for diff lines. |
|
|
224
|
-
|
|
225
|
-
```tsx
|
|
226
|
-
import {
|
|
227
|
-
diffViewerVariants,
|
|
228
|
-
diffLineVariants,
|
|
229
|
-
diffLineTextVariants,
|
|
230
|
-
} from "@/components/assistant-ui/diff-viewer";
|
|
231
|
-
|
|
232
|
-
// Use variants directly
|
|
233
|
-
<div className={diffViewerVariants({ variant: "ghost", size: "sm" })}>
|
|
234
|
-
Custom diff container
|
|
235
|
-
</div>
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
### Utilities
|
|
239
|
-
|
|
240
|
-
| Export | Description |
|
|
241
|
-
|--------|-------------|
|
|
242
|
-
| `parsePatch(patch)` | Parse unified diff string into structured data. |
|
|
243
|
-
| `computeDiff(old, new)` | Compute diff between two strings. |
|
|
244
|
-
| `ParsedLine` | Type for a single diff line. |
|
|
245
|
-
| `ParsedFile` | Type for a parsed file with lines and stats. |
|
|
246
|
-
| `SplitLinePair` | Type for a side-by-side line pair. |
|
|
247
|
-
|
|
248
|
-
## Styling
|
|
249
|
-
|
|
250
|
-
### Data Attributes
|
|
251
|
-
|
|
252
|
-
Use data attributes for custom styling:
|
|
253
|
-
|
|
254
|
-
| Attribute | Values | Description |
|
|
255
|
-
|-----------|--------|-------------|
|
|
256
|
-
| `data-slot` | `"diff-viewer"`, `"diff-viewer-header"`, `"diff-viewer-line"`, etc. | Component identification |
|
|
257
|
-
| `data-type` | `"add"`, `"del"`, `"normal"`, `"empty"` | Line type |
|
|
258
|
-
| `data-view-mode` | `"unified"`, `"split"` | Current view mode |
|
|
259
|
-
| `data-variant` | `"default"`, `"ghost"`, `"muted"` | Current variant |
|
|
260
|
-
|
|
261
|
-
### Custom CSS Example
|
|
262
|
-
|
|
263
|
-
```css
|
|
264
|
-
[data-slot="diff-viewer"][data-view-mode="split"] {
|
|
265
|
-
/* Custom split view styles */
|
|
266
|
-
}
|
|
267
|
-
|
|
268
|
-
[data-slot="diff-viewer-line"][data-type="add"] {
|
|
269
|
-
/* Custom addition styles */
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
[data-slot="diff-viewer-line"][data-type="del"] {
|
|
273
|
-
/* Custom deletion styles */
|
|
274
|
-
}
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
## Related Components
|
|
278
|
-
|
|
279
|
-
- [Markdown](/docs/ui/markdown) - Rich text rendering where diff viewer can be integrated
|
|
280
|
-
- [Syntax Highlighting](/docs/ui/syntax-highlighting) - Code highlighting for other languages
|