@assistant-ui/mcp-docs-server 0.2.3 → 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 +8 -12
- 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 -675
- package/.docs/organized/code-examples/with-ag-ui.md +0 -553
- package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -466
- package/.docs/organized/code-examples/with-artifacts.md +0 -815
- package/.docs/organized/code-examples/with-assistant-transport.md +0 -576
- package/.docs/organized/code-examples/with-browser-extension.md +0 -371
- package/.docs/organized/code-examples/with-chain-of-thought.md +0 -962
- package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
- package/.docs/organized/code-examples/with-cloud.md +0 -439
- package/.docs/organized/code-examples/with-custom-thread-list.md +0 -569
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -527
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -697
- package/.docs/organized/code-examples/with-eve.md +0 -405
- package/.docs/organized/code-examples/with-expo.md +0 -2246
- package/.docs/organized/code-examples/with-external-store.md +0 -421
- package/.docs/organized/code-examples/with-ffmpeg.md +0 -829
- package/.docs/organized/code-examples/with-generative-ui.md +0 -1810
- package/.docs/organized/code-examples/with-google-adk.md +0 -368
- package/.docs/organized/code-examples/with-heat-graph.md +0 -304
- package/.docs/organized/code-examples/with-image-generation.md +0 -463
- package/.docs/organized/code-examples/with-interactables.md +0 -733
- package/.docs/organized/code-examples/with-langchain.md +0 -446
- package/.docs/organized/code-examples/with-langgraph.md +0 -855
- package/.docs/organized/code-examples/with-livekit.md +0 -643
- package/.docs/organized/code-examples/with-mcp.md +0 -782
- 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 -450
- package/.docs/organized/code-examples/with-pi.md +0 -2084
- package/.docs/organized/code-examples/with-react-hook-form.md +0 -727
- package/.docs/organized/code-examples/with-react-ink-web.md +0 -740
- package/.docs/organized/code-examples/with-react-ink.md +0 -473
- package/.docs/organized/code-examples/with-react-router.md +0 -936
- package/.docs/organized/code-examples/with-resumable-stream.md +0 -668
- 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 -812
- package/.docs/organized/code-examples/with-tap-runtime.md +0 -813
- package/.docs/organized/code-examples/with-virtualized-thread.md +0 -681
- package/.docs/organized/code-examples/with-vue.md +0 -408
- package/.docs/raw/docs/(getting-started)/architecture.mdx +0 -146
- package/.docs/raw/docs/(getting-started)/base-ui.mdx +0 -39
- package/.docs/raw/docs/(getting-started)/cli.mdx +0 -542
- package/.docs/raw/docs/(getting-started)/devtools.mdx +0 -79
- package/.docs/raw/docs/(getting-started)/index.mdx +0 -23
- package/.docs/raw/docs/(getting-started)/installation.mdx +0 -483
- package/.docs/raw/docs/(getting-started)/llm.mdx +0 -211
- package/.docs/raw/docs/(getting-started)/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 -26
- 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 -57
- 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/ai-sdk.mdx +0 -200
- 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 -118
- package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
- 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 -637
- 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 -152
- 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 -604
- 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 -411
- 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 -215
- 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 -237
- 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.mdx +0 -283
- 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 -976
- 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 -267
- 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 -731
- 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 -363
- 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 -1020
- package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
- 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 -279
- package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -247
- package/.docs/raw/docs/ui/context-display.mdx +0 -148
- package/.docs/raw/docs/ui/directive-text.mdx +0 -114
- 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 -103
- 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/part-grouping.mdx +0 -614
- package/.docs/raw/docs/ui/quote.mdx +0 -211
- package/.docs/raw/docs/ui/reasoning.mdx +0 -214
- package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
- package/.docs/raw/docs/ui/sources.mdx +0 -186
- package/.docs/raw/docs/ui/streamdown.mdx +0 -392
- package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
- package/.docs/raw/docs/ui/thread-list.mdx +0 -411
- package/.docs/raw/docs/ui/thread.mdx +0 -559
- package/.docs/raw/docs/ui/tool-fallback.mdx +0 -141
- 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 -112
- 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 -147
- 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 -84
- 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 -325
- 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 -150
- 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 -64
|
@@ -1,637 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ComposerPrimitive
|
|
3
|
-
description: Composable input primitives for assistant-ui prompts, send controls, cancellation, attachments, and composer state.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { ComposerPrimitiveAddAttachmentProps, ComposerPrimitiveAttachmentByIndexProps, ComposerPrimitiveAttachmentDropzoneProps, ComposerPrimitiveAttachmentsProps, ComposerPrimitiveCancelProps, ComposerPrimitiveDictateProps, ComposerPrimitiveDictationTranscriptProps, ComposerPrimitiveIfProps, ComposerPrimitiveInputProps, ComposerPrimitiveQueueProps, ComposerPrimitiveQuoteDismissProps, ComposerPrimitiveQuoteProps, ComposerPrimitiveQuoteTextProps, ComposerPrimitiveRootProps, ComposerPrimitiveSendProps, ComposerPrimitiveStopDictationProps, ComposerPrimitiveUnstable_TriggerPopoverBackProps, ComposerPrimitiveUnstable_TriggerPopoverCategoriesProps, ComposerPrimitiveUnstable_TriggerPopoverCategoryItemProps, ComposerPrimitiveUnstable_TriggerPopoverItemProps, ComposerPrimitiveUnstable_TriggerPopoverItemsProps, ComposerPrimitiveUnstable_TriggerPopoverProps, ComposerPrimitiveUnstable_TriggerPopoverRootProps } from "@/generated/typeDocs";
|
|
7
|
-
import { ComposerPrimitive as ComposerPrimitiveDocs } from "@/generated/primitiveDocs";
|
|
8
|
-
|
|
9
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
10
|
-
{/* Do not edit manually. */}
|
|
11
|
-
|
|
12
|
-
For examples and usage patterns, see [Composer](/docs/primitives/composer).
|
|
13
|
-
|
|
14
|
-
{/* api-manual:start */}
|
|
15
|
-
## Anatomy
|
|
16
|
-
|
|
17
|
-
```tsx
|
|
18
|
-
import { ComposerPrimitive } from "@assistant-ui/react";
|
|
19
|
-
|
|
20
|
-
// creating a new message
|
|
21
|
-
const Composer = () => (
|
|
22
|
-
<ComposerPrimitive.Root>
|
|
23
|
-
<ComposerPrimitive.AttachmentDropzone>
|
|
24
|
-
<ComposerPrimitive.Quote>
|
|
25
|
-
<ComposerPrimitive.QuoteText />
|
|
26
|
-
<ComposerPrimitive.QuoteDismiss />
|
|
27
|
-
</ComposerPrimitive.Quote>
|
|
28
|
-
<ComposerPrimitive.Attachments />
|
|
29
|
-
<ComposerPrimitive.AddAttachment />
|
|
30
|
-
<ComposerPrimitive.Input />
|
|
31
|
-
<ComposerPrimitive.Send />
|
|
32
|
-
</ComposerPrimitive.AttachmentDropzone>
|
|
33
|
-
</ComposerPrimitive.Root>
|
|
34
|
-
);
|
|
35
|
-
|
|
36
|
-
// editing an existing message
|
|
37
|
-
const EditComposer = () => (
|
|
38
|
-
<ComposerPrimitive.Root>
|
|
39
|
-
<ComposerPrimitive.Input />
|
|
40
|
-
<ComposerPrimitive.Send />
|
|
41
|
-
<ComposerPrimitive.Cancel />
|
|
42
|
-
</ComposerPrimitive.Root>
|
|
43
|
-
);
|
|
44
|
-
|
|
45
|
-
// with voice input (dictation)
|
|
46
|
-
const ComposerWithDictation = () => (
|
|
47
|
-
<ComposerPrimitive.Root>
|
|
48
|
-
<ComposerPrimitive.Input />
|
|
49
|
-
<AuiIf condition={(s) => s.composer.dictation == null}>
|
|
50
|
-
<ComposerPrimitive.Dictate />
|
|
51
|
-
</AuiIf>
|
|
52
|
-
<AuiIf condition={(s) => s.composer.dictation != null}>
|
|
53
|
-
<ComposerPrimitive.StopDictation />
|
|
54
|
-
</AuiIf>
|
|
55
|
-
<ComposerPrimitive.Send />
|
|
56
|
-
</ComposerPrimitive.Root>
|
|
57
|
-
);
|
|
58
|
-
```
|
|
59
|
-
{/* api-manual:end */}
|
|
60
|
-
|
|
61
|
-
{/* api-reference:start */}
|
|
62
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
63
|
-
{/* Do not edit this block manually. */}
|
|
64
|
-
|
|
65
|
-
## API Reference
|
|
66
|
-
|
|
67
|
-
### Root
|
|
68
|
-
|
|
69
|
-
{ComposerPrimitiveDocs.Root?.deprecated && (
|
|
70
|
-
<Callout type="warn">
|
|
71
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Root.deprecated}
|
|
72
|
-
</Callout>
|
|
73
|
-
)}
|
|
74
|
-
|
|
75
|
-
{ComposerPrimitiveDocs.Root?.description}
|
|
76
|
-
|
|
77
|
-
{ComposerPrimitiveDocs.Root?.element && (
|
|
78
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
79
|
-
)}
|
|
80
|
-
|
|
81
|
-
```tsx
|
|
82
|
-
<ComposerPrimitive.Root>
|
|
83
|
-
<ComposerPrimitive.Input placeholder="Type your message..." />
|
|
84
|
-
<ComposerPrimitive.Send>Send</ComposerPrimitive.Send>
|
|
85
|
-
</ComposerPrimitive.Root>
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
<ParametersTable {...ComposerPrimitiveRootProps} />
|
|
89
|
-
|
|
90
|
-
### Input
|
|
91
|
-
|
|
92
|
-
{ComposerPrimitiveDocs.Input?.deprecated && (
|
|
93
|
-
<Callout type="warn">
|
|
94
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Input.deprecated}
|
|
95
|
-
</Callout>
|
|
96
|
-
)}
|
|
97
|
-
|
|
98
|
-
{ComposerPrimitiveDocs.Input?.description}
|
|
99
|
-
|
|
100
|
-
{ComposerPrimitiveDocs.Input?.element && (
|
|
101
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Input?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
102
|
-
)}
|
|
103
|
-
|
|
104
|
-
```tsx
|
|
105
|
-
// Ctrl/Cmd+Enter to submit (plain Enter inserts newline)
|
|
106
|
-
<ComposerPrimitive.Input
|
|
107
|
-
placeholder="Type your message..."
|
|
108
|
-
submitMode="ctrlEnter"
|
|
109
|
-
/>
|
|
110
|
-
|
|
111
|
-
// Insert a newline on Enter on touch-primary devices.
|
|
112
|
-
<ComposerPrimitive.Input
|
|
113
|
-
placeholder="Type your message..."
|
|
114
|
-
unstable_insertNewlineOnTouchEnter
|
|
115
|
-
/>
|
|
116
|
-
|
|
117
|
-
// Old API (deprecated, still supported)
|
|
118
|
-
<ComposerPrimitive.Input
|
|
119
|
-
placeholder="Type your message..."
|
|
120
|
-
submitOnEnter={true}
|
|
121
|
-
/>
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
<ParametersTable {...ComposerPrimitiveInputProps} />
|
|
125
|
-
|
|
126
|
-
{/* api-manual:ComposerPrimitive.Input:start */}
|
|
127
|
-
#### Keyboard Shortcuts
|
|
128
|
-
|
|
129
|
-
Default (`submitMode="enter"`):
|
|
130
|
-
|
|
131
|
-
| Key | Description |
|
|
132
|
-
| --- | --- |
|
|
133
|
-
| <Kbd>Enter</Kbd> | Sends the message. |
|
|
134
|
-
| <Kbd>Shift + Enter</Kbd> | Inserts a newline. |
|
|
135
|
-
| <Kbd>Escape</Kbd> | Sends a cancel action. |
|
|
136
|
-
|
|
137
|
-
With `submitMode="ctrlEnter"`:
|
|
138
|
-
|
|
139
|
-
| Key | Description |
|
|
140
|
-
| --- | --- |
|
|
141
|
-
| <Kbd>Ctrl/Cmd + Enter</Kbd> | Sends the message. |
|
|
142
|
-
| <Kbd>Enter</Kbd> | Inserts a newline. |
|
|
143
|
-
| <Kbd>Escape</Kbd> | Sends a cancel action. |
|
|
144
|
-
|
|
145
|
-
With `submitMode="none"`:
|
|
146
|
-
|
|
147
|
-
| Key | Description |
|
|
148
|
-
| --- | --- |
|
|
149
|
-
| <Kbd>Enter</Kbd> | Inserts a newline (no keyboard submission). |
|
|
150
|
-
| <Kbd>Escape</Kbd> | Sends a cancel action. |
|
|
151
|
-
|
|
152
|
-
#### Touch-primary devices
|
|
153
|
-
|
|
154
|
-
Pass `unstable_insertNewlineOnTouchEnter` to make plain Enter insert a newline on phones and tablets without a hardware keyboard, detected via the `(pointer: coarse) and (not (any-pointer: fine))` media query. Messages then dispatch only via the explicit Send button, matching the chat-input convention used by WhatsApp, Slack, Discord, iMessage, ChatGPT, and Claude.ai.
|
|
155
|
-
|
|
156
|
-
```tsx
|
|
157
|
-
<ComposerPrimitive.Input
|
|
158
|
-
placeholder="Ask anything..."
|
|
159
|
-
unstable_insertNewlineOnTouchEnter
|
|
160
|
-
/>
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
Only takes effect when `submitMode` resolves to `"enter"` (the default); `"ctrlEnter"` and `"none"` are unchanged, so a tablet paired with a hardware keyboard can still submit via Cmd/Ctrl+Enter.
|
|
164
|
-
{/* api-manual:ComposerPrimitive.Input:end */}
|
|
165
|
-
|
|
166
|
-
### Send
|
|
167
|
-
|
|
168
|
-
{ComposerPrimitiveDocs.Send?.deprecated && (
|
|
169
|
-
<Callout type="warn">
|
|
170
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Send.deprecated}
|
|
171
|
-
</Callout>
|
|
172
|
-
)}
|
|
173
|
-
|
|
174
|
-
{ComposerPrimitiveDocs.Send?.description}
|
|
175
|
-
|
|
176
|
-
{ComposerPrimitiveDocs.Send?.element && (
|
|
177
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Send?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
178
|
-
)}
|
|
179
|
-
|
|
180
|
-
```tsx
|
|
181
|
-
<ComposerPrimitive.Send>
|
|
182
|
-
Send Message
|
|
183
|
-
</ComposerPrimitive.Send>
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
<ParametersTable {...ComposerPrimitiveSendProps} />
|
|
187
|
-
|
|
188
|
-
### Cancel
|
|
189
|
-
|
|
190
|
-
{ComposerPrimitiveDocs.Cancel?.deprecated && (
|
|
191
|
-
<Callout type="warn">
|
|
192
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Cancel.deprecated}
|
|
193
|
-
</Callout>
|
|
194
|
-
)}
|
|
195
|
-
|
|
196
|
-
{ComposerPrimitiveDocs.Cancel?.description}
|
|
197
|
-
|
|
198
|
-
{ComposerPrimitiveDocs.Cancel?.element && (
|
|
199
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Cancel?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
200
|
-
)}
|
|
201
|
-
|
|
202
|
-
```tsx
|
|
203
|
-
<ComposerPrimitive.Cancel>
|
|
204
|
-
Cancel
|
|
205
|
-
</ComposerPrimitive.Cancel>
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
<ParametersTable {...ComposerPrimitiveCancelProps} />
|
|
209
|
-
|
|
210
|
-
### AddAttachment
|
|
211
|
-
|
|
212
|
-
{ComposerPrimitiveDocs.AddAttachment?.deprecated && (
|
|
213
|
-
<Callout type="warn">
|
|
214
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.AddAttachment.deprecated}
|
|
215
|
-
</Callout>
|
|
216
|
-
)}
|
|
217
|
-
|
|
218
|
-
{ComposerPrimitiveDocs.AddAttachment?.description}
|
|
219
|
-
|
|
220
|
-
{ComposerPrimitiveDocs.AddAttachment?.element && (
|
|
221
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.AddAttachment?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
222
|
-
)}
|
|
223
|
-
|
|
224
|
-
<ParametersTable {...ComposerPrimitiveAddAttachmentProps} />
|
|
225
|
-
|
|
226
|
-
### Attachments
|
|
227
|
-
|
|
228
|
-
{ComposerPrimitiveDocs.Attachments?.deprecated && (
|
|
229
|
-
<Callout type="warn">
|
|
230
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Attachments.deprecated}
|
|
231
|
-
</Callout>
|
|
232
|
-
)}
|
|
233
|
-
|
|
234
|
-
{ComposerPrimitiveDocs.Attachments?.description}
|
|
235
|
-
|
|
236
|
-
{ComposerPrimitiveDocs.Attachments?.element && (
|
|
237
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Attachments?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
238
|
-
)}
|
|
239
|
-
|
|
240
|
-
<ParametersTable {...ComposerPrimitiveAttachmentsProps} />
|
|
241
|
-
|
|
242
|
-
### AttachmentByIndex
|
|
243
|
-
|
|
244
|
-
{ComposerPrimitiveDocs.AttachmentByIndex?.deprecated && (
|
|
245
|
-
<Callout type="warn">
|
|
246
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.AttachmentByIndex.deprecated}
|
|
247
|
-
</Callout>
|
|
248
|
-
)}
|
|
249
|
-
|
|
250
|
-
{ComposerPrimitiveDocs.AttachmentByIndex?.description}
|
|
251
|
-
|
|
252
|
-
{ComposerPrimitiveDocs.AttachmentByIndex?.element && (
|
|
253
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.AttachmentByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
254
|
-
)}
|
|
255
|
-
|
|
256
|
-
<ParametersTable {...ComposerPrimitiveAttachmentByIndexProps} />
|
|
257
|
-
|
|
258
|
-
### AttachmentDropzone
|
|
259
|
-
|
|
260
|
-
{ComposerPrimitiveDocs.AttachmentDropzone?.deprecated && (
|
|
261
|
-
<Callout type="warn">
|
|
262
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.AttachmentDropzone.deprecated}
|
|
263
|
-
</Callout>
|
|
264
|
-
)}
|
|
265
|
-
|
|
266
|
-
{ComposerPrimitiveDocs.AttachmentDropzone?.description}
|
|
267
|
-
|
|
268
|
-
{ComposerPrimitiveDocs.AttachmentDropzone?.element && (
|
|
269
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.AttachmentDropzone?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
270
|
-
)}
|
|
271
|
-
|
|
272
|
-
<ParametersTable {...ComposerPrimitiveAttachmentDropzoneProps} />
|
|
273
|
-
|
|
274
|
-
{/* api-manual:ComposerPrimitive.AttachmentDropzone:start */}
|
|
275
|
-
| Data attribute | Values |
|
|
276
|
-
| --- | --- |
|
|
277
|
-
| `[data-dragging]` | Present while a file is being dragged over the dropzone. |
|
|
278
|
-
{/* api-manual:ComposerPrimitive.AttachmentDropzone:end */}
|
|
279
|
-
|
|
280
|
-
### Dictate
|
|
281
|
-
|
|
282
|
-
{ComposerPrimitiveDocs.Dictate?.deprecated && (
|
|
283
|
-
<Callout type="warn">
|
|
284
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Dictate.deprecated}
|
|
285
|
-
</Callout>
|
|
286
|
-
)}
|
|
287
|
-
|
|
288
|
-
{ComposerPrimitiveDocs.Dictate?.description}
|
|
289
|
-
|
|
290
|
-
{ComposerPrimitiveDocs.Dictate?.element && (
|
|
291
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Dictate?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
292
|
-
)}
|
|
293
|
-
|
|
294
|
-
```tsx
|
|
295
|
-
<ComposerPrimitive.Dictate>
|
|
296
|
-
<MicIcon />
|
|
297
|
-
</ComposerPrimitive.Dictate>
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
<ParametersTable {...ComposerPrimitiveDictateProps} />
|
|
301
|
-
|
|
302
|
-
### StopDictation
|
|
303
|
-
|
|
304
|
-
{ComposerPrimitiveDocs.StopDictation?.deprecated && (
|
|
305
|
-
<Callout type="warn">
|
|
306
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.StopDictation.deprecated}
|
|
307
|
-
</Callout>
|
|
308
|
-
)}
|
|
309
|
-
|
|
310
|
-
{ComposerPrimitiveDocs.StopDictation?.description}
|
|
311
|
-
|
|
312
|
-
{ComposerPrimitiveDocs.StopDictation?.element && (
|
|
313
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.StopDictation?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
314
|
-
)}
|
|
315
|
-
|
|
316
|
-
```tsx
|
|
317
|
-
<ComposerPrimitive.StopDictation>
|
|
318
|
-
<StopIcon />
|
|
319
|
-
</ComposerPrimitive.StopDictation>
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
<ParametersTable {...ComposerPrimitiveStopDictationProps} />
|
|
323
|
-
|
|
324
|
-
### DictationTranscript
|
|
325
|
-
|
|
326
|
-
{ComposerPrimitiveDocs.DictationTranscript?.deprecated && (
|
|
327
|
-
<Callout type="warn">
|
|
328
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.DictationTranscript.deprecated}
|
|
329
|
-
</Callout>
|
|
330
|
-
)}
|
|
331
|
-
|
|
332
|
-
{ComposerPrimitiveDocs.DictationTranscript?.description}
|
|
333
|
-
|
|
334
|
-
{ComposerPrimitiveDocs.DictationTranscript?.element && (
|
|
335
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.DictationTranscript?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
336
|
-
)}
|
|
337
|
-
|
|
338
|
-
```tsx
|
|
339
|
-
<AuiIf condition={(s) => s.composer.dictation != null}>
|
|
340
|
-
<div className="dictation-preview">
|
|
341
|
-
<ComposerPrimitive.DictationTranscript />
|
|
342
|
-
</div>
|
|
343
|
-
</AuiIf>
|
|
344
|
-
```
|
|
345
|
-
|
|
346
|
-
<ParametersTable {...ComposerPrimitiveDictationTranscriptProps} />
|
|
347
|
-
|
|
348
|
-
### If
|
|
349
|
-
|
|
350
|
-
{ComposerPrimitiveDocs.If?.deprecated && (
|
|
351
|
-
<Callout type="warn">
|
|
352
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.If.deprecated}
|
|
353
|
-
</Callout>
|
|
354
|
-
)}
|
|
355
|
-
|
|
356
|
-
{ComposerPrimitiveDocs.If?.description}
|
|
357
|
-
|
|
358
|
-
{ComposerPrimitiveDocs.If?.element && (
|
|
359
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.If?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
360
|
-
)}
|
|
361
|
-
|
|
362
|
-
<ParametersTable {...ComposerPrimitiveIfProps} />
|
|
363
|
-
|
|
364
|
-
### Quote
|
|
365
|
-
|
|
366
|
-
{ComposerPrimitiveDocs.Quote?.deprecated && (
|
|
367
|
-
<Callout type="warn">
|
|
368
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Quote.deprecated}
|
|
369
|
-
</Callout>
|
|
370
|
-
)}
|
|
371
|
-
|
|
372
|
-
{ComposerPrimitiveDocs.Quote?.description}
|
|
373
|
-
|
|
374
|
-
{ComposerPrimitiveDocs.Quote?.element && (
|
|
375
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Quote?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
376
|
-
)}
|
|
377
|
-
|
|
378
|
-
```tsx
|
|
379
|
-
<ComposerPrimitive.Quote>
|
|
380
|
-
<ComposerPrimitive.QuoteText />
|
|
381
|
-
<ComposerPrimitive.QuoteDismiss>×</ComposerPrimitive.QuoteDismiss>
|
|
382
|
-
</ComposerPrimitive.Quote>
|
|
383
|
-
```
|
|
384
|
-
|
|
385
|
-
<ParametersTable {...ComposerPrimitiveQuoteProps} />
|
|
386
|
-
|
|
387
|
-
### QuoteText
|
|
388
|
-
|
|
389
|
-
{ComposerPrimitiveDocs.QuoteText?.deprecated && (
|
|
390
|
-
<Callout type="warn">
|
|
391
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.QuoteText.deprecated}
|
|
392
|
-
</Callout>
|
|
393
|
-
)}
|
|
394
|
-
|
|
395
|
-
{ComposerPrimitiveDocs.QuoteText?.description}
|
|
396
|
-
|
|
397
|
-
{ComposerPrimitiveDocs.QuoteText?.element && (
|
|
398
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.QuoteText?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
399
|
-
)}
|
|
400
|
-
|
|
401
|
-
```tsx
|
|
402
|
-
<ComposerPrimitive.QuoteText />
|
|
403
|
-
```
|
|
404
|
-
|
|
405
|
-
<ParametersTable {...ComposerPrimitiveQuoteTextProps} />
|
|
406
|
-
|
|
407
|
-
### QuoteDismiss
|
|
408
|
-
|
|
409
|
-
{ComposerPrimitiveDocs.QuoteDismiss?.deprecated && (
|
|
410
|
-
<Callout type="warn">
|
|
411
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.QuoteDismiss.deprecated}
|
|
412
|
-
</Callout>
|
|
413
|
-
)}
|
|
414
|
-
|
|
415
|
-
{ComposerPrimitiveDocs.QuoteDismiss?.description}
|
|
416
|
-
|
|
417
|
-
{ComposerPrimitiveDocs.QuoteDismiss?.element && (
|
|
418
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.QuoteDismiss?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
419
|
-
)}
|
|
420
|
-
|
|
421
|
-
```tsx
|
|
422
|
-
<ComposerPrimitive.QuoteDismiss>×</ComposerPrimitive.QuoteDismiss>
|
|
423
|
-
```
|
|
424
|
-
|
|
425
|
-
<ParametersTable {...ComposerPrimitiveQuoteDismissProps} />
|
|
426
|
-
|
|
427
|
-
### Queue
|
|
428
|
-
|
|
429
|
-
{ComposerPrimitiveDocs.Queue?.deprecated && (
|
|
430
|
-
<Callout type="warn">
|
|
431
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Queue.deprecated}
|
|
432
|
-
</Callout>
|
|
433
|
-
)}
|
|
434
|
-
|
|
435
|
-
{ComposerPrimitiveDocs.Queue?.description}
|
|
436
|
-
|
|
437
|
-
{ComposerPrimitiveDocs.Queue?.element && (
|
|
438
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Queue?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
439
|
-
)}
|
|
440
|
-
|
|
441
|
-
```tsx
|
|
442
|
-
<ComposerPrimitive.Queue>
|
|
443
|
-
{({ queueItem }) => (
|
|
444
|
-
<div>
|
|
445
|
-
<QueueItemPrimitive.Text />
|
|
446
|
-
<QueueItemPrimitive.Steer>Run Now</QueueItemPrimitive.Steer>
|
|
447
|
-
</div>
|
|
448
|
-
)}
|
|
449
|
-
</ComposerPrimitive.Queue>
|
|
450
|
-
```
|
|
451
|
-
|
|
452
|
-
<ParametersTable {...ComposerPrimitiveQueueProps} />
|
|
453
|
-
|
|
454
|
-
### Unstable_TriggerPopover
|
|
455
|
-
|
|
456
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopover?.deprecated && (
|
|
457
|
-
<Callout type="warn">
|
|
458
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopover.deprecated}
|
|
459
|
-
</Callout>
|
|
460
|
-
)}
|
|
461
|
-
|
|
462
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopover?.description}
|
|
463
|
-
|
|
464
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopover?.element && (
|
|
465
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopover?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
466
|
-
)}
|
|
467
|
-
|
|
468
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverProps} />
|
|
469
|
-
|
|
470
|
-
{/* api-manual:ComposerPrimitive.Unstable_TriggerPopover:start */}
|
|
471
|
-
| Data attribute | Values |
|
|
472
|
-
| --- | --- |
|
|
473
|
-
| `[data-state]` | `"open"` when the trigger popover is open. |
|
|
474
|
-
{/* api-manual:ComposerPrimitive.Unstable_TriggerPopover:end */}
|
|
475
|
-
|
|
476
|
-
### Unstable_TriggerPopoverRoot
|
|
477
|
-
|
|
478
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverRoot?.deprecated && (
|
|
479
|
-
<Callout type="warn">
|
|
480
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopoverRoot.deprecated}
|
|
481
|
-
</Callout>
|
|
482
|
-
)}
|
|
483
|
-
|
|
484
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverRoot?.description}
|
|
485
|
-
|
|
486
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverRoot?.element && (
|
|
487
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopoverRoot?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
488
|
-
)}
|
|
489
|
-
|
|
490
|
-
```tsx
|
|
491
|
-
<ComposerPrimitive.Unstable_TriggerPopoverRoot>
|
|
492
|
-
<ComposerPrimitive.Unstable_TriggerPopover char="@" adapter={mentionAdapter}>
|
|
493
|
-
<ComposerPrimitive.Unstable_TriggerPopover.Directive formatter={formatter} />
|
|
494
|
-
...
|
|
495
|
-
</ComposerPrimitive.Unstable_TriggerPopover>
|
|
496
|
-
|
|
497
|
-
<ComposerPrimitive.Unstable_TriggerPopover char="/" adapter={slashAdapter}>
|
|
498
|
-
<ComposerPrimitive.Unstable_TriggerPopover.Action onExecute={handler} />
|
|
499
|
-
...
|
|
500
|
-
</ComposerPrimitive.Unstable_TriggerPopover>
|
|
501
|
-
|
|
502
|
-
<ComposerPrimitive.Root>
|
|
503
|
-
<ComposerPrimitive.Input />
|
|
504
|
-
</ComposerPrimitive.Root>
|
|
505
|
-
</ComposerPrimitive.Unstable_TriggerPopoverRoot>
|
|
506
|
-
```
|
|
507
|
-
|
|
508
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverRootProps} />
|
|
509
|
-
|
|
510
|
-
### Unstable_TriggerPopoverCategories
|
|
511
|
-
|
|
512
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverCategories?.deprecated && (
|
|
513
|
-
<Callout type="warn">
|
|
514
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopoverCategories.deprecated}
|
|
515
|
-
</Callout>
|
|
516
|
-
)}
|
|
517
|
-
|
|
518
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverCategories?.description}
|
|
519
|
-
|
|
520
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverCategories?.element && (
|
|
521
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopoverCategories?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
522
|
-
)}
|
|
523
|
-
|
|
524
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverCategoriesProps} />
|
|
525
|
-
|
|
526
|
-
### Unstable_TriggerPopoverCategoryItem
|
|
527
|
-
|
|
528
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverCategoryItem?.deprecated && (
|
|
529
|
-
<Callout type="warn">
|
|
530
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopoverCategoryItem.deprecated}
|
|
531
|
-
</Callout>
|
|
532
|
-
)}
|
|
533
|
-
|
|
534
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverCategoryItem?.description}
|
|
535
|
-
|
|
536
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverCategoryItem?.element && (
|
|
537
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopoverCategoryItem?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
538
|
-
)}
|
|
539
|
-
|
|
540
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverCategoryItemProps} />
|
|
541
|
-
|
|
542
|
-
{/* api-manual:ComposerPrimitive.Unstable_TriggerPopoverCategoryItem:start */}
|
|
543
|
-
| Data attribute | Values |
|
|
544
|
-
| --- | --- |
|
|
545
|
-
| `[data-highlighted]` | Present when keyboard-highlighted. |
|
|
546
|
-
{/* api-manual:ComposerPrimitive.Unstable_TriggerPopoverCategoryItem:end */}
|
|
547
|
-
|
|
548
|
-
### Unstable_TriggerPopoverItems
|
|
549
|
-
|
|
550
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverItems?.deprecated && (
|
|
551
|
-
<Callout type="warn">
|
|
552
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopoverItems.deprecated}
|
|
553
|
-
</Callout>
|
|
554
|
-
)}
|
|
555
|
-
|
|
556
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverItems?.description}
|
|
557
|
-
|
|
558
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverItems?.element && (
|
|
559
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopoverItems?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
560
|
-
)}
|
|
561
|
-
|
|
562
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverItemsProps} />
|
|
563
|
-
|
|
564
|
-
### Unstable_TriggerPopoverItem
|
|
565
|
-
|
|
566
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverItem?.deprecated && (
|
|
567
|
-
<Callout type="warn">
|
|
568
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopoverItem.deprecated}
|
|
569
|
-
</Callout>
|
|
570
|
-
)}
|
|
571
|
-
|
|
572
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverItem?.description}
|
|
573
|
-
|
|
574
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverItem?.element && (
|
|
575
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopoverItem?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
576
|
-
)}
|
|
577
|
-
|
|
578
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverItemProps} />
|
|
579
|
-
|
|
580
|
-
{/* api-manual:ComposerPrimitive.Unstable_TriggerPopoverItem:start */}
|
|
581
|
-
| Data attribute | Values |
|
|
582
|
-
| --- | --- |
|
|
583
|
-
| `[data-highlighted]` | Present when keyboard-highlighted. |
|
|
584
|
-
{/* api-manual:ComposerPrimitive.Unstable_TriggerPopoverItem:end */}
|
|
585
|
-
|
|
586
|
-
### Unstable_TriggerPopoverBack
|
|
587
|
-
|
|
588
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverBack?.deprecated && (
|
|
589
|
-
<Callout type="warn">
|
|
590
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerPopoverBack.deprecated}
|
|
591
|
-
</Callout>
|
|
592
|
-
)}
|
|
593
|
-
|
|
594
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverBack?.description}
|
|
595
|
-
|
|
596
|
-
{ComposerPrimitiveDocs.Unstable_TriggerPopoverBack?.element && (
|
|
597
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerPopoverBack?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
598
|
-
)}
|
|
599
|
-
|
|
600
|
-
<ParametersTable {...ComposerPrimitiveUnstable_TriggerPopoverBackProps} />
|
|
601
|
-
|
|
602
|
-
### Unstable_RegisteredTrigger
|
|
603
|
-
|
|
604
|
-
{ComposerPrimitiveDocs.Unstable_RegisteredTrigger?.deprecated && (
|
|
605
|
-
<Callout type="warn">
|
|
606
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_RegisteredTrigger.deprecated}
|
|
607
|
-
</Callout>
|
|
608
|
-
)}
|
|
609
|
-
|
|
610
|
-
{ComposerPrimitiveDocs.Unstable_RegisteredTrigger?.description}
|
|
611
|
-
|
|
612
|
-
{ComposerPrimitiveDocs.Unstable_RegisteredTrigger?.element && (
|
|
613
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_RegisteredTrigger?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
614
|
-
)}
|
|
615
|
-
|
|
616
|
-
{ComposerPrimitiveDocs.Unstable_RegisteredTrigger?.props && (
|
|
617
|
-
<ParametersTable type={ComposerPrimitiveDocs.Unstable_RegisteredTrigger?.element} parameters={ComposerPrimitiveDocs.Unstable_RegisteredTrigger.props} />
|
|
618
|
-
)}
|
|
619
|
-
|
|
620
|
-
### Unstable_TriggerMatcher
|
|
621
|
-
|
|
622
|
-
{ComposerPrimitiveDocs.Unstable_TriggerMatcher?.deprecated && (
|
|
623
|
-
<Callout type="warn">
|
|
624
|
-
<strong>Deprecated.</strong> {ComposerPrimitiveDocs.Unstable_TriggerMatcher.deprecated}
|
|
625
|
-
</Callout>
|
|
626
|
-
)}
|
|
627
|
-
|
|
628
|
-
{ComposerPrimitiveDocs.Unstable_TriggerMatcher?.description}
|
|
629
|
-
|
|
630
|
-
{ComposerPrimitiveDocs.Unstable_TriggerMatcher?.element && (
|
|
631
|
-
<p>This primitive renders a <code>{`<${ComposerPrimitiveDocs.Unstable_TriggerMatcher?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
632
|
-
)}
|
|
633
|
-
|
|
634
|
-
{ComposerPrimitiveDocs.Unstable_TriggerMatcher?.props && (
|
|
635
|
-
<ParametersTable type={ComposerPrimitiveDocs.Unstable_TriggerMatcher?.element} parameters={ComposerPrimitiveDocs.Unstable_TriggerMatcher.props} />
|
|
636
|
-
)}
|
|
637
|
-
{/* api-reference:end */}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Composition
|
|
3
|
-
description: How to compose primitives with custom components using asChild.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
{/* api-reference:skip-auto-generation */}
|
|
7
|
-
|
|
8
|
-
`assistant-ui` primitives are composable. This means that all props are forwarded, classes are merged, and event handlers are chained.
|
|
9
|
-
|
|
10
|
-
Most primitives come with a default HTML element (usually `div` or `button`). If you already have a custom component, you can use the `asChild` prop to replace it:
|
|
11
|
-
|
|
12
|
-
```tsx
|
|
13
|
-
// use the primitive's <button> element
|
|
14
|
-
<Composer.Send>Send</Composer.Send>;
|
|
15
|
-
|
|
16
|
-
// use your own <Button> component
|
|
17
|
-
<Composer.Send asChild>
|
|
18
|
-
<Button>Send</Button>
|
|
19
|
-
</Composer.Send>;
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
Learn more on [Radix's composition guide](https://www.radix-ui.com/primitives/docs/guides/composition).
|