packages/angular/API.md
This file is the exhaustive public-export contract for @copilotkit/angular.
Every symbol listed below is supported for application use unless it appears
under Internal extension points. Removing or incompatibly changing a public
symbol requires the package's normal breaking-change process.
For task-oriented examples, start with the package README and the
Angular documentation. The high-level
APIs most applications need are provideCopilotKit, CopilotChat,
CopilotPopup, CopilotSidebar, injectAgentStore, the register* helpers,
and the inject* controllers. The remaining components and context types are
supported customization primitives for replacing individual chat slots.
Import these symbols from @copilotkit/angular.
A2UIConfigA2UIDebugExposureA2UILifecycleContentA2UILifecycleStatusA2UIRecoveryOptionsAGUI_SEND_STATE_SNAPSHOT_TOOL_NAMEActivityRendererAgentStoreAngularActivityContentParseResultAngularActivityContentSchemaAngularToolCallAssistantMessageAssistantMessageCopyButtonContextAssistantMessageMarkdownRendererContextAssistantMessageToolbarContextAttachmentAttachmentModalityAttachmentUploadErrorAttachmentUploadResultAttachmentsConfigAudioRecorderErrorAudioRecorderStateBranchNavigationContextCOPILOT_CHAT_CONFIGURATIONCOPILOT_CHAT_CONFIGURATION_OPTIONSCOPILOT_CHAT_DEFAULT_LABELSCOPILOT_CHAT_LABELSCOPILOT_KIT_CONFIGChatStateClientToolConnectAgentContextConfigCopilotA2UIActivityRendererCopilotA2UIProgressCopilotA2UIRecoveryCopilotA2UIToolRendererCopilotChatCopilotChatAddFileButtonCopilotChatAssistantMessageCopilotChatAssistantMessageCopyButtonCopilotChatAssistantMessageOnReadAloudPropsCopilotChatAssistantMessageOnRegeneratePropsCopilotChatAssistantMessageOnThumbsDownPropsCopilotChatAssistantMessageOnThumbsUpPropsCopilotChatAssistantMessageReadAloudButtonCopilotChatAssistantMessageRegenerateButtonCopilotChatAssistantMessageRendererCopilotChatAssistantMessageThumbsDownButtonCopilotChatAssistantMessageThumbsUpButtonCopilotChatAssistantMessageToolbarCopilotChatAssistantMessageToolbarButtonCopilotChatAttachmentQueueCopilotChatAttachmentRendererCopilotChatAttachmentsDirectiveCopilotChatAudioRecorderCopilotChatAudioRecorderPropsCopilotChatButtonPropsCopilotChatCancelTranscribeButtonCopilotChatConfigurationCopilotChatConfigurationOptionsCopilotChatFinishTranscribeButtonCopilotChatInputCopilotChatInputConfigCopilotChatInputDefaultsCopilotChatInputModeCopilotChatInputOutputsCopilotChatInputSlotsCopilotChatLabelsCopilotChatMessageViewCopilotChatMessageViewCursorCopilotChatMessageViewPropsCopilotChatReasoningMessageCopilotChatSendButtonCopilotChatStartTranscribeButtonCopilotChatSuggestionPillCopilotChatSuggestionViewCopilotChatTextareaCopilotChatTextareaPropsCopilotChatToolCallsViewCopilotChatToolbarCopilotChatToolbarButtonCopilotChatToolbarButtonPropsCopilotChatToolbarPropsCopilotChatToolsButtonPropsCopilotChatToolsMenuCopilotChatUserMessageCopilotChatUserMessageBranchNavigationCopilotChatUserMessageCopyButtonCopilotChatUserMessageEditButtonCopilotChatUserMessageOnEditMessagePropsCopilotChatUserMessageOnSwitchToBranchPropsCopilotChatUserMessageRendererCopilotChatUserMessageToolbarCopilotChatUserMessageToolbarButtonCopilotChatViewCopilotChatViewDisclaimerCopilotChatViewFeatherCopilotChatViewHandlersCopilotChatViewInputContainerCopilotChatViewLayoutContextCopilotChatViewPropsCopilotChatViewScrollToBottomButtonCopilotChatViewScrollViewCopilotDefaultToolRendererCopilotKitCopilotKitAgentContextCopilotKitConfigCopilotOpenGenerativeUIActivityRendererCopilotOpenGenerativeUIRendererCopilotOpenGenerativeUIToolRendererCopilotPopupCopilotSidebarCopilotSidebarModeCopilotSidebarPositionCopilotSlotCopilotThreadsDrawerCopilotThreadsDrawerRowCopilotTooltipCopilotkitAgentFactoryCopilotkitThreadsFactoryCopyButtonContextCursorContextDEFAULT_OPEN_GENERATIVE_UI_DESIGN_SKILLDynamicSuggestionsConfigEditButtonContextFrontendToolConfigGENERATE_SANDBOXED_UI_DESCRIPTIONGENERATE_SANDBOXED_UI_TOOL_NAMEGenerateSandboxedUiArgsGenerateSandboxedUiArgsSchemaHumanInTheLoopConfigHumanInTheLoopToolCallHumanInTheLoopToolRendererInjectInterruptOptionsInjectThreadsInputInjectThreadsResultInterruptControllerInterruptEventInterruptExpiredErrorInterruptHandlerPropsInterruptRunOptionsInterruptRunnerInterruptViewMemoriesControllerMemoryMemoryChangesMemoryKindMemoryScopeMessageMessageRendererContextMessageViewContextNewMemoryOPEN_GENERATIVE_UI_ACTIVITY_TYPEOPEN_GENERATIVE_UI_WEBSANDBOX_LOADEROpenGenerativeUIConfigOpenGenerativeUIContentOpenGenerativeUIContentSchemaRENDER_A2UI_TOOL_NAMEReadAloudButtonContextRegenerateButtonContextRenderA2UIArgsRenderA2UIArgsSchemaRenderActivityMessageConfigRenderSlotOptionsRenderToolCallConfigRenderToolCallsResizeObserverServiceResizeStateSLOT_CONFIGSandboxFunctionScrollBehaviorScrollPositionScrollStateSendButtonContextSlotConfigSlotContextSlotRegistryEntrySlotValueStaticSuggestionsConfigStickToBottomSuggestionSuggestionsConfigThreadThreadsStoreThumbsDownButtonContextThumbsUpButtonContextToolCallHandlerToolRendererToolbarContextToolsMenuItemTooltipContentTranscriptionErrorTranscriptionErrorCodeTranscriptionErrorInfoTranscriptionResultUserMessageToolbarContextWithSlotsanyActivityContentSchemacnconnectAgentContextcreateSlotConfigcreateSlotRenderergetSlotConfiginjectAgentStoreinjectChatConfigurationinjectChatLabelsinjectChatStateinjectCopilotKitConfiginjectInterruptinjectMemoriesinjectThreadsisComponentTypeisSlotValuenormalizeSlotValueparseToolCallArgumentspickToolCallHandlerprovideCopilotChatConfigurationprovideCopilotChatLabelsprovideCopilotKitprovideSlotsreadA2UILifecycleContentregisterFrontendToolregisterHumanInTheLoopregisterRenderActivityMessageregisterRenderToolCallrenderSlotsafeToolValuetranscribeAudioThe following exported Angular DI token exists only so CopilotKit-maintained
secondary entry points can contribute built-in renderers. Applications must
not depend on it; its ɵ prefix and TSDoc mark it internal.
ɵCOPILOTKIT_BUILT_IN_ACTIVITY_RENDERERSImport these opt-in symbols from @copilotkit/angular/mcp-apps. This secondary
entry point keeps the MCP Apps sandbox and protocol code out of applications
that do not enable it. Prefer provideMCPApps; the remaining exports support
custom hosts, renderers, and protocol testing.
CopilotMCPAppsActivityRendererCopilotMCPAppsWidgetDEFAULT_MCP_APPS_CONFIGMCPAppsConfigMCPAppsHostInfoMCPAppsSnapshotContentMCP_APPS_CONFIGmcpAppsActivityRendererConfigmcpAppsSnapshotContentSchemaprovideMCPAppsThe MCP Apps renderer uses the same inline srcdoc proxy, sandbox permissions,
and resource-domain CSP as the React SDK.