zidane-ui/ session
import { … } from 'zidane-ui/session'ui/src/session/index.ts
Components#
ArtifactRowChipsComponent#
Renders an artifact row's lead, diff and facts as chips; nothing when there are none.
ArtifactsPanelComponent#
Renders a session's artifacts by kind, with a count summary under them.
DiffFactsComponent#
A change size: +added green, −removed red (a zero muted), then the files icon and count.
DiffFileTreeComponent#
The changed files as a tree of folder and file rows, each with its +/- counts.
InboxAttentionComponent#
Badges every session's Inbox tab with its pending requests and opens it for a live request in the active session.
PlanTrackerComponent#
Renders one plan with its step edits, retry, add box, tally, and the plan's stop, resume and drop.
ProjectHomeComponent#
Renders the project home.
ProviderUsageProviderComponent#
Runs the refresh cadence of the host's subscription usage for the components below.
QueueAttentionComponent#
Badges the Queue tab with the active session's queued messages; hidden at zero.
QueueTabComponent#
Renders a session's queue: the summary, the rows and their inline editor; an empty state without entries.
RecentPlansComponent#
The Inbox's "Recent" plans: one line each (title, how it ended, its tally), opened in place to read its steps.
RemindersPanelComponent#
Renders the reminders of a session, or all of them, with the create form.
RunningWorkDialogComponent#
Renders a session's running work with per-row and all-at-once cancel.
SecretsAttentionComponent#
Opens the Secrets tab (proactively) the first time the active session saves a secret, once per session. Reads the session's secrets itself, so the change signal reaches it while the panel is closed.
SecretsPanelComponent#
Renders a session project's saved secrets, with revoke, replace and add.
SessionCacheFactsComponent#
Renders the cache chips and the per-request rows; nothing before the first request.
SessionDetailsDialogComponent#
Renders a session's facts and actions.
SessionHeaderComponent#
Renders the folder chip, the title and the toolbar of the open session.
SessionProviderComponent#
Provides a SessionHost and optional label overrides to the session panels below it.
SessionShellComponent#
Renders a titled panel with a body and an optional footer, as a dialog named by its title.
SideChatComponent#
A side chat about parentId: its transcript, an empty state before the first send, and its composer.
Renders nothing without SessionHost.side.
TodoListViewComponent#
A todo list, read-only: one row per item with its status glyph.
TodoTallyComponent#
One chip per status (2 in progress, 3 done, 1 pending), zeros omitted, in the TUI's order and tones.
TurnDetailsDialogComponent#
Renders one turn's actions and preview.
UsagePanelComponent#
Renders the subscription windows of every signed-in provider and GitHub, with a Refresh.
WelcomeScreenComponent#
Renders the greeting and the usage card.
Functions#
badgeColorStyleFunction#
An exact icon color (#rgb / #rrggbb) as an inline style over the tone class; nothing for anything else.
badgeToneClassFunction#
The text color class for a tone; muted for none or an unknown one.
hasArtifactRowChipsFunction#
Whether the fields have anything to show.
isDoneTodoFunction#
Whether a todo is over (completed or cancelled): its text is struck through.
planStateToneFunction#
The tone of a plan's state chip.
todoGlyphToneFunction#
A status glyph's color class.
useAllSchedulesFunction#
Every reminder of the host (null until read, while off, or without a schedules host).
useInboxPlansFunction#
A session's plans for the Inbox: the one in progress and the recent ones. Reads the session from the host once.
useProviderUsageFunction#
The host's subscription usage: the model providers' windows, GitHub's limits, and a manual refresh. Outside a
ProviderUsageProvider nothing is fetched until refresh.
useSchedulesStatusFunction#
Whether reminders are on (null until read, or without a schedules host). The first read asks the host. Nothing
about reminders shows unless this is enabled.
useSessionArtifactsFunction#
A session's artifacts by kind (null until read, or without a session or an artifacts host). Re-renders only
when that session's artifacts change.
useSessionCacheReportFunction#
The session's cache report, read again when the session changes (updatedAt). null while loading, when there
is none, or without the host's details.cacheReport.
useSessionHostFunction#
Returns the SessionHost from the nearest SessionProvider. Throws when called outside one.
useSessionLabelsFunction#
Returns the session panels' strings: the defaults merged with any overrides given to SessionProvider or LabelsProvider.
useSessionPlansFunction#
A session's plans snapshot (null until read, or without a session or a plans host). Re-renders only when that
session's snapshot changes.
useSessionQueueFunction#
A session's queued messages, in delivery order (empty without a session or a queue host). Re-renders only when
that session's queue changes.
useSessionRunningWorkFunction#
A session's running work, live (empty without a session or a runningWork host). The first read of a session
seeds it from the host. Re-renders only when that session's work changes.
useSessionSchedulesFunction#
The reminders whose prompt goes to a session (null until read, while off, or without a session or a
schedules host). Re-renders only when that session's reminders change.
useSessionSecretsFunction#
A session project's saved secrets, by name (null until read, or without a session or a secrets host).
Re-renders only when that session's list changes.
useUsageSummaryFunction#
The summary to show for range, refreshed on mount and on every range change.
Constants#
BADGE_ICONSConstant#
Icon classes extension badges and references may name. Icons are UnoCSS classes generated at build time from literals in scanned source, so an icon an extension names exists only if it appears here (or anywhere else the app's Uno scans); one outside it paints nothing and the badge keeps its text.
renderSessionModalShellConstant#
A session dialog in the app's ModalShell, medium width.
renderWideSessionModalShellConstant#
For the session details: a facts grid and the cache table need the room.
TODO_ROW_CLASSConstant#
A flat todo row: no box of its own, the hover wash only.
Interfaces#
ArtifactOpenEventInterface#
The modifier keys of the click that opened a path.
ArtifactRowChipsFieldsInterface#
The fields of an artifact row's chips line.
ArtifactRowChipsPropsInterface#
Props for ArtifactRowChips.
ArtifactsPanelFocusInterface#
What a sidebar badge pointed the panel at: a kind's group, or one artifact.
ArtifactsPanelPropsInterface#
Props for ArtifactsPanel.
DiffFactsPropsInterface#
Props for DiffFacts.
DiffFileTreePropsInterface#
Props for DiffFileTree.
FindingCountsInterface#
Errors and warnings project tools reported on a file.
InboxAttentionPropsInterface#
Props for InboxAttention.
PanelAttentionPropsInterface#
Props shared by the attention drivers.
PlanTrackerPropsInterface#
Props for PlanTracker.
ProjectHomeProjectInterface#
The project a home is for.
ProjectHomePropsInterface#
Props for ProjectHome.
ProjectHomeRepoInterface#
A project's repository, as its header's chip shows it.
ProjectHomeSwitcherInterface#
The projects the name switches between: the composer's folder menu, opened from the name.
ProviderUsageInterface#
What useProviderUsage returns.
ProviderUsageProviderPropsInterface#
Props for ProviderUsageProvider.
QueueAttachmentRowPropsInterface#
What an attachments slot's row receives: the staged attachments and the editor's removal wiring.
QueueAttachmentsSlotInterface#
The app's attachment pieces for the queue editor: the staged tiles and their previews.
QueueTabPropsInterface#
Props for QueueTab.
RecentPlansPropsInterface#
Props for RecentPlans.
RemindersPanelPropsInterface#
Props for RemindersPanel.
RunningWorkDialogPropsInterface#
Props for RunningWorkDialog.
SecretsAttentionPropsInterface#
Props for SecretsAttention.
SecretsPanelPropsInterface#
Props for SecretsPanel.
SessionCacheFactsPropsInterface#
Props for SessionCacheFacts.
SessionDetailsDialogPropsInterface#
Props for SessionDetailsDialog.
SessionDetailsFactsInterface#
The facts the dialog shows, resolved by the app.
SessionDetailsSpaceInterface#
A space the session can move to.
SessionHeaderPropsInterface#
Props for SessionHeader.
SessionHeaderServerInterface#
The server a server session runs on.
SessionProviderPropsInterface#
Props for SessionProvider.
SessionShellPropsInterface#
What a shell receives: the dialog's title, description, content and footer, and how to close it.
SideChatPropsInterface#
Props for SideChat.
TodoListItemInterface#
One item of a TodoListView.
TodoListViewPropsInterface#
Props for TodoListView.
TodoTallyPropsInterface#
Props for TodoTally.
TurnDetailsDialogPropsInterface#
Props for TurnDetailsDialog.
UsagePanelPropsInterface#
Props for UsagePanel.
UsageSummaryViewInterface#
What useUsageSummary returns.
WelcomeScreenPropsInterface#
Props for WelcomeScreen.
Types#
AttentionActionsType#
The panel actions a driver calls.
ProjectHomeStartResultType#
What a block row's start answered: done, or why not in words.
RemindersScopeType#
Which reminders the panel lists.
RenderSessionShellType#
A dialog's renderShell: the app's modal shell, given the dialog's title, body and footer.
SessionDetailsStatusType#
A session's run state.
SessionFolderLocationType#
Where a session's folder is, when this computer's picker can't choose it.