Module reference
Every module of the package, by the subpath you import it from: @adecore/agents-react/<module>. A module name links to its source, where each export has its full type. DiffPool, EditDiff and UnifiedDiff are default exports. Two entries are not modules: theme.css, and the words under locales/<language>/<namespace>.json.
Many props and options are not exported types. Derive them where you need one, as ComponentProps<typeof Composer> or Parameters<ChatClient['open']>[1].
Runtime
| Module | Exports |
|---|---|
host | AccentChoice, ChatToast, ChatActions, FileRef, ChatPlace, SubagentTask, TimelineFindOptions, TimelineFind, ComposerDictationProps, TextareaProps, ResourceUrl, ComposerSlotProps, SubagentSlotProps, ThreadCard, ReplyAuthor, VisualHost, ChatHost, setChatHost, chatHost |
lazy | setLazyPrefetch, onLazyOpenError, lazyNamed |
locales | AGENTS_NAMESPACES, AgentsNamespace, AGENTS_LOCALES |
mounted-registry | MountedEntry, MountedRegistry |
port-transport | PortTransport, portTransport |
scope | ChatScope, ChatScopeContext, useChatScope |
state/chats | ChatState, ChatHistoryPage, ChatPage, ChatsById, ChatStatuses, ChatSink, prependPage, waitingRequestsOf, applyEvent, useChats, chatSink, useChatRow, useCurrentItem |
state/provider-accounts | ProviderAccountsRow, useProviderAccountsStore, useProviderAccounts, providerAccountsOf, knownAccounts, watchProviderAccounts |
state/providers | ProvidersRow, useProvidersStore, useProviders, providersOf, providerSinkFor |
state/usage | UsagePeriod, UsageMetric, USAGE_PERIODS, USAGE_PREFERENCES_KEY, usagePreferencesKey, dayOf, windowFor, summaryPayload, askedKey, reloadUsagePreferences, useUsageStore, UsageView, useUsage |
transport | ChatRequestMap, ChatEventMap, ChatTransportStatus, ChatTransport, ChatTransportError, errorCode, isConnectionError |
storage | ChatStorageRecord, ChatStorageAdapter, ChatStorageOptions, onChatStorageConfiguration, configureChatStorage, chatStorageKey, chatStorageLegacyKeys, chatStorageAdapter, hydrateChatStorage, createChatStore |
Chat
| Module | Exports |
|---|---|
chat/account-choice | AccountChoice, useAccountChoice |
chat/actions | transportActions, actionsOf, useChatActions |
chat/activity | backgroundCounts |
chat/attachments | isImageAttachment, fileBadge, formatBytes, checkAttachmentLimits, filesOf, readAttachments, readStoredAttachments, uploadPreviewUrl, uploadBytes |
chat/bookmarks | useBookmarkNaming, placeBookmark, nameBookmark, removeBookmark, goToBookmark |
chat/chat-client | ChatSendExtras, ChatClient |
chat/chat-references | ProjectChat, chatSuggestions |
chat/drafts | ChatDraft, EMPTY_DRAFT, isEmptyDraft, useDrafts, useHasDraft, readDraft, writeDraft, joinDraftText, takeBackIntoDraft, takeDraftOffers, offerDraft |
chat/forks | useForkedTurns, useForkIdsAfter |
chat/guards | PROMPT_MAX_CHARS, PROMPT_COUNTER_FROM, PASTE_ATTACHMENT_FROM_BYTES, pasteBecomesAttachment, pastedTextName, PromptGuard, promptGuard, usableSlashCommands |
chat/mentions | MENTION_DRAG_TYPE, LEGACY_MENTION_DRAG_TYPE, MENTION_DRAG_TYPES, carriesMentions, droppedMentions, writeMentionDrag, MentionQuery, ChipSegment, findMentionQuery, findSkillQuery, insertToken, dropQuery, insertMention, insertSkill, MentionSearch, NO_MENTION_SEARCH, MentionPick, mentionPick, presentMentions, presentSkills, chipText, pastedMentions, TextRange, ChipRange, chipRanges, tokenizeChips |
chat/persisted-json | PersistedJson, persistedJson |
chat/preferences | ChatPreferences, DEFAULT_CHAT_PREFERENCES, parseChatPreferences, defaultProvider, selectionFor, startingSelection, withSelection, accountFor, withAccount, chatPreferencesPayload, useChatPreferences, readChatPreferences, CHAT_PREFERENCES_KEY, chatPreferencesKey, reloadChatPreferences, rememberChatPreferences, rememberChatSelection, rememberChatAccount, forgetChatSelection |
chat/quote | quoteOf, withQuote |
chat/recent-messages | RecentChatMessage, RecentChatMessages, recentMessages, recentChatMessages, recentSubagentMessages |
chat/resume-compaction-dismissals | useResumeCompactionDismissal, dismissResumeCompaction |
chat/runtime-modes | RUNTIME_MODES, runtimeModeLabel, runtimeModeHint |
chat/stash | STASH_SHORTCUT, STASH_LIMIT, StashedAttachment, StashedPrompt, parseStash, withStashed, stashedFrom, useStash, stashDraft, forgetStashed |
chat/subagent-conversation | SUBAGENT_PAGE, SubagentConversationState, INITIAL_CONVERSATION, mergeNewest, SubagentConversation |
chat/subagent-list | subagentTitle, subagentFacts, taskIdOf, statusWordOf, TaskRowState, taskRowStateOf, flyoutSubagents, summaryWordOf, badgeCountOf, entryTimeOf, SubagentStop, stopOf, stopLabel, ComposerStop, composerStopOf, composerStopLabel |
chat/subagent-support | useSubagentSupport |
chat/subagent-view | SubagentStep, SubagentTrail, BreadcrumbStep, MAIN_AGENT, crumbOf, openFromMain, openBelow, trailTo, stepBack, composerWrites, breadcrumbOf, canOpenSubagent, subagentOf, openableSubagents, useSubagentView, useSubagentTrail, useOpenableSubagents, useSubagentItem |
chat/thumbnails | THUMBNAIL_PX, ThumbnailCrop, thumbnailCrop, useUploadThumbnail |
chat/timeline-flash | TimelineFlash, useTimelineFlash |
chat/timeline-scroll | registerTimeline, setTimelineAtEnd, subscribeTimelineEnd, timelineAtEnd, scrollTimelineToEnd, pageTimeline, registerMessageStepper, stepTimelineMessage, registerItemJumper, jumpToTimelineItem, TurnTarget, registerTurnJumper, jumpToTimelineTurn, wantsEarlier, ReadingAnchor, firstRowInView, restoreAnchor |
chat/visual-bridge | VisualFrameWindow, VisualBridgeOptions, VisualBridge |
chat/visuals | useVisualDialog |
Chat logic
| Module | Exports |
|---|---|
chat/logic/ansi | AnsiToken, stripAnsi, parseAnsi |
chat/logic/answers | toggleChoice |
chat/logic/bookmarks | bookmarkLabel, bookmarksInThreadOrder, bookmarkRows |
chat/logic/context-usage | CONTEXT_OPTION, ContextPart, CONTEXT_PARTS, ContextSegment, contextFraction, contextSegments, orderOptions |
chat/logic/fork | FORKABLE_PROVIDERS, ForkPoint, forkRefusal, summaryRefusal, forkIdsAfter, forkedTurnIds, lastSettledTurn, forkPointOf, forkPointLabel, turnIdOfRow, ForkShape, forkShapes, ForkWorktreeChoice, ForkCliChoice, forkPayload, branchRefusal |
chat/logic/handback | handbackReportOf |
chat/logic/json | isRecord |
chat/logic/limit | LimitView, limitView |
chat/logic/resume-compaction | RESUME_COMPACTION_TOKENS, RESUME_COMPACTION_IDLE_MS, ResumeCompactionOffer, resumeCompactionOffer |
chat/logic/scrubber | TickKind, ScrubberTick, SCRUBBER_MIN_TICKS, TICK_HEIGHT_PX, STRIP_WIDTH_PX, STRIP_INSET_PX, ticksOf, TickSlot, ScrubberLayout, layoutTicks, tickOfRow, ticksWithHits, messageAt, slotOf, tickWidth, ReadingPosition, MessageRange, messagesInView, slotInView, stepMessage, threadPaddingLeft |
chat/logic/thread-cards | TimedRow, cardRows, visualRows, withTimedRows, timedRowsOf, withThreadCards |
chat/logic/timeline-copy | stripMarkdown, messageTextOf, markdownOf |
chat/logic/timeline-target | TimelineTarget, EMPTY_TARGET, withCurrentText, readTimelineTarget |
chat/logic/timeline | SubagentBranch, TimelineRow, isBlock, summarizeGroup, summarizeTurn, agentTurnLabel, turnLabel, findSubagentBranch, deriveTimelineRows |
chat/logic/tool-catalog | ToolEntry, TOOL_CATALOG, toolEntry |
chat/logic/tools | FileChange, toolSummary, readImagePath, fileChanges, isFileChange, unifiedChanges, approvalChanges, hasFileChanges, toolStartedAt, liveOutput |
chat/logic/visual-height | clampVisualHeight, initialVisualHeight, rememberVisualHeight |
chat/logic/welcome | DayPart, dayPartOf |
chat/logic/workflow | WorkflowAgentState, WorkflowAgentView, WorkflowPhaseView, workflowAgentState, workflowPhases, workflowAgentTime |
Chat views
| Module | Exports |
|---|---|
chat/ui/AccountPill | AccountPill |
chat/ui/AnsiOutput | AnsiOutput |
chat/ui/BookmarkMarker | BookmarkMarker |
chat/ui/BookmarkSubmenu | BookmarkSubmenu |
chat/ui/ChatActivity | ChatActivity, StatusIcon |
chat/ui/ChatReferenceChip | ChatReferenceChip |
chat/ui/CodeBlock | CodeBlock |
chat/ui/Composer | Composer |
chat/ui/ComposerInput | ComposerInputHandle, InputSelection, ComposerInput |
chat/ui/DiffPool | DiffPool (default) |
chat/ui/EditDiff | EditDiff (default) |
chat/ui/FadingWords | FadingWords |
chat/ui/ImageView | ImageThumb |
chat/ui/LimitState | LimitDock, LimitPill |
chat/ui/Markdown | ReplyMarkdown, MessageMarkdown, Markdown |
chat/ui/MessageActions | MessageActions |
chat/ui/Pickers | ModelPicker, StashPicker |
chat/ui/PromptComposer | PromptComposer |
chat/ui/QuoteButton | QuoteButton |
chat/ui/ResumeCompactionDock | ResumeCompactionDock |
chat/ui/RunSettings | RunSettings |
chat/ui/Scrubber | CardChat, Scrubber |
chat/ui/SubagentControls | SubagentTitleCrumb, SubagentBreadcrumb |
chat/ui/SubagentInfo | SubagentInfo |
chat/ui/SubagentStopButton | SubagentStopButton |
chat/ui/SubagentTimeline | SubagentTimeline |
chat/ui/Timeline | Timeline |
chat/ui/TimelineMenu | TimelineMenuPopup, BookmarkMenuItems |
chat/ui/UnifiedDiff | UnifiedDiff (default) |
chat/ui/UploadThumb | UploadThumb |
chat/ui/VisualFrame | VisualFrameProps, VisualFrame |
chat/ui/VisualDialogs | VisualDialogs |
chat/ui/Welcome | WelcomeGreeting |
chat/ui/chips | MENTION_TONE, SKILL_TONE, CHIP_IN_EDITOR, CHIP_IN_MESSAGE |
chat/ui/code-lines | CodeToken, Tokenize, IncrementalLines |
chat/ui/code-streaming | CodeStreamingContext |
chat/ui/code-theme | useCodeTheme, shikiThemeOf |
chat/ui/diff-theme | useDiffTheme |
chat/ui/file-links | FileLinkContext, useFileLinkCwd, useFileLinkTarget, openFileLink |
chat/ui/find-reveal | ChatFindField, FindReveal, FindRevealContext, useOpenForFind |
chat/ui/full-diff | DiffContents, fullFileDiff |
chat/ui/icons | DOCK_ICON_SIZE, ROW_GUTTER, toolIcon |
chat/ui/markdown-blocks | MarkdownBlock, splitMarkdownBlocks, settledBlocksText |
chat/ui/quote-selection | QuoteTaker, QuoteTakerContext, selectedAnswerQuote |
chat/ui/rehype-chips | ChipOptions, rehypeChips |
chat/ui/rehype-fade | FADE_CLASS, WHOLE_FADE_CLASS, wordSegments, isWhitespace, rehypeFadeWords |
chat/ui/remark-html-as-text | remarkHtmlAsText |
chat/ui/reply-context | ReplyContext |
chat/ui/reveal | REVEAL_FADE_MS, REVEAL_TAU_MS, REVEAL_MIN_CPS, REVEAL_FINISH_MIN_CPS, REVEAL_MAX_FRAME_MS, REVEAL_MAX_HELD_WORD, advanceReveal, revealBoundary, RevealedText, useRevealedText |
chat/ui/useToggleSet | ToggleSet, useToggleSet |
chat/ui/visual-theme | VisualTokens, visualThemeOf, backgroundBehind, useVisualTheme |
Composer editor
| Module | Exports |
|---|---|
chat/ui/composer/chips | ChipChoices, chipDecorations |
chat/ui/composer/editor | externalChange, markdownLanguage, CodeRange, codeRanges, composerEditorExtensions |
chat/ui/composer/insert | insertAtSelection |
chat/ui/composer/keys | EnterAction, EnterKeys, ListItem, EnterContext, listItemAt, enterAction, inOpenFence, inFenceBody, tabSpaces, inCode, RecallContext, recallDirection |
Timeline rows
| Module | Exports |
|---|---|
chat/ui/rows/ForksRow | ForksRow |
chat/ui/rows/MessageRows | UserRow, ReportRow, ReplyHeader, AssistantRow, ThinkingRow, NoteRow, AgentTurnRow, CompactionRow, ApprovalHistoryRow, QuestionHistoryRow |
chat/ui/rows/Rows | RowProps, Row |
chat/ui/rows/SubagentRow | SubagentRow, SubagentBranchRow |
chat/ui/rows/TaskRow | TaskRow |
chat/ui/rows/VisualRow | VisualRow |
chat/ui/rows/WorkRows | ToggleLine, WorkRow, RunningFor, WorkLiveRow, WorkGroupRow, TurnFoldRow, ChangedFilesRow, WorkingRow |
chat/ui/rows/WorkflowRow | WorkflowRow |
chat/ui/rows/row-rhythm | FOLLOW_THRESHOLD_PX, rowRhythm, replyHeader |
Prompts
| Module | Exports |
|---|---|
prompts/logic/focus | focusPromptStart, focusPromptHeading |
prompts/logic/keys | PROMPT_SHORTCUTS, PromptKeyEvent, ListStep, ChoiceKeyAction, AnswerFieldKeyAction, stepIndex, choiceKey, answerFieldKey, headingKey, toolbarKey, isPrimaryKey, pageKey, staysInCard |
prompts/logic/prompts.fixtures | PROMPT_SAMPLES |
prompts/logic/prompts | PendingPrompt, PromptAction, PromptAnswer, PromptDraft, emptyPromptDraft, answerValue, questionAnswer, pickPromptChoice, isBlockingPrompt, orderPrompts, nextPrompt, promptAnswers |
prompts/logic/subjects | HostPrompt, PromptSubject, ChatPromptClients, PromptViewProps, ApprovalButtonSpec, promptIdOf, promptCreatedAt, isBlockingSubject, approvalButtons, answerPrompt |
prompts/logic/useFocusAfterAnswer | FocusAfterAnswer, useFocusAfterAnswer |
prompts/logic/usePromptSession | PromptSession, usePromptSession |
prompts/ui/ApprovalBody | CommandBox, ApprovalBody |
prompts/ui/PromptActions | PromptPrimary, ApprovalButton, ApprovalActions, QuestionActions |
prompts/ui/PromptCard | PROMPT_SURFACE, PromptCardKind, PromptCard |
prompts/ui/PromptView | PromptView |
prompts/ui/QuestionBody | QuestionBody |
Agents and providers
| Module | Exports |
|---|---|
agents/AccountDot | AccountDot |
agents/AgentIcon | AgentIcon |
agents/ModelOptionControl | ModelOptionControl |
agents/ProviderLogo | ProviderLogo |
agents/account-limits | limitsAccountId, limitsOfAccount, sessionWindow, continueTarget, hasUnreadAccount |
agents/accounts | accountColor, FOLDER_VARIABLES, AccountEntry, accountsOfKind, accountName, AccountTone, ACCOUNT_TONE_CLASSES, accountStatusLine, mintAccountId, freeAccountColor, offeredAccounts, hasAccountChoice, canContinueOn |
agents/model-name | modelNameFromSlug, modelName, AgentChip, agentChipOf, useModelName, sharedModelPrefix, shortModelName |
agents/model-options | optionValue, carryOptions |
agents/provider-paths | PROVIDER_PATHS |
agents/status-look | StatusWord, StatusLook, statusLookOf, TaskState, taskStatusWord |
providers/AccountColors | AccountColors |
providers/AccountDetail | AccountDetail |
providers/AccountVariables | AccountVariables |
providers/AddAccountForm | AddAccountForm |
providers/CliDetail | CliDetail |
providers/ProvidersPane | ProvidersPane |
providers/account-actions | saveAccounts, saveAccount, removeAccount, createAccount, linkAccount |
providers/parts | CliMark, CliTile |
providers/provider-abilities | providerAbilities |
providers/variables | VariableDraft, draftsOf, emptyDraft, variablesProblem, variablesOf, variablesChanged |
settings/sections | AgentsSettingsSection, PROVIDERS_SECTION, USAGE_SECTION, settingsSection |
ui/PlainTextarea | PlainTextarea |
Usage
| Module | Exports |
|---|---|
usage/LimitsList | WindowBar, LimitsList, AccountLimitsList |
usage/UsageBreakdown | UsageBreakdown |
usage/UsageChart | UsageChart |
usage/UsageDialog | UsageDialog |
usage/UsageLimits | UsageLimits |
usage/UsageLimitsCard | UsageLimitsCard |
usage/UsagePage | UsagePage |
usage/UsagePane | UsagePane |
usage/UsageSummary | UsageSummary |
usage/UsageTiles | UsageTiles |
usage/format | UsageCurrency, formatCount, moneyFormat, PROVIDER_LABELS, PROVIDER_COLORS, slotLabel, slotAxisLabel, formatDate, shortPath, formatClock, formatTokens |
usage/limit-groups | LimitAccount, LimitGroup, limitGroups, hasSeveralAccounts, isSignedOut, nextReset, checkedLabel, explain, accountNote |
usage/limits | useUsageLimits, useLimitGroups |
usage/money | useMoney |
usage/summary | ChartSlot, ProviderTotal, niceScale, DerivedUsage, enumerateSlots, labelEveryFor, deriveUsage, UsageDay, deriveDays |