@acryldev/plugin-context 0.0.0-stage → 0.1.1
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/LICENSE +21 -0
- package/README.md +12 -2
- package/docs/README.md +160 -0
- package/docs/delivery/local-live.md +113 -0
- package/docs/delivery/marketplace.md +16 -0
- package/docs/docs.json +2836 -0
- package/docs/extending/agent-preset.md +37 -0
- package/docs/extending/chat-command.md +28 -0
- package/docs/extending/client-slot.md +135 -0
- package/docs/extending/config-schema.md +7 -0
- package/docs/extending/cordis-core.md +63 -0
- package/docs/extending/desktop-app.md +53 -0
- package/docs/extending/desktop-main.md +25 -0
- package/docs/extending/event-hook.md +14 -0
- package/docs/extending/host-route.md +33 -0
- package/docs/extending/llm-adapter.md +38 -0
- package/docs/extending/packaging.md +53 -0
- package/docs/extending/prompt-contribution.md +9 -0
- package/docs/extending/service.md +13 -0
- package/docs/extending/skill-provider.md +9 -0
- package/docs/extending/state-and-persistence.md +71 -0
- package/docs/extending/three-role-capability.md +33 -0
- package/docs/extending/tool-plugin.md +24 -0
- package/docs/extending/tui-command.md +8 -0
- package/docs/extending/tui-components.md +61 -0
- package/docs/extending/ui-branding.md +43 -0
- package/docs/extending/ui-components.md +56 -0
- package/docs/extending/ui-customization.md +41 -0
- package/docs/extending/ui-library.md +66 -0
- package/docs/extending/ui-theme.md +55 -0
- package/docs/extending/workspace-tab.md +50 -0
- package/docs/maps/events.md +108 -0
- package/docs/maps/mount-points.md +154 -0
- package/docs/maps/slot-contracts.md +3376 -0
- package/docs/maps/taxonomy.md +306 -0
- package/docs/maps/theme-tokens.md +115 -0
- package/docs/maps/ui-components.md +26 -0
- package/docs/reference/cookbook/adding-a-package.md +174 -0
- package/docs/reference/cookbook/adding-a-remote-api.md +199 -0
- package/docs/reference/cookbook/adding-a-settings-card.md +74 -0
- package/docs/reference/cookbook/adding-a-tool.md +103 -0
- package/docs/reference/cookbook/adding-an-llm-adapter.md +45 -0
- package/docs/reference/cookbook/extension-cookbook.md +134 -0
- package/docs/reference/cordis-api/context.md +366 -0
- package/docs/reference/cordis-api/events.md +209 -0
- package/docs/reference/cordis-api/fiber.md +377 -0
- package/docs/reference/cordis-api/inherited.md +40 -0
- package/docs/reference/cordis-api/registry.md +154 -0
- package/docs/reference/cordis-api/service.md +104 -0
- package/docs/reference/cordis-guides/cordis-usage-cheatsheet.md +167 -0
- package/docs/reference/cordis-guides/cordis_system_guide_for_coding_agents.md +4666 -0
- package/docs/reference/cordis-guides/development-canvas-plugin.md +109 -0
- package/docs/reference/cordis-guides/hello-world-plugin-guide.md +517 -0
- package/docs/reference/harness/agent-lifecycle.md +93 -0
- package/docs/reference/harness/architecture.md +168 -0
- package/docs/reference/harness/capability-seams.md +675 -0
- package/docs/reference/harness/config-catalog.md +4523 -0
- package/docs/reference/harness/cordis-primer.md +47 -0
- package/docs/reference/harness/defensive-patterns.md +35 -0
- package/docs/reference/harness/event-producer-consumer.md +111 -0
- package/docs/reference/harness/glossary.md +47 -0
- package/docs/reference/harness/tool-catalog.md +2721 -0
- package/docs/reference/harness/tool-execution-pipeline.md +67 -0
- package/docs/reference/subsystems/README.md +75 -0
- package/docs/reference/subsystems/agent-team.md +233 -0
- package/docs/reference/subsystems/approval.md +172 -0
- package/docs/reference/subsystems/attachment.md +363 -0
- package/docs/reference/subsystems/boot.md +324 -0
- package/docs/reference/subsystems/browser-use.md +69 -0
- package/docs/reference/subsystems/client-modules.md +186 -0
- package/docs/reference/subsystems/client-resources.md +94 -0
- package/docs/reference/subsystems/commands.md +225 -0
- package/docs/reference/subsystems/compaction.md +286 -0
- package/docs/reference/subsystems/computer-use.md +58 -0
- package/docs/reference/subsystems/conversation.md +287 -0
- package/docs/reference/subsystems/core.md +1107 -0
- package/docs/reference/subsystems/credentials.md +497 -0
- package/docs/reference/subsystems/deliverables.md +180 -0
- package/docs/reference/subsystems/extensions.md +386 -0
- package/docs/reference/subsystems/feedback.md +402 -0
- package/docs/reference/subsystems/filesystem.md +532 -0
- package/docs/reference/subsystems/goal.md +315 -0
- package/docs/reference/subsystems/invariants.md +90 -0
- package/docs/reference/subsystems/jobs.md +501 -0
- package/docs/reference/subsystems/llm-streaming.md +1131 -0
- package/docs/reference/subsystems/lsp.md +204 -0
- package/docs/reference/subsystems/mcp.md +141 -0
- package/docs/reference/subsystems/office-to-pdf.md +89 -0
- package/docs/reference/subsystems/otel.md +46 -0
- package/docs/reference/subsystems/permission-presets.md +169 -0
- package/docs/reference/subsystems/persistence.md +418 -0
- package/docs/reference/subsystems/plan.md +89 -0
- package/docs/reference/subsystems/product-telemetry.md +81 -0
- package/docs/reference/subsystems/ptc-runtime.md +234 -0
- package/docs/reference/subsystems/sandbox.md +223 -0
- package/docs/reference/subsystems/schedule.md +545 -0
- package/docs/reference/subsystems/scope.md +61 -0
- package/docs/reference/subsystems/session-projection.md +358 -0
- package/docs/reference/subsystems/session-query.md +511 -0
- package/docs/reference/subsystems/session-reference.md +226 -0
- package/docs/reference/subsystems/session-telemetry.md +214 -0
- package/docs/reference/subsystems/session-title.md +206 -0
- package/docs/reference/subsystems/session.md +1300 -0
- package/docs/reference/subsystems/settings.md +157 -0
- package/docs/reference/subsystems/shell.md +316 -0
- package/docs/reference/subsystems/sidebar-right.md +160 -0
- package/docs/reference/subsystems/skills.md +354 -0
- package/docs/reference/subsystems/slots.md +201 -0
- package/docs/reference/subsystems/spill.md +126 -0
- package/docs/reference/subsystems/ssh.md +137 -0
- package/docs/reference/subsystems/storage.md +262 -0
- package/docs/reference/subsystems/subagent.md +762 -0
- package/docs/reference/subsystems/subprocess.md +323 -0
- package/docs/reference/subsystems/system-prompt.md +226 -0
- package/docs/reference/subsystems/terminal.md +186 -0
- package/docs/reference/subsystems/todo.md +34 -0
- package/docs/reference/subsystems/token-meter.md +108 -0
- package/docs/reference/subsystems/tools.md +749 -0
- package/docs/reference/subsystems/typert.md +489 -0
- package/docs/reference/subsystems/user-questions.md +309 -0
- package/docs/reference/subsystems/voice-input.md +166 -0
- package/docs/reference/subsystems/web-client.md +102 -0
- package/docs/reference/subsystems/web-server.md +228 -0
- package/docs/reference/subsystems/web.md +208 -0
- package/docs/reference/subsystems/webhook.md +72 -0
- package/docs/reference/subsystems/workflow.md +280 -0
- package/docs/reference/subsystems/workspace.md +661 -0
- package/docs/start-here/blueprints.md +33 -0
- package/docs/start-here/this-runtime.md +84 -0
- package/docs/start-here/troubleshooting.md +29 -0
- package/docs/start-here/trust-and-safety.md +39 -0
- package/docs/start-here/verify-before-done.md +46 -0
- package/example-plugins/README.md +45 -0
- package/example-plugins/packages/agent-preset-reviewer/agent.cordis.yml +18 -0
- package/example-plugins/packages/agent-preset-reviewer/preset.yml +3 -0
- package/example-plugins/packages/capability-swap-consumer/cordis.patch.yml +3 -0
- package/example-plugins/packages/capability-swap-consumer/index.js +14 -0
- package/example-plugins/packages/capability-swap-consumer/package.json +25 -0
- package/example-plugins/packages/capability-swap-provider-loud/cordis.patch.yml +3 -0
- package/example-plugins/packages/capability-swap-provider-loud/index.js +20 -0
- package/example-plugins/packages/capability-swap-provider-loud/package.json +25 -0
- package/example-plugins/packages/capability-swap-provider-quiet/cordis.patch.yml +3 -0
- package/example-plugins/packages/capability-swap-provider-quiet/index.js +20 -0
- package/example-plugins/packages/capability-swap-provider-quiet/package.json +25 -0
- package/example-plugins/packages/chat-command-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/chat-command-basic/index.js +26 -0
- package/example-plugins/packages/chat-command-basic/package.json +25 -0
- package/example-plugins/packages/client-chat-message-action/client.js +46 -0
- package/example-plugins/packages/client-chat-message-action/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-chat-message-action/index.js +9 -0
- package/example-plugins/packages/client-chat-message-action/package.json +31 -0
- package/example-plugins/packages/client-slot-header-action/client.js +57 -0
- package/example-plugins/packages/client-slot-header-action/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-slot-header-action/index.js +13 -0
- package/example-plugins/packages/client-slot-header-action/package.json +31 -0
- package/example-plugins/packages/client-slot-sidebar-tab/client.js +57 -0
- package/example-plugins/packages/client-slot-sidebar-tab/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-slot-sidebar-tab/index.js +9 -0
- package/example-plugins/packages/client-slot-sidebar-tab/package.json +32 -0
- package/example-plugins/packages/client-theme-override/client.js +52 -0
- package/example-plugins/packages/client-theme-override/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-theme-override/index.js +9 -0
- package/example-plugins/packages/client-theme-override/package.json +30 -0
- package/example-plugins/packages/client-tool-view/client.js +47 -0
- package/example-plugins/packages/client-tool-view/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-tool-view/index.js +24 -0
- package/example-plugins/packages/client-tool-view/package.json +34 -0
- package/example-plugins/packages/client-ui-components/client.js +77 -0
- package/example-plugins/packages/client-ui-components/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-ui-components/index.js +9 -0
- package/example-plugins/packages/client-ui-components/package.json +31 -0
- package/example-plugins/packages/client-ui-library/client.js +715 -0
- package/example-plugins/packages/client-ui-library/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-ui-library/index.js +9 -0
- package/example-plugins/packages/client-ui-library/package.json +37 -0
- package/example-plugins/packages/client-workspace-tab/client.js +72 -0
- package/example-plugins/packages/client-workspace-tab/cordis.patch.yml +3 -0
- package/example-plugins/packages/client-workspace-tab/index.js +9 -0
- package/example-plugins/packages/client-workspace-tab/package.json +30 -0
- package/example-plugins/packages/config-schema-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/config-schema-basic/index.js +19 -0
- package/example-plugins/packages/config-schema-basic/package.json +25 -0
- package/example-plugins/packages/desktop-main-profile-info/cordis.patch.yml +3 -0
- package/example-plugins/packages/desktop-main-profile-info/index.js +22 -0
- package/example-plugins/packages/desktop-main-profile-info/package.json +25 -0
- package/example-plugins/packages/event-hook-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/event-hook-basic/index.js +17 -0
- package/example-plugins/packages/event-hook-basic/package.json +22 -0
- package/example-plugins/packages/generated-capability-template/cordis.patch.yml +3 -0
- package/example-plugins/packages/generated-capability-template/index.js +16 -0
- package/example-plugins/packages/generated-capability-template/package.json +42 -0
- package/example-plugins/packages/host-route-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/host-route-basic/index.js +20 -0
- package/example-plugins/packages/host-route-basic/package.json +29 -0
- package/example-plugins/packages/lifecycle-function-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/lifecycle-function-basic/index.js +12 -0
- package/example-plugins/packages/lifecycle-function-basic/package.json +15 -0
- package/example-plugins/packages/lifecycle-function-hot-shim/cordis.patch.yml +3 -0
- package/example-plugins/packages/lifecycle-function-hot-shim/impl.js +5 -0
- package/example-plugins/packages/lifecycle-function-hot-shim/index.js +18 -0
- package/example-plugins/packages/lifecycle-function-hot-shim/package.json +23 -0
- package/example-plugins/packages/lifecycle-hooks-observer/cordis.patch.yml +3 -0
- package/example-plugins/packages/lifecycle-hooks-observer/index.js +23 -0
- package/example-plugins/packages/lifecycle-hooks-observer/package.json +22 -0
- package/example-plugins/packages/llm-adapter-echo/cordis.patch.yml +3 -0
- package/example-plugins/packages/llm-adapter-echo/index.js +42 -0
- package/example-plugins/packages/llm-adapter-echo/package.json +25 -0
- package/example-plugins/packages/prompt-assemble-hook/cordis.patch.yml +3 -0
- package/example-plugins/packages/prompt-assemble-hook/index.js +22 -0
- package/example-plugins/packages/prompt-assemble-hook/package.json +22 -0
- package/example-plugins/packages/prompt-contribution-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/prompt-contribution-basic/index.js +18 -0
- package/example-plugins/packages/prompt-contribution-basic/package.json +22 -0
- package/example-plugins/packages/service-consumer-greeter/cordis.patch.yml +3 -0
- package/example-plugins/packages/service-consumer-greeter/index.js +14 -0
- package/example-plugins/packages/service-consumer-greeter/package.json +22 -0
- package/example-plugins/packages/service-provider-greeter/cordis.patch.yml +3 -0
- package/example-plugins/packages/service-provider-greeter/index.js +22 -0
- package/example-plugins/packages/service-provider-greeter/package.json +25 -0
- package/example-plugins/packages/settings-section-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/settings-section-basic/index.js +34 -0
- package/example-plugins/packages/settings-section-basic/package.json +26 -0
- package/example-plugins/packages/skill-provider-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/skill-provider-basic/index.js +31 -0
- package/example-plugins/packages/skill-provider-basic/package.json +22 -0
- package/example-plugins/packages/state-host-store/client.js +57 -0
- package/example-plugins/packages/state-host-store/cordis.patch.yml +3 -0
- package/example-plugins/packages/state-host-store/index.js +90 -0
- package/example-plugins/packages/state-host-store/package.json +31 -0
- package/example-plugins/packages/state-workspace-file/cordis.patch.yml +3 -0
- package/example-plugins/packages/state-workspace-file/index.js +52 -0
- package/example-plugins/packages/state-workspace-file/package.json +25 -0
- package/example-plugins/packages/tool-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/tool-basic/index.js +25 -0
- package/example-plugins/packages/tool-basic/package.json +25 -0
- package/example-plugins/packages/tool-policy-hook/cordis.patch.yml +3 -0
- package/example-plugins/packages/tool-policy-hook/index.js +28 -0
- package/example-plugins/packages/tool-policy-hook/package.json +25 -0
- package/example-plugins/packages/tui-command-basic/cordis.patch.yml +3 -0
- package/example-plugins/packages/tui-command-basic/index.js +24 -0
- package/example-plugins/packages/tui-command-basic/package.json +22 -0
- package/example-plugins/packages/tui-overlay-themed/cordis.patch.yml +3 -0
- package/example-plugins/packages/tui-overlay-themed/index.js +65 -0
- package/example-plugins/packages/tui-overlay-themed/package.json +25 -0
- package/example-plugins/packages/tui-ui-library/cordis.patch.yml +3 -0
- package/example-plugins/packages/tui-ui-library/index.js +73 -0
- package/example-plugins/packages/tui-ui-library/package.json +29 -0
- package/example-plugins/packages/web-page-branding/cordis.patch.yml +3 -0
- package/example-plugins/packages/web-page-branding/index.js +31 -0
- package/example-plugins/packages/web-page-branding/package.json +22 -0
- package/example-plugins/scenarios.json +11 -0
- package/index.js +384 -0
- package/lib/blend-apply.js +107 -0
- package/lib/blend-capture.js +249 -0
- package/lib/blend-ledger.js +76 -0
- package/lib/contract.js +5 -0
- package/lib/install.js +516 -0
- package/lib/lookup.js +67 -0
- package/lib/manifest.js +56 -0
- package/lib/pack-root.js +22 -0
- package/lib/provenance.js +110 -0
- package/lib/publish.js +64 -0
- package/lib/reconcile.js +83 -0
- package/lib/router.js +55 -0
- package/lib/scopes.js +82 -0
- package/lib/skills.js +54 -0
- package/lib/stage.js +157 -0
- package/lib/verify.js +77 -0
- package/package.json +58 -3
- package/scripts/lib/indexes.mjs +45 -0
- package/scripts/lib/manifest.mjs +127 -0
- package/scripts/lib/maps.mjs +482 -0
- package/skills/acryl-add-provider-or-capability/SKILL.md +12 -0
- package/skills/acryl-add-ui/SKILL.md +18 -0
- package/skills/acryl-build-plugin/SKILL.md +21 -0
- package/skills/acryl-change-plugin/SKILL.md +16 -0
- package/skills/acryl-desktop-shell/SKILL.md +12 -0
- package/skills/acryl-diagnose-plugin/SKILL.md +10 -0
- package/skills/acryl-fix-plugin/SKILL.md +12 -0
- package/skills/acryl-improve-ui/SKILL.md +10 -0
- package/skills/acryl-remove-plugin/SKILL.md +11 -0
- package/skills/acryl-restyle-ui/SKILL.md +14 -0
- package/skills/acryl-share-plugin/SKILL.md +23 -0
- package/skills/acryl-tui-ui/SKILL.md +12 -0
|
@@ -0,0 +1,3376 @@
|
|
|
1
|
+
# Slot contracts: what each client slot needs, receives and already holds
|
|
2
|
+
|
|
3
|
+
<!-- Generated by scripts/sync-corpus.mjs from deepseek-harness/packages/extensions/cordis-client-runner/src/client/slot-catalog.ts (the harness's own catalog, which it also serves to the model as `cordis_inspect what:"client"`). Do not edit. -->
|
|
4
|
+
|
|
5
|
+
Use this with `maps/mount-points.md` when you fill a slot that needs more than `{ name, id, order }`. For each slot: the register options, the exact props
|
|
6
|
+
your component receives, the keys already taken, and a worked example. The harness notes below were written for packages defined from a running page
|
|
7
|
+
(`cordis_define`), where nothing can be imported; an installed plugin with `dsh.client` CAN `require` the shared components (`extending/ui-components.md`).
|
|
8
|
+
The `priority` rule and the "declare `inject: ['slots']`" rule apply to both.
|
|
9
|
+
|
|
10
|
+
## Harness notes
|
|
11
|
+
|
|
12
|
+
- Contribute UI only through `ctx.slots.register(options, Component)`; declare `inject: ['slots']` in your returned plugin (object form) or the seat is withheld.
|
|
13
|
+
- Wrap every registration in `ctx.slots.inject(key, () => ctx.slots.register(...))`. A slot exists only while the entry that declared it is mounted, and registering into an undeclared slot throws; `inject` runs your registration when the declaration is (or becomes) live and re-runs it if the owner remounts.
|
|
14
|
+
- Do NOT pass `priority`: the browser-half facade assigns one automatically, and it is LOWER than every shipped entry - in a single or keyed cell that means your entry is the one that renders.
|
|
15
|
+
- You cannot `import` anything, so the design-system components are out of reach: build markup with `React.createElement` and ship CSS through `styles.insert(css)`. Use the theme CSS variables (`var(--dsw-alias-bg-layer-1)`, `var(--dsw-alias-label-primary)`, …) instead of literal colors, or your contribution breaks in the other color scheme.
|
|
16
|
+
- Every component receives the framework hook seats listed under `framework props` for its scope; a selector hook is called with a selector, e.g. `useSessions(state => state.current)`.
|
|
17
|
+
- This catalog is the COMPILE-TIME contract of the shipped web bundle, not a snapshot of one page: a key is registrable only where the owner that declares it is mounted. A failed registration surfaces in the browser-half load report - read it back with `cordis_inspect what:"temporary"`.
|
|
18
|
+
|
|
19
|
+
## The 90 slots
|
|
20
|
+
|
|
21
|
+
### `conversation.approval.detail`
|
|
22
|
+
|
|
23
|
+
Kind `single`, scope `session`. Optional detail for the Tool call correlated with an approval request.
|
|
24
|
+
|
|
25
|
+
Props your component receives:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
/** Stable identity handed to an optional approval-detail renderer. */
|
|
29
|
+
export interface ApprovalDetailOwnerProps {
|
|
30
|
+
/** Tool call correlated with the request. */
|
|
31
|
+
callId: ToolCallId
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Already occupied by: client-ui-chat ApprovalCommand. Replace risk: `shadows-shipped-ui`.
|
|
36
|
+
|
|
37
|
+
Example:
|
|
38
|
+
|
|
39
|
+
```js
|
|
40
|
+
return {
|
|
41
|
+
inject: ['slots'],
|
|
42
|
+
apply(ctx) {
|
|
43
|
+
ctx.slots.inject('conversation.approval.detail', () => ctx.slots.register(
|
|
44
|
+
{ name: 'conversation.approval.detail' },
|
|
45
|
+
() => React.createElement('div', null, 'hello'),
|
|
46
|
+
))
|
|
47
|
+
},
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### `conversation.chat.assistant-actions`
|
|
52
|
+
|
|
53
|
+
Kind `list`, scope `session`. Ordered actions for one finalized assistant message.
|
|
54
|
+
|
|
55
|
+
Ordered actions for one finalized assistant message. Each entry receives
|
|
56
|
+
the durable message id; a fresh `id` adds an action and reusing one replaces
|
|
57
|
+
that entry. With no entries, the standard action row remains unchanged.
|
|
58
|
+
|
|
59
|
+
Register options:
|
|
60
|
+
|
|
61
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
62
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
63
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
64
|
+
|
|
65
|
+
Props your component receives:
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
/** Owner currency of finalized-assistant actions. */
|
|
69
|
+
export interface AssistantActionOwnerProps {
|
|
70
|
+
messageId: MessageId
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Already occupied by: client-ui-message-feedback MessageFeedbackActions id 'feedback'. Replace risk: `none`.
|
|
75
|
+
|
|
76
|
+
Example:
|
|
77
|
+
|
|
78
|
+
```js
|
|
79
|
+
return {
|
|
80
|
+
inject: ['slots'],
|
|
81
|
+
apply(ctx) {
|
|
82
|
+
ctx.slots.inject('conversation.chat.assistant-actions', () => ctx.slots.register(
|
|
83
|
+
{ name: 'conversation.chat.assistant-actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
84
|
+
() => React.createElement('div', null, 'hello'),
|
|
85
|
+
))
|
|
86
|
+
},
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### `conversation.chat.commandview`
|
|
91
|
+
|
|
92
|
+
Kind `keyed`, scope `session`. Command row keyed by the command name.
|
|
93
|
+
|
|
94
|
+
Command row keyed by the command name. The component receives the folded
|
|
95
|
+
command lifecycle and linked compaction when present. Reusing a key
|
|
96
|
+
replaces that command renderer; an unoccupied key uses the generic card.
|
|
97
|
+
|
|
98
|
+
Register options:
|
|
99
|
+
|
|
100
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
101
|
+
|
|
102
|
+
Props your component receives:
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
/** Command-row owner share. */
|
|
106
|
+
export interface CommandRowOwnerProps {
|
|
107
|
+
node: CommandNode
|
|
108
|
+
compaction?: CompactionSummaryNode
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
113
|
+
|
|
114
|
+
Example:
|
|
115
|
+
|
|
116
|
+
```js
|
|
117
|
+
return {
|
|
118
|
+
inject: ['slots'],
|
|
119
|
+
apply(ctx) {
|
|
120
|
+
ctx.slots.inject('conversation.chat.commandview', () => ctx.slots.register(
|
|
121
|
+
{ name: 'conversation.chat.commandview', key: '<one key the owner dispatches>' },
|
|
122
|
+
() => React.createElement('div', null, 'hello'),
|
|
123
|
+
))
|
|
124
|
+
},
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### `conversation.chat.node`
|
|
129
|
+
|
|
130
|
+
Kind `keyed`, scope `session`. Final Chat node renderer, keyed by `ChatNodeKind`.
|
|
131
|
+
|
|
132
|
+
Final Chat node renderer, keyed by `ChatNodeKind`. The component receives
|
|
133
|
+
the typed node, shared Chat actions, and Turn-data hook. Reusing a key
|
|
134
|
+
replaces that node renderer; a kind with no occupant renders no row.
|
|
135
|
+
|
|
136
|
+
Register options:
|
|
137
|
+
|
|
138
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
139
|
+
|
|
140
|
+
Props your component receives:
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
/** Stable owner currency delivered to a keyed Chat renderer. */
|
|
144
|
+
export interface ChatNodeOwnerProps {
|
|
145
|
+
/** Renderer-owned Node portion selected by the grouping Definition. */
|
|
146
|
+
groupPart?: string
|
|
147
|
+
cwd?: string | undefined
|
|
148
|
+
/** Open the current source file of a skill referenced by a sent message. */
|
|
149
|
+
openSkill: (name: string) => void
|
|
150
|
+
openFile: (path: string, options?: OpenFileOptions) => void
|
|
151
|
+
inspectCall: ((callId: ToolCallId) => void) | undefined
|
|
152
|
+
forkAt: (seq: number) => void
|
|
153
|
+
/**
|
|
154
|
+
* Session-authorized image loader, down-threaded from the Chat view so a
|
|
155
|
+
* chat-node renderer can render the attachment presentation slot directly
|
|
156
|
+
* with only the durable references plus this loader, instead of receiving a
|
|
157
|
+
* rendering closure.
|
|
158
|
+
*/
|
|
159
|
+
loadImage: MessageImageLoader
|
|
160
|
+
renderMessageImages: RenderMessageImages
|
|
161
|
+
fileMentions: (owner: TurnTailOwnerProps) => MarkdownFileMentions | undefined
|
|
162
|
+
/** Turn-process state when this Node belongs to a projected Turn. */
|
|
163
|
+
turnProcess?: TurnProcessOwnerProps | undefined
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
Keys: fixed by the owner's key table { [Kind in ChatNodeKind]: { node: ChatNode<Kind> } }, already taken: assistant-step, command, command-input, compaction, context, manual-compaction, model-retry, question-reply, steering, system-prompt, tool-call, turn-error, turn-max-tokens, turn-process, turn-tail, turn-trigger, unknown, user, workflow-run
|
|
168
|
+
|
|
169
|
+
Already occupied by: client-ui-chat UserMessageNodeView key 'user'; client-ui-chat UserMessageNodeView key 'steering'; client-ui-chat ContextMessageNodeView key 'context'; client-ui-chat TurnTriggerNodeView key 'turn-trigger'; client-ui-chat SystemPromptNodeView key 'system-prompt'; client-ui-chat AssistantNodeView key 'assistant-step'; client-ui-chat CommandNodeView key 'command'; client-ui-chat ManualCompactionNodeView key 'manual-compaction'; client-ui-chat CompactionNodeView key 'compaction'; client-ui-chat RetryNodeView key 'model-retry'; client-ui-chat TurnErrorNodeView key 'turn-error'; client-ui-chat TurnMaxTokensNodeView key 'turn-max-tokens'; client-ui-chat TurnProcessNodeView key 'turn-process'; client-ui-chat TurnTailNodeView key 'turn-tail'; client-ui-chat UnknownNodeView key 'unknown'; client-ui-goal GoalCommandInputView key 'command-input'; client-ui-tool ToolCallTree key 'tool-call'; client-ui-user-questions QuestionReplyView key 'question-reply'; client-ui-workflow-run WorkflowRunPanel key 'workflow-run'. Replace risk: `shadows-shipped-ui`.
|
|
170
|
+
|
|
171
|
+
Example:
|
|
172
|
+
|
|
173
|
+
```js
|
|
174
|
+
return {
|
|
175
|
+
inject: ['slots'],
|
|
176
|
+
apply(ctx) {
|
|
177
|
+
ctx.slots.inject('conversation.chat.node', () => ctx.slots.register(
|
|
178
|
+
{ name: 'conversation.chat.node', key: '<one key the owner dispatches>' },
|
|
179
|
+
() => React.createElement('div', null, 'hello'),
|
|
180
|
+
))
|
|
181
|
+
},
|
|
182
|
+
}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### `conversation.chat.turnTail`
|
|
186
|
+
|
|
187
|
+
Kind `list`, scope `session`. Ordered feature contributions before a completed Turn's action row.
|
|
188
|
+
|
|
189
|
+
Ordered feature contributions before a completed Turn's action row. Each
|
|
190
|
+
entry receives the Turn, closing sequence, and file opener. A fresh `id`
|
|
191
|
+
adds an entry; entries without content return null.
|
|
192
|
+
|
|
193
|
+
Register options:
|
|
194
|
+
|
|
195
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
196
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
197
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
198
|
+
|
|
199
|
+
Props your component receives:
|
|
200
|
+
|
|
201
|
+
```ts
|
|
202
|
+
/** Owner currency of the completed-Turn extension chain. */
|
|
203
|
+
export interface TurnTailOwnerProps {
|
|
204
|
+
turn: TurnLocation
|
|
205
|
+
seq: number
|
|
206
|
+
openFile: (path: string) => void
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
Already occupied by: client-ui-deliverables DeliverablesTail id '@deepseek-ai/dsh-client-ui-deliverables'; client-ui-plan PlanCards; client-ui-schedule ScheduleTurnCard id 'schedule-created'. Replace risk: `none`.
|
|
211
|
+
|
|
212
|
+
Example:
|
|
213
|
+
|
|
214
|
+
```js
|
|
215
|
+
return {
|
|
216
|
+
inject: ['slots'],
|
|
217
|
+
apply(ctx) {
|
|
218
|
+
ctx.slots.inject('conversation.chat.turnTail', () => ctx.slots.register(
|
|
219
|
+
{ name: 'conversation.chat.turnTail', id: 'my-entry', order: 100, label: 'My entry' },
|
|
220
|
+
() => React.createElement('div', null, 'hello'),
|
|
221
|
+
))
|
|
222
|
+
},
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### `conversation.composer`
|
|
227
|
+
|
|
228
|
+
Kind `chain`, scope `session`. Selector-routed replacements for the current Session's resident composer.
|
|
229
|
+
|
|
230
|
+
Register options:
|
|
231
|
+
|
|
232
|
+
- `select` (required, `(owner) => unknown \| null`): Pure routing selector. Entries are tried in ascending order; the first non-null result wins and arrives as the component's `matched` prop. All-null falls through to the owner's fallback.
|
|
233
|
+
|
|
234
|
+
Props your component receives:
|
|
235
|
+
|
|
236
|
+
```ts
|
|
237
|
+
/** Owner values used to elect a composer takeover. */
|
|
238
|
+
export interface ComposerChainProps {
|
|
239
|
+
/** Current Session identity used by temporary business-owned entries. */
|
|
240
|
+
sessionId: SessionId | undefined
|
|
241
|
+
/** Current Session lifecycle state, absent without a selected Session. */
|
|
242
|
+
session: SessionSnapshot | undefined
|
|
243
|
+
/** Effective business-owned interaction awaiting the user in this Session. */
|
|
244
|
+
pendingInteraction: SessionPendingInteraction | undefined
|
|
245
|
+
}
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Already occupied by: client-ui-approval ApprovalPanel; client-ui-subagent SubagentReadOnlyComposer; client-ui-user-questions QuestionComposer. Replace risk: `none`.
|
|
249
|
+
|
|
250
|
+
Example:
|
|
251
|
+
|
|
252
|
+
```js
|
|
253
|
+
return {
|
|
254
|
+
inject: ['slots'],
|
|
255
|
+
apply(ctx) {
|
|
256
|
+
ctx.slots.inject('conversation.composer', () => ctx.slots.register(
|
|
257
|
+
{ name: 'conversation.composer', select: owner => null },
|
|
258
|
+
() => React.createElement('div', null, 'hello'),
|
|
259
|
+
))
|
|
260
|
+
},
|
|
261
|
+
}
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### `conversation.composer.bar`
|
|
265
|
+
|
|
266
|
+
Kind `single`, scope `session-maybe`. Resident composer body, including the no-Session inert state.
|
|
267
|
+
|
|
268
|
+
Props your component receives:
|
|
269
|
+
|
|
270
|
+
```ts
|
|
271
|
+
/** Owner share of the resident composer bar. */
|
|
272
|
+
export interface ComposerBarOwnerProps {
|
|
273
|
+
/** Hero uses centered placement; composer uses the active bottom placement. */
|
|
274
|
+
variant: 'hero' | 'composer'
|
|
275
|
+
/** A feature-owned reason that makes message input inert while leaving model selection live. */
|
|
276
|
+
blocked?: { readonly reason: string }
|
|
277
|
+
/** Lock all message actions while preserving the resident composer surface. */
|
|
278
|
+
disabled?: boolean
|
|
279
|
+
/** Whether the shared Workspace picker is expanded. */
|
|
280
|
+
workspacePickerOpen?: boolean
|
|
281
|
+
/** Open the Workspace picker from the inert composer surface. */
|
|
282
|
+
onRequestWorkspace?: () => void
|
|
283
|
+
placeholder?: string
|
|
284
|
+
/** Optional content rendered above the composer surface. */
|
|
285
|
+
accessory?: ReactNode
|
|
286
|
+
}
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
Already occupied by: client-ui-conversation InputBar. Replace risk: `shadows-shipped-ui`.
|
|
290
|
+
|
|
291
|
+
Example:
|
|
292
|
+
|
|
293
|
+
```js
|
|
294
|
+
return {
|
|
295
|
+
inject: ['slots'],
|
|
296
|
+
apply(ctx) {
|
|
297
|
+
ctx.slots.inject('conversation.composer.bar', () => ctx.slots.register(
|
|
298
|
+
{ name: 'conversation.composer.bar' },
|
|
299
|
+
() => React.createElement('div', null, 'hello'),
|
|
300
|
+
))
|
|
301
|
+
},
|
|
302
|
+
}
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### `conversation.composer.dock`
|
|
306
|
+
|
|
307
|
+
Kind `list`, scope `session`. Ambient entries below the composer card.
|
|
308
|
+
|
|
309
|
+
Register options:
|
|
310
|
+
|
|
311
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
312
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
313
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
314
|
+
|
|
315
|
+
Already occupied by: client-ui-chat StatsPills id 'stats'. Replace risk: `none`.
|
|
316
|
+
|
|
317
|
+
Example:
|
|
318
|
+
|
|
319
|
+
```js
|
|
320
|
+
return {
|
|
321
|
+
inject: ['slots'],
|
|
322
|
+
apply(ctx) {
|
|
323
|
+
ctx.slots.inject('conversation.composer.dock', () => ctx.slots.register(
|
|
324
|
+
{ name: 'conversation.composer.dock', id: 'my-entry', order: 100, label: 'My entry' },
|
|
325
|
+
() => React.createElement('div', null, 'hello'),
|
|
326
|
+
))
|
|
327
|
+
},
|
|
328
|
+
}
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### `conversation.header`
|
|
332
|
+
|
|
333
|
+
Kind `single`, scope `session-maybe`. Resident navigation container, including when no Session is selected.
|
|
334
|
+
|
|
335
|
+
Already occupied by: client-ui-conversation ConversationHeader. Replace risk: `shadows-shipped-ui`.
|
|
336
|
+
|
|
337
|
+
Example:
|
|
338
|
+
|
|
339
|
+
```js
|
|
340
|
+
return {
|
|
341
|
+
inject: ['slots'],
|
|
342
|
+
apply(ctx) {
|
|
343
|
+
ctx.slots.inject('conversation.header', () => ctx.slots.register(
|
|
344
|
+
{ name: 'conversation.header' },
|
|
345
|
+
() => React.createElement('div', null, 'hello'),
|
|
346
|
+
))
|
|
347
|
+
},
|
|
348
|
+
}
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### `conversation.header.leading`
|
|
352
|
+
|
|
353
|
+
Kind `single`, scope `root`. Global navigation before the Session title, available without a Session.
|
|
354
|
+
|
|
355
|
+
Props your component receives:
|
|
356
|
+
|
|
357
|
+
```ts
|
|
358
|
+
/** The leading seat exposes global navigation independently of a Session. */
|
|
359
|
+
export interface ConversationHeaderLeadingOwnerProps {
|
|
360
|
+
/** Marker field: the occupant receives no owner-specific values. */
|
|
361
|
+
children?: never
|
|
362
|
+
}
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
Example:
|
|
366
|
+
|
|
367
|
+
```js
|
|
368
|
+
return {
|
|
369
|
+
inject: ['slots'],
|
|
370
|
+
apply(ctx) {
|
|
371
|
+
ctx.slots.inject('conversation.header.leading', () => ctx.slots.register(
|
|
372
|
+
{ name: 'conversation.header.leading' },
|
|
373
|
+
() => React.createElement('div', null, 'hello'),
|
|
374
|
+
))
|
|
375
|
+
},
|
|
376
|
+
}
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### `conversation.hero.agentPreset`
|
|
380
|
+
|
|
381
|
+
Kind `single`, scope `session-maybe`. Agent-preset control staged for a New Session.
|
|
382
|
+
|
|
383
|
+
Props your component receives:
|
|
384
|
+
|
|
385
|
+
```ts
|
|
386
|
+
/** Owner share of the Hero agent-preset control. */
|
|
387
|
+
export interface HeroAgentPresetOwnerProps {
|
|
388
|
+
/** Marker field: the occupant owns its roster and staged selection. */
|
|
389
|
+
children?: never
|
|
390
|
+
}
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
Already occupied by: client-ui-agent-preset AgentPresetSeat. Replace risk: `shadows-shipped-ui`.
|
|
394
|
+
|
|
395
|
+
Example:
|
|
396
|
+
|
|
397
|
+
```js
|
|
398
|
+
return {
|
|
399
|
+
inject: ['slots'],
|
|
400
|
+
apply(ctx) {
|
|
401
|
+
ctx.slots.inject('conversation.hero.agentPreset', () => ctx.slots.register(
|
|
402
|
+
{ name: 'conversation.hero.agentPreset' },
|
|
403
|
+
() => React.createElement('div', null, 'hello'),
|
|
404
|
+
))
|
|
405
|
+
},
|
|
406
|
+
}
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
### `conversation.hero.brand.mark`
|
|
410
|
+
|
|
411
|
+
Kind `single`, scope `root`. Brand mark shown before the blank-session headline.
|
|
412
|
+
|
|
413
|
+
Props your component receives:
|
|
414
|
+
|
|
415
|
+
```ts
|
|
416
|
+
/** Presentation props supplied to the blank-session brand mark. */
|
|
417
|
+
export interface HeroBrandMarkOwnerProps {
|
|
418
|
+
/** Requested square edge in pixels. */
|
|
419
|
+
size: number
|
|
420
|
+
/** Host class preserving the surrounding mark geometry. */
|
|
421
|
+
className?: string | undefined
|
|
422
|
+
}
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
Example:
|
|
426
|
+
|
|
427
|
+
```js
|
|
428
|
+
return {
|
|
429
|
+
inject: ['slots'],
|
|
430
|
+
apply(ctx) {
|
|
431
|
+
ctx.slots.inject('conversation.hero.brand.mark', () => ctx.slots.register(
|
|
432
|
+
{ name: 'conversation.hero.brand.mark' },
|
|
433
|
+
() => React.createElement('div', null, 'hello'),
|
|
434
|
+
))
|
|
435
|
+
},
|
|
436
|
+
}
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### `conversation.hero.workspace`
|
|
440
|
+
|
|
441
|
+
Kind `single`, scope `root`. Workspace picker shown by the blank-session Hero.
|
|
442
|
+
|
|
443
|
+
Props your component receives:
|
|
444
|
+
|
|
445
|
+
```ts
|
|
446
|
+
/** Owner share common to blank-session Workspace pickers. */
|
|
447
|
+
export interface EmptyWorkspaceOwnerProps {
|
|
448
|
+
open: boolean
|
|
449
|
+
anchorRef?: RefObject<HTMLElement>
|
|
450
|
+
/** Currently selected Workspace, when available. */
|
|
451
|
+
selectedId?: WorkspaceId | undefined
|
|
452
|
+
onPick: (workspaceId: WorkspaceId) => void
|
|
453
|
+
onClose: () => void
|
|
454
|
+
}
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
Already occupied by: client-ui-workspace WorkspacePicker. Replace risk: `shadows-shipped-ui`.
|
|
458
|
+
|
|
459
|
+
Example:
|
|
460
|
+
|
|
461
|
+
```js
|
|
462
|
+
return {
|
|
463
|
+
inject: ['slots'],
|
|
464
|
+
apply(ctx) {
|
|
465
|
+
ctx.slots.inject('conversation.hero.workspace', () => ctx.slots.register(
|
|
466
|
+
{ name: 'conversation.hero.workspace' },
|
|
467
|
+
() => React.createElement('div', null, 'hello'),
|
|
468
|
+
))
|
|
469
|
+
},
|
|
470
|
+
}
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
### `conversation.hero.workspace.directoryFlow`
|
|
474
|
+
|
|
475
|
+
Kind `single`, scope `root`. Directory-flow hole under the conversation empty-state picker (declared by the WorkspacePicker entry).
|
|
476
|
+
|
|
477
|
+
Props your component receives:
|
|
478
|
+
|
|
479
|
+
```ts
|
|
480
|
+
/**
|
|
481
|
+
* Owner share of the directory-flow holes: the complete conversation between
|
|
482
|
+
* the trigger surface and the picking interaction. The occupant reads `open`
|
|
483
|
+
* to run/render its interaction and reports exactly one outcome per open.
|
|
484
|
+
*/
|
|
485
|
+
export interface DirectoryFlowOwnerProps {
|
|
486
|
+
/** True while a picking interaction is requested; flipping back to false withdraws the request. */
|
|
487
|
+
open: boolean
|
|
488
|
+
/** True while the owner adopts a picked path (`createWorkspace` in flight); occupants disable their commit affordances. */
|
|
489
|
+
busy: boolean
|
|
490
|
+
/** The operator picked a directory (absolute host path); the owner adopts it. */
|
|
491
|
+
onPicked: (path: string) => void
|
|
492
|
+
/** The operator dismissed the interaction; the owner just closes the flow. */
|
|
493
|
+
onCancel: () => void
|
|
494
|
+
/** The interaction itself failed (chooser missing, listing denied); the owner shows its error surface. */
|
|
495
|
+
onError: (message: string) => void
|
|
496
|
+
}
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
Already occupied by: client-ui-directory-picker-browse BrowseDirectoryFlow; client-ui-directory-picker-native NativeDirectoryFlow. Replace risk: `shadows-shipped-ui`.
|
|
500
|
+
|
|
501
|
+
Example:
|
|
502
|
+
|
|
503
|
+
```js
|
|
504
|
+
return {
|
|
505
|
+
inject: ['slots'],
|
|
506
|
+
apply(ctx) {
|
|
507
|
+
ctx.slots.inject('conversation.hero.workspace.directoryFlow', () => ctx.slots.register(
|
|
508
|
+
{ name: 'conversation.hero.workspace.directoryFlow' },
|
|
509
|
+
() => React.createElement('div', null, 'hello'),
|
|
510
|
+
))
|
|
511
|
+
},
|
|
512
|
+
}
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
### `conversation.input.activity`
|
|
516
|
+
|
|
517
|
+
Kind `single`, scope `session`. Compact action after the model selector; it can expand across the toolbar while retaining the editor and submit action.
|
|
518
|
+
|
|
519
|
+
Props your component receives:
|
|
520
|
+
|
|
521
|
+
```ts
|
|
522
|
+
/** A toolbar activity hides ordinary accessory controls while expanded; its occupant must release expansion on unmount. */
|
|
523
|
+
export interface InputActivityOwnerProps extends InputControlOwnerProps {
|
|
524
|
+
/** @param active - whether the occupant needs the toolbar width before the submit action. */
|
|
525
|
+
onActiveChange: (active: boolean) => void
|
|
526
|
+
}
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
Already occupied by: experimental-client-ui-voice-input VoiceInput. Replace risk: `shadows-shipped-ui`.
|
|
530
|
+
|
|
531
|
+
Example:
|
|
532
|
+
|
|
533
|
+
```js
|
|
534
|
+
return {
|
|
535
|
+
inject: ['slots'],
|
|
536
|
+
apply(ctx) {
|
|
537
|
+
ctx.slots.inject('conversation.input.activity', () => ctx.slots.register(
|
|
538
|
+
{ name: 'conversation.input.activity' },
|
|
539
|
+
() => React.createElement('div', null, 'hello'),
|
|
540
|
+
))
|
|
541
|
+
},
|
|
542
|
+
}
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### `conversation.input.attachments`
|
|
546
|
+
|
|
547
|
+
Kind `single`, scope `session-maybe`. Optional draft-attachment rail and drop target.
|
|
548
|
+
|
|
549
|
+
Props your component receives:
|
|
550
|
+
|
|
551
|
+
```ts
|
|
552
|
+
/** Input state handed to the optional attachment presentation plugin. */
|
|
553
|
+
export interface ComposerAttachmentsOwnerProps {
|
|
554
|
+
/** Browser-owned draft attachments in input order. */
|
|
555
|
+
attachments: readonly ComposerAttachment[]
|
|
556
|
+
/** Whether a document-level file drop may add attachments now. */
|
|
557
|
+
canAcceptDrop: boolean
|
|
558
|
+
/**
|
|
559
|
+
* Add one dropped batch through the composer's validation path.
|
|
560
|
+
* @param files - dropped, pasted, or picked browser files in source order.
|
|
561
|
+
* @param directories - members of `files` the drop source identified as directories.
|
|
562
|
+
*/
|
|
563
|
+
onAddFiles: (files: readonly File[], directories?: ReadonlySet<File>) => void
|
|
564
|
+
/** Remove one draft attachment through the Conversation service. */
|
|
565
|
+
onRemoveAttachment: (id: DraftAttachmentId) => void
|
|
566
|
+
/** Current per-draft upload states for file-kind attachments. */
|
|
567
|
+
uploads: DraftFileUploads
|
|
568
|
+
/** Restart one failed file upload. */
|
|
569
|
+
onRetryFile: (id: DraftAttachmentId) => void
|
|
570
|
+
/** Display-ready limits for the drop invitation. */
|
|
571
|
+
dropLimits?: { readonly count: number; readonly size: string } | undefined
|
|
572
|
+
}
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
Already occupied by: client-ui-attachment ComposerAttachments. Replace risk: `shadows-shipped-ui`.
|
|
576
|
+
|
|
577
|
+
Example:
|
|
578
|
+
|
|
579
|
+
```js
|
|
580
|
+
return {
|
|
581
|
+
inject: ['slots'],
|
|
582
|
+
apply(ctx) {
|
|
583
|
+
ctx.slots.inject('conversation.input.attachments', () => ctx.slots.register(
|
|
584
|
+
{ name: 'conversation.input.attachments' },
|
|
585
|
+
() => React.createElement('div', null, 'hello'),
|
|
586
|
+
))
|
|
587
|
+
},
|
|
588
|
+
}
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
### `conversation.input.dock`
|
|
592
|
+
|
|
593
|
+
Kind `list`, scope `session`. Full-width entries above the composer card.
|
|
594
|
+
|
|
595
|
+
Register options:
|
|
596
|
+
|
|
597
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
598
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
599
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
600
|
+
|
|
601
|
+
Props your component receives:
|
|
602
|
+
|
|
603
|
+
```ts
|
|
604
|
+
/** Point-in-time owner values for composer extension entries. */
|
|
605
|
+
export interface InputZone {
|
|
606
|
+
readonly session: SessionSnapshot
|
|
607
|
+
readonly input: InputState
|
|
608
|
+
}
|
|
609
|
+
```
|
|
610
|
+
|
|
611
|
+
Already occupied by: client-ui-conversation QueueDock id 'queue'; client-ui-conversation TodoDock id 'todo'; client-ui-goal GoalDock id 'goal'. Replace risk: `none`.
|
|
612
|
+
|
|
613
|
+
Example:
|
|
614
|
+
|
|
615
|
+
```js
|
|
616
|
+
return {
|
|
617
|
+
inject: ['slots'],
|
|
618
|
+
apply(ctx) {
|
|
619
|
+
ctx.slots.inject('conversation.input.dock', () => ctx.slots.register(
|
|
620
|
+
{ name: 'conversation.input.dock', id: 'my-entry', order: 100, label: 'My entry' },
|
|
621
|
+
() => React.createElement('div', null, 'hello'),
|
|
622
|
+
))
|
|
623
|
+
},
|
|
624
|
+
}
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
### `conversation.input.left`
|
|
628
|
+
|
|
629
|
+
Kind `list`, scope `session`. Compact controls at the left of the composer tool row.
|
|
630
|
+
|
|
631
|
+
Register options:
|
|
632
|
+
|
|
633
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
634
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
635
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
636
|
+
|
|
637
|
+
Example:
|
|
638
|
+
|
|
639
|
+
```js
|
|
640
|
+
return {
|
|
641
|
+
inject: ['slots'],
|
|
642
|
+
apply(ctx) {
|
|
643
|
+
ctx.slots.inject('conversation.input.left', () => ctx.slots.register(
|
|
644
|
+
{ name: 'conversation.input.left', id: 'my-entry', order: 100, label: 'My entry' },
|
|
645
|
+
() => React.createElement('div', null, 'hello'),
|
|
646
|
+
))
|
|
647
|
+
},
|
|
648
|
+
}
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### `conversation.input.model`
|
|
652
|
+
|
|
653
|
+
Kind `single`, scope `session`. Model selector inside the composer tool row.
|
|
654
|
+
|
|
655
|
+
Model selector inside the composer tool row. When expanded controls cannot
|
|
656
|
+
share a line, the row sets --dsh-composer-model-text-display to none and
|
|
657
|
+
--dsh-composer-model-icon-display to block for an occupant's compact display.
|
|
658
|
+
|
|
659
|
+
Props your component receives:
|
|
660
|
+
|
|
661
|
+
```ts
|
|
662
|
+
/** Owner share of the named plan, permission, and model controls. */
|
|
663
|
+
export interface InputControlOwnerProps {
|
|
664
|
+
/** Whether the composer currently refuses interaction. */
|
|
665
|
+
locked: boolean
|
|
666
|
+
}
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
Already occupied by: client-ui-model-selection ModelSelect. Replace risk: `shadows-shipped-ui`.
|
|
670
|
+
|
|
671
|
+
Example:
|
|
672
|
+
|
|
673
|
+
```js
|
|
674
|
+
return {
|
|
675
|
+
inject: ['slots'],
|
|
676
|
+
apply(ctx) {
|
|
677
|
+
ctx.slots.inject('conversation.input.model', () => ctx.slots.register(
|
|
678
|
+
{ name: 'conversation.input.model' },
|
|
679
|
+
() => React.createElement('div', null, 'hello'),
|
|
680
|
+
))
|
|
681
|
+
},
|
|
682
|
+
}
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
### `conversation.input.overlay`
|
|
686
|
+
|
|
687
|
+
Kind `list`, scope `session`. Floating entries rendered inside the resident composer card.
|
|
688
|
+
|
|
689
|
+
Register options:
|
|
690
|
+
|
|
691
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
692
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
693
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
694
|
+
|
|
695
|
+
Already occupied by: client-ui-commands PopupSelectView id 'command-popup'; client-ui-input-trigger MenuView id 'slash-menu'; client-ui-message-feedback FeedbackDialog id 'feedback-dialog'. Replace risk: `none`.
|
|
696
|
+
|
|
697
|
+
Example:
|
|
698
|
+
|
|
699
|
+
```js
|
|
700
|
+
return {
|
|
701
|
+
inject: ['slots'],
|
|
702
|
+
apply(ctx) {
|
|
703
|
+
ctx.slots.inject('conversation.input.overlay', () => ctx.slots.register(
|
|
704
|
+
{ name: 'conversation.input.overlay', id: 'my-entry', order: 100, label: 'My entry' },
|
|
705
|
+
() => React.createElement('div', null, 'hello'),
|
|
706
|
+
))
|
|
707
|
+
},
|
|
708
|
+
}
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
### `conversation.input.permission`
|
|
712
|
+
|
|
713
|
+
Kind `single`, scope `session`. Current-session permission control inside the composer tool row.
|
|
714
|
+
|
|
715
|
+
Props your component receives:
|
|
716
|
+
|
|
717
|
+
```ts
|
|
718
|
+
/** Owner share of the named plan, permission, and model controls. */
|
|
719
|
+
export interface InputControlOwnerProps {
|
|
720
|
+
/** Whether the composer currently refuses interaction. */
|
|
721
|
+
locked: boolean
|
|
722
|
+
}
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
Already occupied by: client-ui-permission-presets PermissionSelect. Replace risk: `shadows-shipped-ui`.
|
|
726
|
+
|
|
727
|
+
Example:
|
|
728
|
+
|
|
729
|
+
```js
|
|
730
|
+
return {
|
|
731
|
+
inject: ['slots'],
|
|
732
|
+
apply(ctx) {
|
|
733
|
+
ctx.slots.inject('conversation.input.permission', () => ctx.slots.register(
|
|
734
|
+
{ name: 'conversation.input.permission' },
|
|
735
|
+
() => React.createElement('div', null, 'hello'),
|
|
736
|
+
))
|
|
737
|
+
},
|
|
738
|
+
}
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### `conversation.input.plan`
|
|
742
|
+
|
|
743
|
+
Kind `single`, scope `session`. Plan control inside the composer tool row.
|
|
744
|
+
|
|
745
|
+
Props your component receives:
|
|
746
|
+
|
|
747
|
+
```ts
|
|
748
|
+
/** Owner share of the named plan, permission, and model controls. */
|
|
749
|
+
export interface InputControlOwnerProps {
|
|
750
|
+
/** Whether the composer currently refuses interaction. */
|
|
751
|
+
locked: boolean
|
|
752
|
+
}
|
|
753
|
+
```
|
|
754
|
+
|
|
755
|
+
Already occupied by: client-ui-plan PlanChip. Replace risk: `shadows-shipped-ui`.
|
|
756
|
+
|
|
757
|
+
Example:
|
|
758
|
+
|
|
759
|
+
```js
|
|
760
|
+
return {
|
|
761
|
+
inject: ['slots'],
|
|
762
|
+
apply(ctx) {
|
|
763
|
+
ctx.slots.inject('conversation.input.plan', () => ctx.slots.register(
|
|
764
|
+
{ name: 'conversation.input.plan' },
|
|
765
|
+
() => React.createElement('div', null, 'hello'),
|
|
766
|
+
))
|
|
767
|
+
},
|
|
768
|
+
}
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
### `conversation.input.right`
|
|
772
|
+
|
|
773
|
+
Kind `list`, scope `session`. Compact controls before the composer submit action.
|
|
774
|
+
|
|
775
|
+
Register options:
|
|
776
|
+
|
|
777
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
778
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
779
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
780
|
+
|
|
781
|
+
Example:
|
|
782
|
+
|
|
783
|
+
```js
|
|
784
|
+
return {
|
|
785
|
+
inject: ['slots'],
|
|
786
|
+
apply(ctx) {
|
|
787
|
+
ctx.slots.inject('conversation.input.right', () => ctx.slots.register(
|
|
788
|
+
{ name: 'conversation.input.right', id: 'my-entry', order: 100, label: 'My entry' },
|
|
789
|
+
() => React.createElement('div', null, 'hello'),
|
|
790
|
+
))
|
|
791
|
+
},
|
|
792
|
+
}
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
### `conversation.message.images`
|
|
796
|
+
|
|
797
|
+
Kind `single`, scope `session`. Renderer for one consecutive group of durable message images.
|
|
798
|
+
|
|
799
|
+
Renderer for one consecutive group of durable message images. The owner
|
|
800
|
+
supplies image references, an authorized loader, and alignment. A
|
|
801
|
+
registration replaces the shipped gallery; without one, images are omitted.
|
|
802
|
+
|
|
803
|
+
Props your component receives:
|
|
804
|
+
|
|
805
|
+
```ts
|
|
806
|
+
/** Message image group handed to the optional attachment presentation plugin. */
|
|
807
|
+
export interface MessageImagesOwnerProps {
|
|
808
|
+
/** Durable references or submission-echo previews in source order. */
|
|
809
|
+
images: readonly MessageImageSource[]
|
|
810
|
+
/** Session-authorized image URL loader for the durable arm. */
|
|
811
|
+
loadImage: MessageImageLoader
|
|
812
|
+
/** Horizontal placement inside the owning record. */
|
|
813
|
+
align: 'start' | 'end'
|
|
814
|
+
/** Force every image into the compact message-attachment tile size. */
|
|
815
|
+
compact?: boolean
|
|
816
|
+
/** Fixed, uncropped thumbnail for an attachment list row. */
|
|
817
|
+
thumbnail?: boolean
|
|
818
|
+
}
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
Already occupied by: client-ui-attachment MessageImages. Replace risk: `shadows-shipped-ui`.
|
|
822
|
+
|
|
823
|
+
Example:
|
|
824
|
+
|
|
825
|
+
```js
|
|
826
|
+
return {
|
|
827
|
+
inject: ['slots'],
|
|
828
|
+
apply(ctx) {
|
|
829
|
+
ctx.slots.inject('conversation.message.images', () => ctx.slots.register(
|
|
830
|
+
{ name: 'conversation.message.images' },
|
|
831
|
+
() => React.createElement('div', null, 'hello'),
|
|
832
|
+
))
|
|
833
|
+
},
|
|
834
|
+
}
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
### `conversation.plan-review.actions`
|
|
838
|
+
|
|
839
|
+
Kind `list`, scope `session`. Actions for the exact plan under review; approval remains with the question composer.
|
|
840
|
+
|
|
841
|
+
Register options:
|
|
842
|
+
|
|
843
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
844
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
845
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
846
|
+
|
|
847
|
+
Props your component receives:
|
|
848
|
+
|
|
849
|
+
```ts
|
|
850
|
+
/**
|
|
851
|
+
* A request narrowed to the `plan-review` presentation intent: everything the
|
|
852
|
+
* decision card renders and answers with, so the panel never re-reads the
|
|
853
|
+
* request fields. `approve` and `decline` are the asker's own options - an
|
|
854
|
+
* answer must carry one of those labels verbatim - and `plan` is the markdown
|
|
855
|
+
* body under review.
|
|
856
|
+
*/
|
|
857
|
+
export interface PlanReview {
|
|
858
|
+
/** The reviewed question's id, echoed in the answer. */
|
|
859
|
+
id: string
|
|
860
|
+
/** The question text, kept as the card's accessible name. */
|
|
861
|
+
question: string
|
|
862
|
+
/** The plan markdown under review. */
|
|
863
|
+
plan: string
|
|
864
|
+
/** Logged tool invocation used to reopen this plan. */
|
|
865
|
+
callId?: ToolCallId
|
|
866
|
+
/** The option that approves the plan. */
|
|
867
|
+
approve: QuestionOption
|
|
868
|
+
/** The option that declines it; absent when the asker offered no other option. */
|
|
869
|
+
decline?: QuestionOption
|
|
870
|
+
}
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
Already occupied by: client-ui-plan PlanReviewOpen. Replace risk: `none`.
|
|
874
|
+
|
|
875
|
+
Example:
|
|
876
|
+
|
|
877
|
+
```js
|
|
878
|
+
return {
|
|
879
|
+
inject: ['slots'],
|
|
880
|
+
apply(ctx) {
|
|
881
|
+
ctx.slots.inject('conversation.plan-review.actions', () => ctx.slots.register(
|
|
882
|
+
{ name: 'conversation.plan-review.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
883
|
+
() => React.createElement('div', null, 'hello'),
|
|
884
|
+
))
|
|
885
|
+
},
|
|
886
|
+
}
|
|
887
|
+
```
|
|
888
|
+
|
|
889
|
+
### `conversation.session`
|
|
890
|
+
|
|
891
|
+
Kind `single`, scope `session`. Strict per-Session Conversation body.
|
|
892
|
+
|
|
893
|
+
Already occupied by: client-ui-conversation ConversationSession. Replace risk: `shadows-shipped-ui`.
|
|
894
|
+
|
|
895
|
+
Example:
|
|
896
|
+
|
|
897
|
+
```js
|
|
898
|
+
return {
|
|
899
|
+
inject: ['slots'],
|
|
900
|
+
apply(ctx) {
|
|
901
|
+
ctx.slots.inject('conversation.session', () => ctx.slots.register(
|
|
902
|
+
{ name: 'conversation.session' },
|
|
903
|
+
() => React.createElement('div', null, 'hello'),
|
|
904
|
+
))
|
|
905
|
+
},
|
|
906
|
+
}
|
|
907
|
+
```
|
|
908
|
+
|
|
909
|
+
### `conversation.session.header`
|
|
910
|
+
|
|
911
|
+
Kind `single`, scope `session`. Strict per-Session title, actions, and View navigation.
|
|
912
|
+
|
|
913
|
+
Already occupied by: client-ui-conversation ConversationSessionHeader. Replace risk: `shadows-shipped-ui`.
|
|
914
|
+
|
|
915
|
+
Example:
|
|
916
|
+
|
|
917
|
+
```js
|
|
918
|
+
return {
|
|
919
|
+
inject: ['slots'],
|
|
920
|
+
apply(ctx) {
|
|
921
|
+
ctx.slots.inject('conversation.session.header', () => ctx.slots.register(
|
|
922
|
+
{ name: 'conversation.session.header' },
|
|
923
|
+
() => React.createElement('div', null, 'hello'),
|
|
924
|
+
))
|
|
925
|
+
},
|
|
926
|
+
}
|
|
927
|
+
```
|
|
928
|
+
|
|
929
|
+
### `conversation.session.header.actions`
|
|
930
|
+
|
|
931
|
+
Kind `list`, scope `session`. Title-adjacent Session actions in ascending order.
|
|
932
|
+
|
|
933
|
+
Register options:
|
|
934
|
+
|
|
935
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
936
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
937
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
938
|
+
|
|
939
|
+
Props your component receives:
|
|
940
|
+
|
|
941
|
+
```ts
|
|
942
|
+
/** Header actions derive their state from standard Session props. */
|
|
943
|
+
export interface ConversationHeaderActionOwnerProps {
|
|
944
|
+
/** Marker field: entries receive no owner-specific values. */
|
|
945
|
+
children?: never
|
|
946
|
+
}
|
|
947
|
+
```
|
|
948
|
+
|
|
949
|
+
Already occupied by: client-ui-agent-preset AgentPresetLabel id 'agent-preset'; client-ui-jobs JobListAction id 'job-list'; client-ui-subagent SubagentCatalogAction id 'subagent-catalog'; experimental-client-ui-agent-team TeamAction id 'agent-team'. Replace risk: `none`.
|
|
950
|
+
|
|
951
|
+
Example:
|
|
952
|
+
|
|
953
|
+
```js
|
|
954
|
+
return {
|
|
955
|
+
inject: ['slots'],
|
|
956
|
+
apply(ctx) {
|
|
957
|
+
ctx.slots.inject('conversation.session.header.actions', () => ctx.slots.register(
|
|
958
|
+
{ name: 'conversation.session.header.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
959
|
+
() => React.createElement('div', null, 'hello'),
|
|
960
|
+
))
|
|
961
|
+
},
|
|
962
|
+
}
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
### `conversation.session.header.corner`
|
|
966
|
+
|
|
967
|
+
Kind `single`, scope `session`. The header's far-right corner, past the utilities' edge and into the header's own padding, for one control.
|
|
968
|
+
|
|
969
|
+
The header's far-right corner, past the utilities' edge and into the
|
|
970
|
+
header's own padding, for one control. The corner is laid out only while
|
|
971
|
+
its occupant renders something; an occupant with nothing to show renders
|
|
972
|
+
nothing, and the utilities take the header's edge.
|
|
973
|
+
|
|
974
|
+
Props your component receives:
|
|
975
|
+
|
|
976
|
+
```ts
|
|
977
|
+
/** The header corner's occupant derives its state from standard Session props. */
|
|
978
|
+
export interface ConversationHeaderCornerOwnerProps {
|
|
979
|
+
/** Marker field: the occupant receives no owner-specific values. */
|
|
980
|
+
children?: never
|
|
981
|
+
}
|
|
982
|
+
```
|
|
983
|
+
|
|
984
|
+
Already occupied by: client-ui-sidebar-right ExpandButton. Replace risk: `shadows-shipped-ui`.
|
|
985
|
+
|
|
986
|
+
Example:
|
|
987
|
+
|
|
988
|
+
```js
|
|
989
|
+
return {
|
|
990
|
+
inject: ['slots'],
|
|
991
|
+
apply(ctx) {
|
|
992
|
+
ctx.slots.inject('conversation.session.header.corner', () => ctx.slots.register(
|
|
993
|
+
{ name: 'conversation.session.header.corner' },
|
|
994
|
+
() => React.createElement('div', null, 'hello'),
|
|
995
|
+
))
|
|
996
|
+
},
|
|
997
|
+
}
|
|
998
|
+
```
|
|
999
|
+
|
|
1000
|
+
### `conversation.session.header.lineage`
|
|
1001
|
+
|
|
1002
|
+
Kind `single`, scope `session`. Optional replacement for one Session breadcrumb title.
|
|
1003
|
+
|
|
1004
|
+
Props your component receives:
|
|
1005
|
+
|
|
1006
|
+
```ts
|
|
1007
|
+
/** Plain breadcrumb data handed to the optional lineage renderer. */
|
|
1008
|
+
export interface ConversationHeaderLineageOwnerProps {
|
|
1009
|
+
/** Session represented by this breadcrumb title. */
|
|
1010
|
+
lineageSessionId: SessionId
|
|
1011
|
+
/** Display title available to a combined title/control renderer. */
|
|
1012
|
+
displayTitle: string
|
|
1013
|
+
/** Navigate to an ancestor title when present. */
|
|
1014
|
+
openTitle?: () => void
|
|
1015
|
+
}
|
|
1016
|
+
```
|
|
1017
|
+
|
|
1018
|
+
Already occupied by: client-ui-subagent SubagentHeaderLineage. Replace risk: `shadows-shipped-ui`.
|
|
1019
|
+
|
|
1020
|
+
Example:
|
|
1021
|
+
|
|
1022
|
+
```js
|
|
1023
|
+
return {
|
|
1024
|
+
inject: ['slots'],
|
|
1025
|
+
apply(ctx) {
|
|
1026
|
+
ctx.slots.inject('conversation.session.header.lineage', () => ctx.slots.register(
|
|
1027
|
+
{ name: 'conversation.session.header.lineage' },
|
|
1028
|
+
() => React.createElement('div', null, 'hello'),
|
|
1029
|
+
))
|
|
1030
|
+
},
|
|
1031
|
+
}
|
|
1032
|
+
```
|
|
1033
|
+
|
|
1034
|
+
### `conversation.session.header.utilities`
|
|
1035
|
+
|
|
1036
|
+
Kind `list`, scope `session`. Right-aligned Session utilities in ascending order.
|
|
1037
|
+
|
|
1038
|
+
Register options:
|
|
1039
|
+
|
|
1040
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1041
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1042
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1043
|
+
|
|
1044
|
+
Props your component receives:
|
|
1045
|
+
|
|
1046
|
+
```ts
|
|
1047
|
+
/** Header actions derive their state from standard Session props. */
|
|
1048
|
+
export interface ConversationHeaderActionOwnerProps {
|
|
1049
|
+
/** Marker field: entries receive no owner-specific values. */
|
|
1050
|
+
children?: never
|
|
1051
|
+
}
|
|
1052
|
+
```
|
|
1053
|
+
|
|
1054
|
+
Already occupied by: client-ui-open-in-app SessionOpenInAppAction id 'open-in-app'; client-ui-schedule ScheduleCatalogAction id 'schedule-catalog'; session-log-export SessionLogDownloadHeaderAction id 'session-log-download'. Replace risk: `none`.
|
|
1055
|
+
|
|
1056
|
+
Example:
|
|
1057
|
+
|
|
1058
|
+
```js
|
|
1059
|
+
return {
|
|
1060
|
+
inject: ['slots'],
|
|
1061
|
+
apply(ctx) {
|
|
1062
|
+
ctx.slots.inject('conversation.session.header.utilities', () => ctx.slots.register(
|
|
1063
|
+
{ name: 'conversation.session.header.utilities', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1064
|
+
() => React.createElement('div', null, 'hello'),
|
|
1065
|
+
))
|
|
1066
|
+
},
|
|
1067
|
+
}
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
### `conversation.trajectory.images`
|
|
1071
|
+
|
|
1072
|
+
Kind `single`, scope `session`. Renderer for one group of durable record images in the Trajectory ledger.
|
|
1073
|
+
|
|
1074
|
+
Renderer for one group of durable record images in the Trajectory
|
|
1075
|
+
ledger. The owner supplies image references, an authorized loader, and
|
|
1076
|
+
alignment. A registration replaces the shipped gallery; without one,
|
|
1077
|
+
images are omitted.
|
|
1078
|
+
|
|
1079
|
+
Props your component receives:
|
|
1080
|
+
|
|
1081
|
+
```ts
|
|
1082
|
+
/** Message image group handed to the optional attachment presentation plugin. */
|
|
1083
|
+
export interface MessageImagesOwnerProps {
|
|
1084
|
+
/** Durable references or submission-echo previews in source order. */
|
|
1085
|
+
images: readonly MessageImageSource[]
|
|
1086
|
+
/** Session-authorized image URL loader for the durable arm. */
|
|
1087
|
+
loadImage: MessageImageLoader
|
|
1088
|
+
/** Horizontal placement inside the owning record. */
|
|
1089
|
+
align: 'start' | 'end'
|
|
1090
|
+
/** Force every image into the compact message-attachment tile size. */
|
|
1091
|
+
compact?: boolean
|
|
1092
|
+
/** Fixed, uncropped thumbnail for an attachment list row. */
|
|
1093
|
+
thumbnail?: boolean
|
|
1094
|
+
}
|
|
1095
|
+
```
|
|
1096
|
+
|
|
1097
|
+
Already occupied by: client-ui-attachment MessageImages. Replace risk: `shadows-shipped-ui`.
|
|
1098
|
+
|
|
1099
|
+
Example:
|
|
1100
|
+
|
|
1101
|
+
```js
|
|
1102
|
+
return {
|
|
1103
|
+
inject: ['slots'],
|
|
1104
|
+
apply(ctx) {
|
|
1105
|
+
ctx.slots.inject('conversation.trajectory.images', () => ctx.slots.register(
|
|
1106
|
+
{ name: 'conversation.trajectory.images' },
|
|
1107
|
+
() => React.createElement('div', null, 'hello'),
|
|
1108
|
+
))
|
|
1109
|
+
},
|
|
1110
|
+
}
|
|
1111
|
+
```
|
|
1112
|
+
|
|
1113
|
+
### `conversation.view`
|
|
1114
|
+
|
|
1115
|
+
Kind `list`, scope `session`. Registered Conversation target Views, rendered one at a time.
|
|
1116
|
+
|
|
1117
|
+
Register options:
|
|
1118
|
+
|
|
1119
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1120
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1121
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1122
|
+
|
|
1123
|
+
Props your component receives:
|
|
1124
|
+
|
|
1125
|
+
```ts
|
|
1126
|
+
/** Conversation View entries obtain their data from registered standard hooks. */
|
|
1127
|
+
export interface ConvViewOwnerProps {
|
|
1128
|
+
/** Open a tool call's inspector when an inspection target is available. */
|
|
1129
|
+
inspectCall: ((callId: string) => void) | undefined
|
|
1130
|
+
/** Focus request addressed to the selected View. */
|
|
1131
|
+
viewRequest: import('./views.ts').ConversationViewRequest | null
|
|
1132
|
+
/** Select a View and address one opaque focus identity to it. */
|
|
1133
|
+
openView: (view: string, focus: string) => void
|
|
1134
|
+
/** Acknowledge the current one-shot focus request. */
|
|
1135
|
+
completeViewRequest: () => void
|
|
1136
|
+
}
|
|
1137
|
+
```
|
|
1138
|
+
|
|
1139
|
+
Already occupied by: client-ui-chat ChatView id 'chat'; client-ui-trajectory TrajectoryView id 'trajectory'. Replace risk: `none`.
|
|
1140
|
+
|
|
1141
|
+
Example:
|
|
1142
|
+
|
|
1143
|
+
```js
|
|
1144
|
+
return {
|
|
1145
|
+
inject: ['slots'],
|
|
1146
|
+
apply(ctx) {
|
|
1147
|
+
ctx.slots.inject('conversation.view', () => ctx.slots.register(
|
|
1148
|
+
{ name: 'conversation.view', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1149
|
+
() => React.createElement('div', null, 'hello'),
|
|
1150
|
+
))
|
|
1151
|
+
},
|
|
1152
|
+
}
|
|
1153
|
+
```
|
|
1154
|
+
|
|
1155
|
+
### `deliverables.file.actions`
|
|
1156
|
+
|
|
1157
|
+
Kind `list`, scope `session`. Open one file through its authorized Session event coordinates.
|
|
1158
|
+
|
|
1159
|
+
Register options:
|
|
1160
|
+
|
|
1161
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1162
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1163
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1164
|
+
|
|
1165
|
+
Props your component receives:
|
|
1166
|
+
|
|
1167
|
+
```ts
|
|
1168
|
+
/** Native file action selected by an explicit user gesture. */
|
|
1169
|
+
export type PresentedAction = 'open' | 'reveal'
|
|
1170
|
+
|
|
1171
|
+
/** Failure feedback for the shared native opening control. */
|
|
1172
|
+
export type PresentedOpenFailure = 'openError' | 'revealError' | null
|
|
1173
|
+
```
|
|
1174
|
+
|
|
1175
|
+
Already occupied by: client-ui-open-in-app FileRouteAction id 'open-in-app'. Replace risk: `none`.
|
|
1176
|
+
|
|
1177
|
+
Example:
|
|
1178
|
+
|
|
1179
|
+
```js
|
|
1180
|
+
return {
|
|
1181
|
+
inject: ['slots'],
|
|
1182
|
+
apply(ctx) {
|
|
1183
|
+
ctx.slots.inject('deliverables.file.actions', () => ctx.slots.register(
|
|
1184
|
+
{ name: 'deliverables.file.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1185
|
+
() => React.createElement('div', null, 'hello'),
|
|
1186
|
+
))
|
|
1187
|
+
},
|
|
1188
|
+
}
|
|
1189
|
+
```
|
|
1190
|
+
|
|
1191
|
+
### `deliverables.review.file.actions`
|
|
1192
|
+
|
|
1193
|
+
Kind `list`, scope `session`. The same file actions owned by a changed-file review tab.
|
|
1194
|
+
|
|
1195
|
+
Register options:
|
|
1196
|
+
|
|
1197
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1198
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1199
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1200
|
+
|
|
1201
|
+
Props your component receives:
|
|
1202
|
+
|
|
1203
|
+
```ts
|
|
1204
|
+
/** Slot contract table. Owners extend via declaration merging; entries are {@link SlotEntryDef}. */
|
|
1205
|
+
export interface SlotMap {}
|
|
1206
|
+
```
|
|
1207
|
+
|
|
1208
|
+
Already occupied by: client-ui-open-in-app FileRouteAction id 'open-in-app'. Replace risk: `none`.
|
|
1209
|
+
|
|
1210
|
+
Example:
|
|
1211
|
+
|
|
1212
|
+
```js
|
|
1213
|
+
return {
|
|
1214
|
+
inject: ['slots'],
|
|
1215
|
+
apply(ctx) {
|
|
1216
|
+
ctx.slots.inject('deliverables.review.file.actions', () => ctx.slots.register(
|
|
1217
|
+
{ name: 'deliverables.review.file.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1218
|
+
() => React.createElement('div', null, 'hello'),
|
|
1219
|
+
))
|
|
1220
|
+
},
|
|
1221
|
+
}
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
### `main`
|
|
1225
|
+
|
|
1226
|
+
Kind `keyed`, scope `root`. Central panel selected by sidebar entry id.
|
|
1227
|
+
|
|
1228
|
+
Central panel selected by sidebar entry id. The reserved `conversation`
|
|
1229
|
+
key hosts the Conversation; other keys receive no Session binding.
|
|
1230
|
+
|
|
1231
|
+
Register options:
|
|
1232
|
+
|
|
1233
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
1234
|
+
|
|
1235
|
+
Keys: open: any string the owner dispatches (no compile-time key set), already taken: conversation
|
|
1236
|
+
|
|
1237
|
+
Already occupied by: client-ui-conversation ConversationPanel key 'conversation'; client-ui-plugin-manager PluginManagerPage; client-ui-schedule TaskManagerPage. Replace risk: `shadows-shipped-ui`.
|
|
1238
|
+
|
|
1239
|
+
Example:
|
|
1240
|
+
|
|
1241
|
+
```js
|
|
1242
|
+
return {
|
|
1243
|
+
inject: ['slots'],
|
|
1244
|
+
apply(ctx) {
|
|
1245
|
+
ctx.slots.inject('main', () => ctx.slots.register(
|
|
1246
|
+
{ name: 'main', key: '<one key the owner dispatches>' },
|
|
1247
|
+
() => React.createElement('div', null, 'hello'),
|
|
1248
|
+
))
|
|
1249
|
+
},
|
|
1250
|
+
}
|
|
1251
|
+
```
|
|
1252
|
+
|
|
1253
|
+
### `main.conversation`
|
|
1254
|
+
|
|
1255
|
+
Kind `single`, scope `session-maybe`. Conversation shell beneath its root-scoped main-panel entry.
|
|
1256
|
+
|
|
1257
|
+
Already occupied by: client-ui-conversation ConversationRoot. Replace risk: `shadows-shipped-ui`.
|
|
1258
|
+
|
|
1259
|
+
Example:
|
|
1260
|
+
|
|
1261
|
+
```js
|
|
1262
|
+
return {
|
|
1263
|
+
inject: ['slots'],
|
|
1264
|
+
apply(ctx) {
|
|
1265
|
+
ctx.slots.inject('main.conversation', () => ctx.slots.register(
|
|
1266
|
+
{ name: 'main.conversation' },
|
|
1267
|
+
() => React.createElement('div', null, 'hello'),
|
|
1268
|
+
))
|
|
1269
|
+
},
|
|
1270
|
+
}
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
### `plugins.bundle.activation`
|
|
1274
|
+
|
|
1275
|
+
Kind `keyed`, scope `root`. Optional guidance after the user enables a bundle from the list, keyed by npm package name.
|
|
1276
|
+
|
|
1277
|
+
Register options:
|
|
1278
|
+
|
|
1279
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
1280
|
+
|
|
1281
|
+
Props your component receives:
|
|
1282
|
+
|
|
1283
|
+
```ts
|
|
1284
|
+
/** One user-requested bundle activation and navigation to its configuration page. */
|
|
1285
|
+
export interface PluginActivationOwnerProps {
|
|
1286
|
+
readonly packageName: string
|
|
1287
|
+
/** Dismiss guidance for this activation. */
|
|
1288
|
+
readonly onDismiss: () => void
|
|
1289
|
+
/** Dismiss guidance and open this bundle's detail page. */
|
|
1290
|
+
readonly onOpenDetails: () => void
|
|
1291
|
+
}
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
Keys: open: any string the owner dispatches (no compile-time key set), already taken: @deepseek-ai/dsh-experimental-voice-input-bundle
|
|
1295
|
+
|
|
1296
|
+
Already occupied by: experimental-client-ui-voice-input VoiceSetupPrompt key '@deepseek-ai/dsh-experimental-voice-input-bundle'. Replace risk: `shadows-shipped-ui`.
|
|
1297
|
+
|
|
1298
|
+
Example:
|
|
1299
|
+
|
|
1300
|
+
```js
|
|
1301
|
+
return {
|
|
1302
|
+
inject: ['slots'],
|
|
1303
|
+
apply(ctx) {
|
|
1304
|
+
ctx.slots.inject('plugins.bundle.activation', () => ctx.slots.register(
|
|
1305
|
+
{ name: 'plugins.bundle.activation', key: '<one key the owner dispatches>' },
|
|
1306
|
+
() => React.createElement('div', null, 'hello'),
|
|
1307
|
+
))
|
|
1308
|
+
},
|
|
1309
|
+
}
|
|
1310
|
+
```
|
|
1311
|
+
|
|
1312
|
+
### `plugins.bundle.config`
|
|
1313
|
+
|
|
1314
|
+
Kind `keyed`, scope `root`. A bundle's own configuration, keyed by the bundle's package name and rendered on the bundle's page between its description and its rows (`view: 'page'` only).
|
|
1315
|
+
|
|
1316
|
+
A bundle's own configuration, keyed by the bundle's package name and
|
|
1317
|
+
rendered on the bundle's page between its description and its rows
|
|
1318
|
+
(`view: 'page'` only).
|
|
1319
|
+
|
|
1320
|
+
Register options:
|
|
1321
|
+
|
|
1322
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
1323
|
+
|
|
1324
|
+
Props your component receives:
|
|
1325
|
+
|
|
1326
|
+
```ts
|
|
1327
|
+
/** The view the page asks a configuration entry for. */
|
|
1328
|
+
export interface PluginConfigViewProps {
|
|
1329
|
+
/** `summary` renders the one-liner alone, as text or inline nodes; `page` renders the form with its save control. */
|
|
1330
|
+
readonly view: 'summary' | 'page'
|
|
1331
|
+
/** Host-owned configuration values and write actions for this page's entry. */
|
|
1332
|
+
readonly form?: ConfigPageForm | undefined
|
|
1333
|
+
}
|
|
1334
|
+
```
|
|
1335
|
+
|
|
1336
|
+
Keys: open: any string the owner dispatches (no compile-time key set), already taken: @deepseek-ai/dsh-experimental-voice-input-bundle
|
|
1337
|
+
|
|
1338
|
+
Already occupied by: experimental-client-ui-voice-input VoicePreparation key '@deepseek-ai/dsh-experimental-voice-input-bundle'. Replace risk: `shadows-shipped-ui`.
|
|
1339
|
+
|
|
1340
|
+
Example:
|
|
1341
|
+
|
|
1342
|
+
```js
|
|
1343
|
+
return {
|
|
1344
|
+
inject: ['slots'],
|
|
1345
|
+
apply(ctx) {
|
|
1346
|
+
ctx.slots.inject('plugins.bundle.config', () => ctx.slots.register(
|
|
1347
|
+
{ name: 'plugins.bundle.config', key: '<one key the owner dispatches>' },
|
|
1348
|
+
() => React.createElement('div', null, 'hello'),
|
|
1349
|
+
))
|
|
1350
|
+
},
|
|
1351
|
+
}
|
|
1352
|
+
```
|
|
1353
|
+
|
|
1354
|
+
### `plugins.detail.actions`
|
|
1355
|
+
|
|
1356
|
+
Kind `list`, scope `root`. Controls at the head of a detail page, before the page's own switch and uninstall, rendered with the page's subject.
|
|
1357
|
+
|
|
1358
|
+
Controls at the head of a detail page, before the page's own switch and
|
|
1359
|
+
uninstall, rendered with the page's subject. An entry renders null for a
|
|
1360
|
+
subject it has no control for.
|
|
1361
|
+
|
|
1362
|
+
Register options:
|
|
1363
|
+
|
|
1364
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1365
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1366
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1367
|
+
|
|
1368
|
+
Props your component receives:
|
|
1369
|
+
|
|
1370
|
+
```ts
|
|
1371
|
+
/** The owner props every detail contribution is rendered with. */
|
|
1372
|
+
export interface PluginDetailProps {
|
|
1373
|
+
/** The subject of the open page; an entry renders null for a subject it has nothing for. */
|
|
1374
|
+
readonly subject: PluginsSubject
|
|
1375
|
+
}
|
|
1376
|
+
```
|
|
1377
|
+
|
|
1378
|
+
Example:
|
|
1379
|
+
|
|
1380
|
+
```js
|
|
1381
|
+
return {
|
|
1382
|
+
inject: ['slots'],
|
|
1383
|
+
apply(ctx) {
|
|
1384
|
+
ctx.slots.inject('plugins.detail.actions', () => ctx.slots.register(
|
|
1385
|
+
{ name: 'plugins.detail.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1386
|
+
() => React.createElement('div', null, 'hello'),
|
|
1387
|
+
))
|
|
1388
|
+
},
|
|
1389
|
+
}
|
|
1390
|
+
```
|
|
1391
|
+
|
|
1392
|
+
### `plugins.detail.badge`
|
|
1393
|
+
|
|
1394
|
+
Kind `list`, scope `root`. Tags beside a detail page's title, after the version, beta, and problem tags the page draws itself, rendered with the page's subject.
|
|
1395
|
+
|
|
1396
|
+
Tags beside a detail page's title, after the version, beta, and problem
|
|
1397
|
+
tags the page draws itself, rendered with the page's subject.
|
|
1398
|
+
|
|
1399
|
+
Register options:
|
|
1400
|
+
|
|
1401
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1402
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1403
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1404
|
+
|
|
1405
|
+
Props your component receives:
|
|
1406
|
+
|
|
1407
|
+
```ts
|
|
1408
|
+
/** The owner props every detail contribution is rendered with. */
|
|
1409
|
+
export interface PluginDetailProps {
|
|
1410
|
+
/** The subject of the open page; an entry renders null for a subject it has nothing for. */
|
|
1411
|
+
readonly subject: PluginsSubject
|
|
1412
|
+
}
|
|
1413
|
+
```
|
|
1414
|
+
|
|
1415
|
+
Example:
|
|
1416
|
+
|
|
1417
|
+
```js
|
|
1418
|
+
return {
|
|
1419
|
+
inject: ['slots'],
|
|
1420
|
+
apply(ctx) {
|
|
1421
|
+
ctx.slots.inject('plugins.detail.badge', () => ctx.slots.register(
|
|
1422
|
+
{ name: 'plugins.detail.badge', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1423
|
+
() => React.createElement('div', null, 'hello'),
|
|
1424
|
+
))
|
|
1425
|
+
},
|
|
1426
|
+
}
|
|
1427
|
+
```
|
|
1428
|
+
|
|
1429
|
+
### `plugins.detail.section`
|
|
1430
|
+
|
|
1431
|
+
Kind `list`, scope `root`. Sections under a detail page's own content: after the rows on a bundle's page, after the configuration on a row's or an official plugin's page.
|
|
1432
|
+
|
|
1433
|
+
Sections under a detail page's own content: after the rows on a bundle's
|
|
1434
|
+
page, after the configuration on a row's or an official plugin's page.
|
|
1435
|
+
An entry draws its own section chrome and renders null for a subject it
|
|
1436
|
+
has nothing for.
|
|
1437
|
+
|
|
1438
|
+
Register options:
|
|
1439
|
+
|
|
1440
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1441
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1442
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1443
|
+
|
|
1444
|
+
Props your component receives:
|
|
1445
|
+
|
|
1446
|
+
```ts
|
|
1447
|
+
/** The owner props every detail contribution is rendered with. */
|
|
1448
|
+
export interface PluginDetailProps {
|
|
1449
|
+
/** The subject of the open page; an entry renders null for a subject it has nothing for. */
|
|
1450
|
+
readonly subject: PluginsSubject
|
|
1451
|
+
}
|
|
1452
|
+
```
|
|
1453
|
+
|
|
1454
|
+
Example:
|
|
1455
|
+
|
|
1456
|
+
```js
|
|
1457
|
+
return {
|
|
1458
|
+
inject: ['slots'],
|
|
1459
|
+
apply(ctx) {
|
|
1460
|
+
ctx.slots.inject('plugins.detail.section', () => ctx.slots.register(
|
|
1461
|
+
{ name: 'plugins.detail.section', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1462
|
+
() => React.createElement('div', null, 'hello'),
|
|
1463
|
+
))
|
|
1464
|
+
},
|
|
1465
|
+
}
|
|
1466
|
+
```
|
|
1467
|
+
|
|
1468
|
+
### `plugins.item`
|
|
1469
|
+
|
|
1470
|
+
Kind `list`, scope `root`. One official plugin the Plugins page lists in its Official group after the official bundles: `label` is the card's title and `order` its place.
|
|
1471
|
+
|
|
1472
|
+
One official plugin the Plugins page lists in its Official group after
|
|
1473
|
+
the official bundles: `label` is the card's title and `order` its place.
|
|
1474
|
+
The page renders the entry as the card's one-liner (`view: 'summary'`)
|
|
1475
|
+
and, once the card is opened, as the body of the plugin's own page
|
|
1476
|
+
(`view: 'page'`). OCCUPIED by the official settings pages, one companion
|
|
1477
|
+
package per host-plane namespace; a bundle's configuration belongs in
|
|
1478
|
+
`plugins.bundle.config` or `plugins.row.config` instead.
|
|
1479
|
+
|
|
1480
|
+
Register options:
|
|
1481
|
+
|
|
1482
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1483
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1484
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1485
|
+
|
|
1486
|
+
Props your component receives:
|
|
1487
|
+
|
|
1488
|
+
```ts
|
|
1489
|
+
/** The view the page asks a configuration entry for. */
|
|
1490
|
+
export interface PluginConfigViewProps {
|
|
1491
|
+
/** `summary` renders the one-liner alone, as text or inline nodes; `page` renders the form with its save control. */
|
|
1492
|
+
readonly view: 'summary' | 'page'
|
|
1493
|
+
/** Host-owned configuration values and write actions for this page's entry. */
|
|
1494
|
+
readonly form?: ConfigPageForm | undefined
|
|
1495
|
+
}
|
|
1496
|
+
```
|
|
1497
|
+
|
|
1498
|
+
Already occupied by: client-ui-settings-agent-loop AgentLoopCard id 'agent-loop'; client-ui-settings-shell ShellCard id 'shell'; client-ui-settings-subagent SubagentCard id 'subagent'; client-ui-settings-web-search WebSearchCard id 'web-search'. Replace risk: `none`.
|
|
1499
|
+
|
|
1500
|
+
Example:
|
|
1501
|
+
|
|
1502
|
+
```js
|
|
1503
|
+
return {
|
|
1504
|
+
inject: ['slots'],
|
|
1505
|
+
apply(ctx) {
|
|
1506
|
+
ctx.slots.inject('plugins.item', () => ctx.slots.register(
|
|
1507
|
+
{ name: 'plugins.item', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1508
|
+
() => React.createElement('div', null, 'hello'),
|
|
1509
|
+
))
|
|
1510
|
+
},
|
|
1511
|
+
}
|
|
1512
|
+
```
|
|
1513
|
+
|
|
1514
|
+
### `plugins.row.config`
|
|
1515
|
+
|
|
1516
|
+
Kind `keyed`, scope `root`. The configuration of one row a bundle declares, keyed by `<package name>#<row id>` with the row id as the bundle's patch declares it: the row on the bundle's page gains a configure control that opens the entry's page, headed by the plugin's display title and description.
|
|
1517
|
+
|
|
1518
|
+
The configuration of one row a bundle declares, keyed by
|
|
1519
|
+
`<package name>#<row id>` with the row id as the bundle's patch declares
|
|
1520
|
+
it: the row on the bundle's page gains a configure control that opens
|
|
1521
|
+
the entry's page, headed by the plugin's display title and description.
|
|
1522
|
+
An absent description falls back to the entry's `view: 'summary'`.
|
|
1523
|
+
|
|
1524
|
+
Register options:
|
|
1525
|
+
|
|
1526
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
1527
|
+
|
|
1528
|
+
Props your component receives:
|
|
1529
|
+
|
|
1530
|
+
```ts
|
|
1531
|
+
/** The view the page asks a configuration entry for. */
|
|
1532
|
+
export interface PluginConfigViewProps {
|
|
1533
|
+
/** `summary` renders the one-liner alone, as text or inline nodes; `page` renders the form with its save control. */
|
|
1534
|
+
readonly view: 'summary' | 'page'
|
|
1535
|
+
/** Host-owned configuration values and write actions for this page's entry. */
|
|
1536
|
+
readonly form?: ConfigPageForm | undefined
|
|
1537
|
+
}
|
|
1538
|
+
```
|
|
1539
|
+
|
|
1540
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
1541
|
+
|
|
1542
|
+
Example:
|
|
1543
|
+
|
|
1544
|
+
```js
|
|
1545
|
+
return {
|
|
1546
|
+
inject: ['slots'],
|
|
1547
|
+
apply(ctx) {
|
|
1548
|
+
ctx.slots.inject('plugins.row.config', () => ctx.slots.register(
|
|
1549
|
+
{ name: 'plugins.row.config', key: '<one key the owner dispatches>' },
|
|
1550
|
+
() => React.createElement('div', null, 'hello'),
|
|
1551
|
+
))
|
|
1552
|
+
},
|
|
1553
|
+
}
|
|
1554
|
+
```
|
|
1555
|
+
|
|
1556
|
+
### `rightbar`
|
|
1557
|
+
|
|
1558
|
+
Kind `single`, scope `root`. The right column: a track the centre makes room for, or nothing.
|
|
1559
|
+
|
|
1560
|
+
The right column: a track the centre makes room for, or nothing. OCCUPIED
|
|
1561
|
+
by the right Sidebar, which uses the resolved column width in normal
|
|
1562
|
+
mode and covers the viewport in fullscreen, retaining the wide-screen
|
|
1563
|
+
column reservation underneath.
|
|
1564
|
+
|
|
1565
|
+
Whether the panel is shown, and whether it takes a track, is the
|
|
1566
|
+
occupant's own recorded business - it reports the composition of its
|
|
1567
|
+
expanded and presentation state through `ctx.layout`, and the frame sizes
|
|
1568
|
+
the track and places the resize handle from that. The expand control is
|
|
1569
|
+
not this column's: it is a button in the conversation header. The root
|
|
1570
|
+
occupant decides when to render its Session-bound content.
|
|
1571
|
+
|
|
1572
|
+
Props your component receives:
|
|
1573
|
+
|
|
1574
|
+
```ts
|
|
1575
|
+
/** Right column owner share: resolved normal geometry and opening eligibility. */
|
|
1576
|
+
export interface RightbarOwnerProps {
|
|
1577
|
+
/** Resolved normal panel width in px, not the saved preference; zero if it cannot fit. */
|
|
1578
|
+
width: number
|
|
1579
|
+
/** Current frame width in px. */
|
|
1580
|
+
viewportWidth: number
|
|
1581
|
+
/**
|
|
1582
|
+
* Whether a normal right panel can retain 300px beside a 400px center.
|
|
1583
|
+
* Before a narrow opening, includes the space from collapsing the left sidebar.
|
|
1584
|
+
*/
|
|
1585
|
+
canShow: boolean
|
|
1586
|
+
}
|
|
1587
|
+
```
|
|
1588
|
+
|
|
1589
|
+
Already occupied by: client-ui-sidebar-right RightbarRoot. Replace risk: `shadows-shipped-ui`.
|
|
1590
|
+
|
|
1591
|
+
Example:
|
|
1592
|
+
|
|
1593
|
+
```js
|
|
1594
|
+
return {
|
|
1595
|
+
inject: ['slots'],
|
|
1596
|
+
apply(ctx) {
|
|
1597
|
+
ctx.slots.inject('rightbar', () => ctx.slots.register(
|
|
1598
|
+
{ name: 'rightbar' },
|
|
1599
|
+
() => React.createElement('div', null, 'hello'),
|
|
1600
|
+
))
|
|
1601
|
+
},
|
|
1602
|
+
}
|
|
1603
|
+
```
|
|
1604
|
+
|
|
1605
|
+
### `rightbar.session`
|
|
1606
|
+
|
|
1607
|
+
Kind `single`, scope `session`. Session content selected by the root-scoped right Sidebar controller.
|
|
1608
|
+
|
|
1609
|
+
Props your component receives:
|
|
1610
|
+
|
|
1611
|
+
```ts
|
|
1612
|
+
/** Right column owner share: resolved normal geometry and opening eligibility. */
|
|
1613
|
+
export interface RightbarOwnerProps {
|
|
1614
|
+
/** Resolved normal panel width in px, not the saved preference; zero if it cannot fit. */
|
|
1615
|
+
width: number
|
|
1616
|
+
/** Current frame width in px. */
|
|
1617
|
+
viewportWidth: number
|
|
1618
|
+
/**
|
|
1619
|
+
* Whether a normal right panel can retain 300px beside a 400px center.
|
|
1620
|
+
* Before a narrow opening, includes the space from collapsing the left sidebar.
|
|
1621
|
+
*/
|
|
1622
|
+
canShow: boolean
|
|
1623
|
+
}
|
|
1624
|
+
|
|
1625
|
+
/** Identity of one open tab; distinct copies of one content share `contentId`, never `TabId`. */
|
|
1626
|
+
export type TabId = Branded<'TabId'>
|
|
1627
|
+
```
|
|
1628
|
+
|
|
1629
|
+
Already occupied by: client-ui-sidebar-right RightbarSeat. Replace risk: `shadows-shipped-ui`.
|
|
1630
|
+
|
|
1631
|
+
Example:
|
|
1632
|
+
|
|
1633
|
+
```js
|
|
1634
|
+
return {
|
|
1635
|
+
inject: ['slots'],
|
|
1636
|
+
apply(ctx) {
|
|
1637
|
+
ctx.slots.inject('rightbar.session', () => ctx.slots.register(
|
|
1638
|
+
{ name: 'rightbar.session' },
|
|
1639
|
+
() => React.createElement('div', null, 'hello'),
|
|
1640
|
+
))
|
|
1641
|
+
},
|
|
1642
|
+
}
|
|
1643
|
+
```
|
|
1644
|
+
|
|
1645
|
+
### `root`
|
|
1646
|
+
|
|
1647
|
+
Kind `single`, scope `root`. The built-in render-tree root hole (seeded by SlotCore): the one slot the shell itself renders, and the ancestor of every other seat.
|
|
1648
|
+
|
|
1649
|
+
The built-in render-tree root hole (seeded by SlotCore): the one slot the
|
|
1650
|
+
shell itself renders, and the ancestor of every other seat. OCCUPIED by
|
|
1651
|
+
ui-layout's AppFrame, which declares the sidebar, conversation, details,
|
|
1652
|
+
and shell.overlay seats inside it.
|
|
1653
|
+
|
|
1654
|
+
DO NOT register here. This is a single slot, so a second entry does not
|
|
1655
|
+
sit beside the frame - it shadows it, and a dynamically registered entry
|
|
1656
|
+
is assigned a lower priority than the shipped one, which makes it the
|
|
1657
|
+
winner: the page would render your component alone, with every seat the
|
|
1658
|
+
frame declares gone. For a surface of your own that floats over the whole
|
|
1659
|
+
app, register into `shell.overlay` instead (a list slot: additive, and
|
|
1660
|
+
click-through until your entry opts into pointer events).
|
|
1661
|
+
|
|
1662
|
+
Props your component receives:
|
|
1663
|
+
|
|
1664
|
+
```ts
|
|
1665
|
+
/** Root owner share: the shell supplies nothing - the frame is inject-assembled. */
|
|
1666
|
+
export interface RootOwnerProps { children?: never }
|
|
1667
|
+
```
|
|
1668
|
+
|
|
1669
|
+
Already occupied by: client-ui-layout AppFrame. Replace risk: `shadows-shipped-ui`.
|
|
1670
|
+
|
|
1671
|
+
Example:
|
|
1672
|
+
|
|
1673
|
+
```js
|
|
1674
|
+
return {
|
|
1675
|
+
inject: ['slots'],
|
|
1676
|
+
apply(ctx) {
|
|
1677
|
+
ctx.slots.inject('root', () => ctx.slots.register(
|
|
1678
|
+
{ name: 'root' },
|
|
1679
|
+
() => React.createElement('div', null, 'hello'),
|
|
1680
|
+
))
|
|
1681
|
+
},
|
|
1682
|
+
}
|
|
1683
|
+
```
|
|
1684
|
+
|
|
1685
|
+
### `settings.action`
|
|
1686
|
+
|
|
1687
|
+
Kind `list`, scope `root`. Optional actions rendered in the content-column header before Close.
|
|
1688
|
+
|
|
1689
|
+
Optional actions rendered in the content-column header before Close.
|
|
1690
|
+
Registrants own visibility, behavior, copy, and failure presentation;
|
|
1691
|
+
the shell supplies only the ordered render site.
|
|
1692
|
+
|
|
1693
|
+
Register options:
|
|
1694
|
+
|
|
1695
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1696
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1697
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1698
|
+
|
|
1699
|
+
Props your component receives:
|
|
1700
|
+
|
|
1701
|
+
```ts
|
|
1702
|
+
/** Owner share of the header title seat (the shell supplies nothing). */
|
|
1703
|
+
export interface SettingsHeaderOwnerProps {
|
|
1704
|
+
/** Marker field: header owner props are intentionally empty. */
|
|
1705
|
+
children?: never
|
|
1706
|
+
}
|
|
1707
|
+
```
|
|
1708
|
+
|
|
1709
|
+
Already occupied by: client-ui-settings-general SettingsDocumentAction id 'open-document'. Replace risk: `none`.
|
|
1710
|
+
|
|
1711
|
+
Example:
|
|
1712
|
+
|
|
1713
|
+
```js
|
|
1714
|
+
return {
|
|
1715
|
+
inject: ['slots'],
|
|
1716
|
+
apply(ctx) {
|
|
1717
|
+
ctx.slots.inject('settings.action', () => ctx.slots.register(
|
|
1718
|
+
{ name: 'settings.action', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1719
|
+
() => React.createElement('div', null, 'hello'),
|
|
1720
|
+
))
|
|
1721
|
+
},
|
|
1722
|
+
}
|
|
1723
|
+
```
|
|
1724
|
+
|
|
1725
|
+
### `settings.close`
|
|
1726
|
+
|
|
1727
|
+
Kind `single`, scope `root`. The close button's visually-hidden label text (the button itself - icon, geometry, focus - is shell chrome).
|
|
1728
|
+
|
|
1729
|
+
The close button's visually-hidden label text (the button itself -
|
|
1730
|
+
icon, geometry, focus - is shell chrome). Absent contribution leaves
|
|
1731
|
+
the button without an accessible name (broken-composition state).
|
|
1732
|
+
|
|
1733
|
+
Props your component receives:
|
|
1734
|
+
|
|
1735
|
+
```ts
|
|
1736
|
+
/** Owner share of the header title seat (the shell supplies nothing). */
|
|
1737
|
+
export interface SettingsHeaderOwnerProps {
|
|
1738
|
+
/** Marker field: header owner props are intentionally empty. */
|
|
1739
|
+
children?: never
|
|
1740
|
+
}
|
|
1741
|
+
```
|
|
1742
|
+
|
|
1743
|
+
Already occupied by: client-ui-settings-general CloseLabel. Replace risk: `shadows-shipped-ui`.
|
|
1744
|
+
|
|
1745
|
+
Example:
|
|
1746
|
+
|
|
1747
|
+
```js
|
|
1748
|
+
return {
|
|
1749
|
+
inject: ['slots'],
|
|
1750
|
+
apply(ctx) {
|
|
1751
|
+
ctx.slots.inject('settings.close', () => ctx.slots.register(
|
|
1752
|
+
{ name: 'settings.close' },
|
|
1753
|
+
() => React.createElement('div', null, 'hello'),
|
|
1754
|
+
))
|
|
1755
|
+
},
|
|
1756
|
+
}
|
|
1757
|
+
```
|
|
1758
|
+
|
|
1759
|
+
### `settings.general.item`
|
|
1760
|
+
|
|
1761
|
+
Kind `list`, scope `root`. One preference row inside the General section - the additive seat for a single setting that needs no page of its own (a whole page is `settings.section`), contributed by the feature plugin that owns the preference (locale → Language, ui-theme → Appearance, ui-conversation → Composer Enter).
|
|
1762
|
+
|
|
1763
|
+
One preference row inside the General section - the additive seat for a
|
|
1764
|
+
single setting that needs no page of its own (a whole page is
|
|
1765
|
+
`settings.section`), contributed by the feature plugin that owns the
|
|
1766
|
+
preference (locale → Language, ui-theme → Appearance, ui-conversation →
|
|
1767
|
+
Composer Enter). Options: `id` (row key), `order` (row position). The
|
|
1768
|
+
section column only stacks rows, so a row draws its own internals,
|
|
1769
|
+
including its label: nothing projects a `label` here and the owner passes
|
|
1770
|
+
no props at all - copy, current value, and the write path are all yours,
|
|
1771
|
+
through your own inject face and `host.call`. Declared at runtime by
|
|
1772
|
+
ui-settings-general's General entry; the type lives here with every other
|
|
1773
|
+
settings slot type, because this package is the settings domain's base
|
|
1774
|
+
layer and every registrant already depends on it for `ctx.configForms`.
|
|
1775
|
+
|
|
1776
|
+
Register options:
|
|
1777
|
+
|
|
1778
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1779
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1780
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1781
|
+
|
|
1782
|
+
Props your component receives:
|
|
1783
|
+
|
|
1784
|
+
```ts
|
|
1785
|
+
/** Owner share of a General preference row (the section supplies nothing). */
|
|
1786
|
+
export interface SettingsGeneralItemOwnerProps {
|
|
1787
|
+
/** Marker field: item owner props are intentionally empty. */
|
|
1788
|
+
children?: never
|
|
1789
|
+
}
|
|
1790
|
+
```
|
|
1791
|
+
|
|
1792
|
+
Already occupied by: client-locale LanguageRow id 'language'; client-ui-chat LinkOpeningRow id 'link-opening'; client-ui-chat PerformanceUsageRow id 'performance-usage'; client-ui-chat TranscriptViewRow id 'transcript-view'; client-ui-conversation EnterBehaviorRow id 'composer-enter'; client-ui-permission-presets PermissionRow id 'permission'; client-ui-settings-general DeveloperToolsRow id 'developer-tools'; client-ui-settings-general CurrentVersionRow id 'current-version'; client-ui-settings-session-log UploadRow; client-ui-shortcuts ShortcutsRow id 'shortcuts'; client-ui-theme AppearanceRow id 'appearance'; client-ui-theme FontSizeRow id 'font-size'. Replace risk: `none`.
|
|
1793
|
+
|
|
1794
|
+
Example:
|
|
1795
|
+
|
|
1796
|
+
```js
|
|
1797
|
+
return {
|
|
1798
|
+
inject: ['slots'],
|
|
1799
|
+
apply(ctx) {
|
|
1800
|
+
ctx.slots.inject('settings.general.item', () => ctx.slots.register(
|
|
1801
|
+
{ name: 'settings.general.item', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1802
|
+
() => React.createElement('div', null, 'hello'),
|
|
1803
|
+
))
|
|
1804
|
+
},
|
|
1805
|
+
}
|
|
1806
|
+
```
|
|
1807
|
+
|
|
1808
|
+
### `settings.header`
|
|
1809
|
+
|
|
1810
|
+
Kind `single`, scope `root`. The panel title text seat.
|
|
1811
|
+
|
|
1812
|
+
The panel title text seat. Content renders inside the nav heading row;
|
|
1813
|
+
the dialog's accessible name points at that node via aria-labelledby.
|
|
1814
|
+
Absent contribution leaves the heading empty.
|
|
1815
|
+
|
|
1816
|
+
Props your component receives:
|
|
1817
|
+
|
|
1818
|
+
```ts
|
|
1819
|
+
/** Owner share of the header title seat (the shell supplies nothing). */
|
|
1820
|
+
export interface SettingsHeaderOwnerProps {
|
|
1821
|
+
/** Marker field: header owner props are intentionally empty. */
|
|
1822
|
+
children?: never
|
|
1823
|
+
}
|
|
1824
|
+
```
|
|
1825
|
+
|
|
1826
|
+
Already occupied by: client-ui-settings-general HeaderContent. Replace risk: `shadows-shipped-ui`.
|
|
1827
|
+
|
|
1828
|
+
Example:
|
|
1829
|
+
|
|
1830
|
+
```js
|
|
1831
|
+
return {
|
|
1832
|
+
inject: ['slots'],
|
|
1833
|
+
apply(ctx) {
|
|
1834
|
+
ctx.slots.inject('settings.header', () => ctx.slots.register(
|
|
1835
|
+
{ name: 'settings.header' },
|
|
1836
|
+
() => React.createElement('div', null, 'hello'),
|
|
1837
|
+
))
|
|
1838
|
+
},
|
|
1839
|
+
}
|
|
1840
|
+
```
|
|
1841
|
+
|
|
1842
|
+
### `settings.launcher`
|
|
1843
|
+
|
|
1844
|
+
Kind `single`, scope `root`. Optional sidebar account launcher; opens the shell-owned settings panel.
|
|
1845
|
+
|
|
1846
|
+
Props your component receives:
|
|
1847
|
+
|
|
1848
|
+
```ts
|
|
1849
|
+
/** Sidebar launcher geometry and settings navigation. */
|
|
1850
|
+
export interface SettingsLauncherOwnerProps {
|
|
1851
|
+
/** Whether the sidebar shows labels. */
|
|
1852
|
+
wide: boolean
|
|
1853
|
+
/** Whether the settings dialog covers the sidebar; a launcher may treat a false-to-true edge as one Settings entry. */
|
|
1854
|
+
settingsOpen: boolean
|
|
1855
|
+
/** Effective Settings key labels and accessible combination; omitted when unbound. */
|
|
1856
|
+
settingsShortcut?: { readonly keys: readonly string[]; readonly aria?: string | undefined }
|
|
1857
|
+
/** Open the settings panel. */
|
|
1858
|
+
openSettings: () => void
|
|
1859
|
+
/** @param id - registered onboarding editor to open explicitly. */
|
|
1860
|
+
openOnboarding: (id: string) => void
|
|
1861
|
+
}
|
|
1862
|
+
```
|
|
1863
|
+
|
|
1864
|
+
Already occupied by: client-ui-settings-account AccountMenu. Replace risk: `shadows-shipped-ui`.
|
|
1865
|
+
|
|
1866
|
+
Example:
|
|
1867
|
+
|
|
1868
|
+
```js
|
|
1869
|
+
return {
|
|
1870
|
+
inject: ['slots'],
|
|
1871
|
+
apply(ctx) {
|
|
1872
|
+
ctx.slots.inject('settings.launcher', () => ctx.slots.register(
|
|
1873
|
+
{ name: 'settings.launcher' },
|
|
1874
|
+
() => React.createElement('div', null, 'hello'),
|
|
1875
|
+
))
|
|
1876
|
+
},
|
|
1877
|
+
}
|
|
1878
|
+
```
|
|
1879
|
+
|
|
1880
|
+
### `settings.models.footer`
|
|
1881
|
+
|
|
1882
|
+
Kind `list`, scope `root`. Ordered extension area after the provider rows and the add controls.
|
|
1883
|
+
|
|
1884
|
+
Ordered extension area after the provider rows and the add controls.
|
|
1885
|
+
Without a registrant the area renders nothing.
|
|
1886
|
+
|
|
1887
|
+
Register options:
|
|
1888
|
+
|
|
1889
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1890
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1891
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
1892
|
+
|
|
1893
|
+
Props your component receives:
|
|
1894
|
+
|
|
1895
|
+
```ts
|
|
1896
|
+
/** Owner share of the footer area (the section supplies nothing). */
|
|
1897
|
+
export interface ModelsFooterOwnerProps {
|
|
1898
|
+
/** Marker field: footer owner props are intentionally empty. */
|
|
1899
|
+
children?: never
|
|
1900
|
+
}
|
|
1901
|
+
```
|
|
1902
|
+
|
|
1903
|
+
Example:
|
|
1904
|
+
|
|
1905
|
+
```js
|
|
1906
|
+
return {
|
|
1907
|
+
inject: ['slots'],
|
|
1908
|
+
apply(ctx) {
|
|
1909
|
+
ctx.slots.inject('settings.models.footer', () => ctx.slots.register(
|
|
1910
|
+
{ name: 'settings.models.footer', id: 'my-entry', order: 100, label: 'My entry' },
|
|
1911
|
+
() => React.createElement('div', null, 'hello'),
|
|
1912
|
+
))
|
|
1913
|
+
},
|
|
1914
|
+
}
|
|
1915
|
+
```
|
|
1916
|
+
|
|
1917
|
+
### `settings.models.provider-card`
|
|
1918
|
+
|
|
1919
|
+
Kind `keyed`, scope `root`. One provider card's adapter extension area, dispatched with `entryKey = settingsNs` on every card that renders a directory row: a saved row's card (its first-run setup posture included) and the add-provider draft card.
|
|
1920
|
+
|
|
1921
|
+
One provider card's adapter extension area, dispatched with
|
|
1922
|
+
`entryKey = settingsNs` on every card that renders a directory row: a
|
|
1923
|
+
saved row's card (its first-run setup posture included) and the
|
|
1924
|
+
add-provider draft card. The hand-declared draft card has no directory
|
|
1925
|
+
row yet, so it dispatches nothing until saved. Without a registrant the
|
|
1926
|
+
area renders nothing.
|
|
1927
|
+
|
|
1928
|
+
Register options:
|
|
1929
|
+
|
|
1930
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
1931
|
+
|
|
1932
|
+
Props your component receives:
|
|
1933
|
+
|
|
1934
|
+
```ts
|
|
1935
|
+
/** Owner share of one provider-card extension occurrence. */
|
|
1936
|
+
export interface ProviderCardExtrasOwnerProps {
|
|
1937
|
+
/** The card's directory row (route id, display name, settings address, live state). */
|
|
1938
|
+
provider: ProviderDirectoryEntry
|
|
1939
|
+
/** Whether any layer configures this provider (its profile resolves); `false` while the add-provider draft edits a dormant row. */
|
|
1940
|
+
configured: boolean
|
|
1941
|
+
/** Whether the row's referenced api-key credential is confirmed configured (the page's credential join). */
|
|
1942
|
+
keyConfigured: boolean
|
|
1943
|
+
}
|
|
1944
|
+
```
|
|
1945
|
+
|
|
1946
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
1947
|
+
|
|
1948
|
+
Example:
|
|
1949
|
+
|
|
1950
|
+
```js
|
|
1951
|
+
return {
|
|
1952
|
+
inject: ['slots'],
|
|
1953
|
+
apply(ctx) {
|
|
1954
|
+
ctx.slots.inject('settings.models.provider-card', () => ctx.slots.register(
|
|
1955
|
+
{ name: 'settings.models.provider-card', key: '<one key the owner dispatches>' },
|
|
1956
|
+
() => React.createElement('div', null, 'hello'),
|
|
1957
|
+
))
|
|
1958
|
+
},
|
|
1959
|
+
}
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
### `settings.models.sign-in`
|
|
1963
|
+
|
|
1964
|
+
Kind `single`, scope `root`. Optional account login choice before the credential editor.
|
|
1965
|
+
|
|
1966
|
+
Already occupied by: client-ui-settings-account AccountOnboarding. Replace risk: `shadows-shipped-ui`.
|
|
1967
|
+
|
|
1968
|
+
Example:
|
|
1969
|
+
|
|
1970
|
+
```js
|
|
1971
|
+
return {
|
|
1972
|
+
inject: ['slots'],
|
|
1973
|
+
apply(ctx) {
|
|
1974
|
+
ctx.slots.inject('settings.models.sign-in', () => ctx.slots.register(
|
|
1975
|
+
{ name: 'settings.models.sign-in' },
|
|
1976
|
+
() => React.createElement('div', null, 'hello'),
|
|
1977
|
+
))
|
|
1978
|
+
},
|
|
1979
|
+
}
|
|
1980
|
+
```
|
|
1981
|
+
|
|
1982
|
+
### `settings.onboarding`
|
|
1983
|
+
|
|
1984
|
+
Kind `list`, scope `root`. Root-scoped onboarding steps contributed by settings features.
|
|
1985
|
+
|
|
1986
|
+
Root-scoped onboarding steps contributed by settings features. The
|
|
1987
|
+
shell mounts one ordered step at a time; the active registrant either
|
|
1988
|
+
completes itself or keeps ownership until the user completes its sole
|
|
1989
|
+
path. Registrants own readiness, copy, dialog behavior, AND visible
|
|
1990
|
+
chrome: a step wraps its visible content in its modal surface (including
|
|
1991
|
+
`#root` inert ownership) and renders null while private facts are still
|
|
1992
|
+
loading. The shell paints no chrome of its own, so a mounted-but-deciding
|
|
1993
|
+
step shows and blocks nothing.
|
|
1994
|
+
|
|
1995
|
+
Register options:
|
|
1996
|
+
|
|
1997
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
1998
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
1999
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2000
|
+
|
|
2001
|
+
Props your component receives:
|
|
2002
|
+
|
|
2003
|
+
```ts
|
|
2004
|
+
/** Owner share of the currently active settings-backed onboarding step. */
|
|
2005
|
+
export interface SettingsOnboardingOwnerProps {
|
|
2006
|
+
/** Stable id of the step currently selected by the coordinator. */
|
|
2007
|
+
stepId: string
|
|
2008
|
+
/** User explicitly reopened this step outside first-run onboarding. */
|
|
2009
|
+
explicit?: boolean
|
|
2010
|
+
/** Complete or skip this step and transfer ownership to the next entry. */
|
|
2011
|
+
complete: () => void
|
|
2012
|
+
/** Open the settings panel directly on one registered section. */
|
|
2013
|
+
openSection: (id: string) => void
|
|
2014
|
+
}
|
|
2015
|
+
```
|
|
2016
|
+
|
|
2017
|
+
Already occupied by: client-ui-settings-models WelcomeNotice id 'welcome-notice'; client-ui-settings-models DeepSeekOnboardingDialog id 'deepseek-official'. Replace risk: `none`.
|
|
2018
|
+
|
|
2019
|
+
Example:
|
|
2020
|
+
|
|
2021
|
+
```js
|
|
2022
|
+
return {
|
|
2023
|
+
inject: ['slots'],
|
|
2024
|
+
apply(ctx) {
|
|
2025
|
+
ctx.slots.inject('settings.onboarding', () => ctx.slots.register(
|
|
2026
|
+
{ name: 'settings.onboarding', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2027
|
+
() => React.createElement('div', null, 'hello'),
|
|
2028
|
+
))
|
|
2029
|
+
},
|
|
2030
|
+
}
|
|
2031
|
+
```
|
|
2032
|
+
|
|
2033
|
+
### `settings.plugins.tab`
|
|
2034
|
+
|
|
2035
|
+
Kind `list`, scope `root`. One page inside the Plugins settings section.
|
|
2036
|
+
|
|
2037
|
+
One page inside the Plugins settings section. The section owner renders
|
|
2038
|
+
localized entry labels as tabs and mounts each contribution inside its
|
|
2039
|
+
corresponding tab panel. Options: `id` (tab key), `order` (tab order),
|
|
2040
|
+
and `label` (registrant-localized tab text). Declared at runtime by the
|
|
2041
|
+
feature that owns the Plugins section; the type lives here so inventory
|
|
2042
|
+
and configuration plugins collaborate without depending on one another.
|
|
2043
|
+
|
|
2044
|
+
Register options:
|
|
2045
|
+
|
|
2046
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2047
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2048
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2049
|
+
|
|
2050
|
+
Props your component receives:
|
|
2051
|
+
|
|
2052
|
+
```ts
|
|
2053
|
+
/** Owner share of a Plugins tab (the section supplies nothing). */
|
|
2054
|
+
export interface SettingsPluginsTabOwnerProps {
|
|
2055
|
+
/** Marker field: tab owner props are intentionally empty. */
|
|
2056
|
+
children?: never
|
|
2057
|
+
}
|
|
2058
|
+
```
|
|
2059
|
+
|
|
2060
|
+
Already occupied by: client-ui-settings-plugin-inventory PluginInventorySettingsTab id 'all'. Replace risk: `none`.
|
|
2061
|
+
|
|
2062
|
+
Example:
|
|
2063
|
+
|
|
2064
|
+
```js
|
|
2065
|
+
return {
|
|
2066
|
+
inject: ['slots'],
|
|
2067
|
+
apply(ctx) {
|
|
2068
|
+
ctx.slots.inject('settings.plugins.tab', () => ctx.slots.register(
|
|
2069
|
+
{ name: 'settings.plugins.tab', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2070
|
+
() => React.createElement('div', null, 'hello'),
|
|
2071
|
+
))
|
|
2072
|
+
},
|
|
2073
|
+
}
|
|
2074
|
+
```
|
|
2075
|
+
|
|
2076
|
+
### `settings.section`
|
|
2077
|
+
|
|
2078
|
+
Kind `list`, scope `root`. One settings page per list entry.
|
|
2079
|
+
|
|
2080
|
+
One settings page per list entry. Registrant options carry the nav
|
|
2081
|
+
identity: `id` (section key, drives `only` filtering), `order` (nav
|
|
2082
|
+
position), `label` (registrant-localized display text - the registrant
|
|
2083
|
+
re-registers with fresh text on locale change, so the shell never
|
|
2084
|
+
subscribes locale state; the ledger bump doubles as the shell's
|
|
2085
|
+
re-render trigger). Sections render inside the panel content column.
|
|
2086
|
+
(`settings.general.item`, declared by ui-settings-general's General
|
|
2087
|
+
entry, is typed in the locale package - the common dependency of every
|
|
2088
|
+
item registrant; the shell neither declares nor renders it.)
|
|
2089
|
+
|
|
2090
|
+
Register options:
|
|
2091
|
+
|
|
2092
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2093
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2094
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2095
|
+
|
|
2096
|
+
Props your component receives:
|
|
2097
|
+
|
|
2098
|
+
```ts
|
|
2099
|
+
/**
|
|
2100
|
+
* Owner share of a settings section entry. The shell owns modal visibility
|
|
2101
|
+
* and navigation; a section's data arrives through its own inject faces and
|
|
2102
|
+
* stores. `close` is the one shell affordance a section receives, for flows
|
|
2103
|
+
* that leave settings altogether (starting a session from a section) - the
|
|
2104
|
+
* onboarding coordinator's `openSection`/`complete` precedent, inverted.
|
|
2105
|
+
*/
|
|
2106
|
+
export interface SettingsSectionOwnerProps {
|
|
2107
|
+
/** Close the settings panel (the shell owns the open state). */
|
|
2108
|
+
close: () => void
|
|
2109
|
+
}
|
|
2110
|
+
```
|
|
2111
|
+
|
|
2112
|
+
Already occupied by: client-ui-agent-preset AgentPresetSection id 'agent-presets'; client-ui-settings-account AccountSection id 'account'; client-ui-settings-general GeneralSection id 'general'; client-ui-settings-models ModelsSection id 'models'; client-ui-settings-plugins PluginsSettingsSection id 'plugins'. Replace risk: `none`.
|
|
2113
|
+
|
|
2114
|
+
Example:
|
|
2115
|
+
|
|
2116
|
+
```js
|
|
2117
|
+
return {
|
|
2118
|
+
inject: ['slots'],
|
|
2119
|
+
apply(ctx) {
|
|
2120
|
+
ctx.slots.inject('settings.section', () => ctx.slots.register(
|
|
2121
|
+
{ name: 'settings.section', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2122
|
+
() => React.createElement('div', null, 'hello'),
|
|
2123
|
+
))
|
|
2124
|
+
},
|
|
2125
|
+
}
|
|
2126
|
+
```
|
|
2127
|
+
|
|
2128
|
+
### `settings.trigger`
|
|
2129
|
+
|
|
2130
|
+
Kind `single`, scope `root`. The sidebar-foot trigger row content: icon + label, supplied as slot content (the accessible name comes from the content - rail state renders the label visually hidden).
|
|
2131
|
+
|
|
2132
|
+
The sidebar-foot trigger row content: icon + label, supplied as slot
|
|
2133
|
+
content (the accessible name comes from the content - rail state
|
|
2134
|
+
renders the label visually hidden). The shell renders the button
|
|
2135
|
+
chrome and owns open state. Absent contribution degrades to an
|
|
2136
|
+
icon-only button without an accessible name (broken-composition state;
|
|
2137
|
+
the shipped composition always registers the seat).
|
|
2138
|
+
|
|
2139
|
+
Props your component receives:
|
|
2140
|
+
|
|
2141
|
+
```ts
|
|
2142
|
+
/** Owner share of the trigger content seat: the sidebar column state. */
|
|
2143
|
+
export interface SettingsTriggerOwnerProps {
|
|
2144
|
+
/** Whether the sidebar renders wide content (false = 56px rail, icon only). */
|
|
2145
|
+
wide: boolean
|
|
2146
|
+
}
|
|
2147
|
+
```
|
|
2148
|
+
|
|
2149
|
+
Already occupied by: client-ui-settings-general TriggerContent. Replace risk: `shadows-shipped-ui`.
|
|
2150
|
+
|
|
2151
|
+
Example:
|
|
2152
|
+
|
|
2153
|
+
```js
|
|
2154
|
+
return {
|
|
2155
|
+
inject: ['slots'],
|
|
2156
|
+
apply(ctx) {
|
|
2157
|
+
ctx.slots.inject('settings.trigger', () => ctx.slots.register(
|
|
2158
|
+
{ name: 'settings.trigger' },
|
|
2159
|
+
() => React.createElement('div', null, 'hello'),
|
|
2160
|
+
))
|
|
2161
|
+
},
|
|
2162
|
+
}
|
|
2163
|
+
```
|
|
2164
|
+
|
|
2165
|
+
### `shell.leading`
|
|
2166
|
+
|
|
2167
|
+
Kind `single`, scope `root`. Window-chrome seat at the frame's top-left, over every main panel.
|
|
2168
|
+
|
|
2169
|
+
Window-chrome seat at the frame's top-left, over every main panel.
|
|
2170
|
+
Mounted only while the sidebar column is fully hidden (macOS desktop
|
|
2171
|
+
collapse; other platforms keep the rail), so the occupant can assume the
|
|
2172
|
+
frame edge is the window edge and the macOS traffic lights sit before it.
|
|
2173
|
+
OCCUPIED by ui-sidebar's reopen/New Session controls.
|
|
2174
|
+
|
|
2175
|
+
While the seat is mounted the frame publishes
|
|
2176
|
+
`--dsh-frame-leading-clearance` (the inline inset the seat's band
|
|
2177
|
+
occupies, measured from the frame's left edge); a main panel whose
|
|
2178
|
+
content reaches the top-left corner pads by it so nothing lands under
|
|
2179
|
+
the lights or the controls.
|
|
2180
|
+
|
|
2181
|
+
Already occupied by: client-ui-sidebar HeaderLeadingControls. Replace risk: `shadows-shipped-ui`.
|
|
2182
|
+
|
|
2183
|
+
Example:
|
|
2184
|
+
|
|
2185
|
+
```js
|
|
2186
|
+
return {
|
|
2187
|
+
inject: ['slots'],
|
|
2188
|
+
apply(ctx) {
|
|
2189
|
+
ctx.slots.inject('shell.leading', () => ctx.slots.register(
|
|
2190
|
+
{ name: 'shell.leading' },
|
|
2191
|
+
() => React.createElement('div', null, 'hello'),
|
|
2192
|
+
))
|
|
2193
|
+
},
|
|
2194
|
+
}
|
|
2195
|
+
```
|
|
2196
|
+
|
|
2197
|
+
### `shell.overlay`
|
|
2198
|
+
|
|
2199
|
+
Kind `list`, scope `root`. Frame-wide floating layer, above every column and outside their scroll containers.
|
|
2200
|
+
|
|
2201
|
+
Frame-wide floating layer, above every column and outside their scroll
|
|
2202
|
+
containers. Deliberately generic and unowned by any feature: a badge, a
|
|
2203
|
+
toast stack or a status pill all belong here, and entries order among
|
|
2204
|
+
themselves. The layer itself is click-through - entries opt back into
|
|
2205
|
+
pointer events - so an occupant never blocks the app underneath.
|
|
2206
|
+
|
|
2207
|
+
This is the additive seat for a frame-wide surface of your own: a fresh
|
|
2208
|
+
`id` is added beside the shipped entries instead of replacing them.
|
|
2209
|
+
|
|
2210
|
+
Register options:
|
|
2211
|
+
|
|
2212
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2213
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2214
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2215
|
+
|
|
2216
|
+
Already occupied by: client-ui-chat QuotaNoticeHost id 'chat.quota-notice'; client-ui-plugin-manager PluginRefreshToast id 'plugin-manager.refresh-toast'; client-ui-schedule ScheduleDeleteToast id 'schedule.delete-toast'; client-ui-settings-account DesktopOnboardingEntry id 'desktop-onboarding'; client-ui-settings-account AccountPlatformHost id 'account.platform-page'; client-ui-settings-session-log UploadToast id 'session-log-upload-toast'; client-ui-shortcuts ShortcutReference id 'shortcuts'; client-ui-workspace SessionRenameDialog id 'workspace.session-rename'; client-ui-workspace SessionArchiveConfirmDialog id 'workspace.session-archive'; client-ui-workspace RowActionToast id 'workspace.row-toast'. Replace risk: `none`.
|
|
2217
|
+
|
|
2218
|
+
Example:
|
|
2219
|
+
|
|
2220
|
+
```js
|
|
2221
|
+
return {
|
|
2222
|
+
inject: ['slots'],
|
|
2223
|
+
apply(ctx) {
|
|
2224
|
+
ctx.slots.inject('shell.overlay', () => ctx.slots.register(
|
|
2225
|
+
{ name: 'shell.overlay', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2226
|
+
() => React.createElement('div', null, 'hello'),
|
|
2227
|
+
))
|
|
2228
|
+
},
|
|
2229
|
+
}
|
|
2230
|
+
```
|
|
2231
|
+
|
|
2232
|
+
### `shell.quota-notice`
|
|
2233
|
+
|
|
2234
|
+
Kind `chain`, scope `root`. Frame-wide quota notice chain.
|
|
2235
|
+
|
|
2236
|
+
Frame-wide quota notice chain. The Chat-owned host in `shell.overlay`
|
|
2237
|
+
offers the one live notice; the first entry whose selector claims its
|
|
2238
|
+
code takes over the surface, and the all-decline case renders the host's
|
|
2239
|
+
generic warning Toast. The host lives outside the Chat panel, so a notice
|
|
2240
|
+
survives switching or closing the panel that reported it.
|
|
2241
|
+
|
|
2242
|
+
Register options:
|
|
2243
|
+
|
|
2244
|
+
- `select` (required, `(owner) => unknown \| null`): Pure routing selector. Entries are tried in ascending order; the first non-null result wins and arrives as the component's `matched` prop. All-null falls through to the owner's fallback.
|
|
2245
|
+
|
|
2246
|
+
Props your component receives:
|
|
2247
|
+
|
|
2248
|
+
```ts
|
|
2249
|
+
/** Owner currency of one quota notice offered to the frame-wide chain. */
|
|
2250
|
+
export interface QuotaNoticeOwnerProps {
|
|
2251
|
+
/** Stable failure code retained in the Session log. */
|
|
2252
|
+
code: QuotaNoticeCode
|
|
2253
|
+
/** Provider-neutral notice copy in the active locale. */
|
|
2254
|
+
message: string
|
|
2255
|
+
/** Take the notice down. */
|
|
2256
|
+
dismiss: () => void
|
|
2257
|
+
/**
|
|
2258
|
+
* Prevent later quota failures from replacing this notice. Dismissal clears
|
|
2259
|
+
* all holds; releasing the last hold resumes future notices without replay.
|
|
2260
|
+
* Callers must release on unmount.
|
|
2261
|
+
* @returns idempotent release that cannot clear another hold.
|
|
2262
|
+
*/
|
|
2263
|
+
keepOpen: () => () => void
|
|
2264
|
+
}
|
|
2265
|
+
```
|
|
2266
|
+
|
|
2267
|
+
Already occupied by: client-ui-settings-account AccountQuotaNotice. Replace risk: `none`.
|
|
2268
|
+
|
|
2269
|
+
Example:
|
|
2270
|
+
|
|
2271
|
+
```js
|
|
2272
|
+
return {
|
|
2273
|
+
inject: ['slots'],
|
|
2274
|
+
apply(ctx) {
|
|
2275
|
+
ctx.slots.inject('shell.quota-notice', () => ctx.slots.register(
|
|
2276
|
+
{ name: 'shell.quota-notice', select: owner => null },
|
|
2277
|
+
() => React.createElement('div', null, 'hello'),
|
|
2278
|
+
))
|
|
2279
|
+
},
|
|
2280
|
+
}
|
|
2281
|
+
```
|
|
2282
|
+
|
|
2283
|
+
### `sidebar`
|
|
2284
|
+
|
|
2285
|
+
Kind `single`, scope `root`. The whole left column.
|
|
2286
|
+
|
|
2287
|
+
The whole left column. OCCUPIED by ui-sidebar's SidebarRoot, which
|
|
2288
|
+
declares the workspace and settings seats inside it - registering here
|
|
2289
|
+
replaces the navigation column outright rather than adding to it, and
|
|
2290
|
+
the seats it declares disappear with it. To add something to the
|
|
2291
|
+
sidebar, register into one of those inner seats instead.
|
|
2292
|
+
|
|
2293
|
+
The occupant receives the frame's live column state (collapsed, width)
|
|
2294
|
+
and is expected to render the compact control rail while collapsed.
|
|
2295
|
+
|
|
2296
|
+
Props your component receives:
|
|
2297
|
+
|
|
2298
|
+
```ts
|
|
2299
|
+
/** Sidebar owner share: live column state from the frame's concession solve. */
|
|
2300
|
+
export interface SidebarOwnerProps {
|
|
2301
|
+
/** True when the sidebar is closed (the column renders the compact control rail). */
|
|
2302
|
+
collapsed: boolean
|
|
2303
|
+
/** Rendered column width in px (SIDEBAR_COLLAPSED when collapsed). */
|
|
2304
|
+
width: number
|
|
2305
|
+
}
|
|
2306
|
+
```
|
|
2307
|
+
|
|
2308
|
+
Already occupied by: client-ui-sidebar SidebarRoot. Replace risk: `shadows-shipped-ui`.
|
|
2309
|
+
|
|
2310
|
+
Example:
|
|
2311
|
+
|
|
2312
|
+
```js
|
|
2313
|
+
return {
|
|
2314
|
+
inject: ['slots'],
|
|
2315
|
+
apply(ctx) {
|
|
2316
|
+
ctx.slots.inject('sidebar', () => ctx.slots.register(
|
|
2317
|
+
{ name: 'sidebar' },
|
|
2318
|
+
() => React.createElement('div', null, 'hello'),
|
|
2319
|
+
))
|
|
2320
|
+
},
|
|
2321
|
+
}
|
|
2322
|
+
```
|
|
2323
|
+
|
|
2324
|
+
### `sidebar.brand.mark`
|
|
2325
|
+
|
|
2326
|
+
Kind `single`, scope `root`. Brand mark rendered in the expanded brand row and collapsed rail.
|
|
2327
|
+
|
|
2328
|
+
Brand mark rendered in the expanded brand row and collapsed rail.
|
|
2329
|
+
Declared by this package's `sidebar` entry; deployments may replace
|
|
2330
|
+
the shell's fish fallback without replacing the surrounding controls.
|
|
2331
|
+
|
|
2332
|
+
Props your component receives:
|
|
2333
|
+
|
|
2334
|
+
```ts
|
|
2335
|
+
/** Geometry supplied to the sidebar brand-mark occupant. */
|
|
2336
|
+
export interface SidebarBrandMarkOwnerProps {
|
|
2337
|
+
/** Requested square edge in pixels. */
|
|
2338
|
+
size: number
|
|
2339
|
+
}
|
|
2340
|
+
```
|
|
2341
|
+
|
|
2342
|
+
Already occupied by: client-ui-brand-official OfficialBrandMark. Replace risk: `shadows-shipped-ui`.
|
|
2343
|
+
|
|
2344
|
+
Example:
|
|
2345
|
+
|
|
2346
|
+
```js
|
|
2347
|
+
return {
|
|
2348
|
+
inject: ['slots'],
|
|
2349
|
+
apply(ctx) {
|
|
2350
|
+
ctx.slots.inject('sidebar.brand.mark', () => ctx.slots.register(
|
|
2351
|
+
{ name: 'sidebar.brand.mark' },
|
|
2352
|
+
() => React.createElement('div', null, 'hello'),
|
|
2353
|
+
))
|
|
2354
|
+
},
|
|
2355
|
+
}
|
|
2356
|
+
```
|
|
2357
|
+
|
|
2358
|
+
### `sidebar.brand.name`
|
|
2359
|
+
|
|
2360
|
+
Kind `single`, scope `root`. Brand name rendered beside the expanded mark.
|
|
2361
|
+
|
|
2362
|
+
Brand name rendered beside the expanded mark. Declared by this
|
|
2363
|
+
package's `sidebar` entry; the shell supplies a generic text fallback.
|
|
2364
|
+
|
|
2365
|
+
Props your component receives:
|
|
2366
|
+
|
|
2367
|
+
```ts
|
|
2368
|
+
/** Empty owner share for the sidebar brand-name occupant. */
|
|
2369
|
+
export interface SidebarBrandNameOwnerProps {
|
|
2370
|
+
/** Marker field: the occupant owns its own content and width. */
|
|
2371
|
+
children?: never
|
|
2372
|
+
}
|
|
2373
|
+
```
|
|
2374
|
+
|
|
2375
|
+
Already occupied by: client-ui-brand-official OfficialBrandName. Replace risk: `shadows-shipped-ui`.
|
|
2376
|
+
|
|
2377
|
+
Example:
|
|
2378
|
+
|
|
2379
|
+
```js
|
|
2380
|
+
return {
|
|
2381
|
+
inject: ['slots'],
|
|
2382
|
+
apply(ctx) {
|
|
2383
|
+
ctx.slots.inject('sidebar.brand.name', () => ctx.slots.register(
|
|
2384
|
+
{ name: 'sidebar.brand.name' },
|
|
2385
|
+
() => React.createElement('div', null, 'hello'),
|
|
2386
|
+
))
|
|
2387
|
+
},
|
|
2388
|
+
}
|
|
2389
|
+
```
|
|
2390
|
+
|
|
2391
|
+
### `sidebar.chat.conversation`
|
|
2392
|
+
|
|
2393
|
+
Kind `single`, scope `session`. Session-scoped Conversation occurrence hosted by one Sidebar chat tab.
|
|
2394
|
+
|
|
2395
|
+
Already occupied by: client-ui-subagent ConversationSlotPanel. Replace risk: `shadows-shipped-ui`.
|
|
2396
|
+
|
|
2397
|
+
Example:
|
|
2398
|
+
|
|
2399
|
+
```js
|
|
2400
|
+
return {
|
|
2401
|
+
inject: ['slots'],
|
|
2402
|
+
apply(ctx) {
|
|
2403
|
+
ctx.slots.inject('sidebar.chat.conversation', () => ctx.slots.register(
|
|
2404
|
+
{ name: 'sidebar.chat.conversation' },
|
|
2405
|
+
() => React.createElement('div', null, 'hello'),
|
|
2406
|
+
))
|
|
2407
|
+
},
|
|
2408
|
+
}
|
|
2409
|
+
```
|
|
2410
|
+
|
|
2411
|
+
### `sidebar.footer.action`
|
|
2412
|
+
|
|
2413
|
+
Kind `list`, scope `root`. Optional actions beside Settings at the sidebar foot.
|
|
2414
|
+
|
|
2415
|
+
Optional actions beside Settings at the sidebar foot. Declared by this
|
|
2416
|
+
package's 'sidebar' entry; each action receives only the column state.
|
|
2417
|
+
|
|
2418
|
+
Register options:
|
|
2419
|
+
|
|
2420
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2421
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2422
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2423
|
+
|
|
2424
|
+
Props your component receives:
|
|
2425
|
+
|
|
2426
|
+
```ts
|
|
2427
|
+
/** Owner share of an action rendered beside Settings at the sidebar foot. */
|
|
2428
|
+
export interface SidebarFooterActionOwnerProps {
|
|
2429
|
+
/** Whether the sidebar renders wide content (false = 56px rail). */
|
|
2430
|
+
wide: boolean
|
|
2431
|
+
}
|
|
2432
|
+
```
|
|
2433
|
+
|
|
2434
|
+
Already occupied by: client-ui-cordis CordisPanel id 'cordis-panel'. Replace risk: `none`.
|
|
2435
|
+
|
|
2436
|
+
Example:
|
|
2437
|
+
|
|
2438
|
+
```js
|
|
2439
|
+
return {
|
|
2440
|
+
inject: ['slots'],
|
|
2441
|
+
apply(ctx) {
|
|
2442
|
+
ctx.slots.inject('sidebar.footer.action', () => ctx.slots.register(
|
|
2443
|
+
{ name: 'sidebar.footer.action', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2444
|
+
() => React.createElement('div', null, 'hello'),
|
|
2445
|
+
))
|
|
2446
|
+
},
|
|
2447
|
+
}
|
|
2448
|
+
```
|
|
2449
|
+
|
|
2450
|
+
### `sidebar.panellist`
|
|
2451
|
+
|
|
2452
|
+
Kind `list`, scope `root`. Global panel icons.
|
|
2453
|
+
|
|
2454
|
+
Global panel icons. Each list id addresses the matching main panel;
|
|
2455
|
+
the sidebar owns the button and resolves its label from list metadata.
|
|
2456
|
+
|
|
2457
|
+
Register options:
|
|
2458
|
+
|
|
2459
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2460
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2461
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2462
|
+
|
|
2463
|
+
Props your component receives:
|
|
2464
|
+
|
|
2465
|
+
```ts
|
|
2466
|
+
/** Icon presentation supplied by the global panel row. */
|
|
2467
|
+
export interface SidebarPanelIconOwnerProps {
|
|
2468
|
+
/** Requested square edge in pixels. */
|
|
2469
|
+
size: number
|
|
2470
|
+
/** Whether this panel is selected in the main column. */
|
|
2471
|
+
active: boolean
|
|
2472
|
+
}
|
|
2473
|
+
```
|
|
2474
|
+
|
|
2475
|
+
Already occupied by: client-ui-plugin-manager PluginsPanelIcon; client-ui-schedule TaskManagerIcon. Replace risk: `none`.
|
|
2476
|
+
|
|
2477
|
+
Example:
|
|
2478
|
+
|
|
2479
|
+
```js
|
|
2480
|
+
return {
|
|
2481
|
+
inject: ['slots'],
|
|
2482
|
+
apply(ctx) {
|
|
2483
|
+
ctx.slots.inject('sidebar.panellist', () => ctx.slots.register(
|
|
2484
|
+
{ name: 'sidebar.panellist', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2485
|
+
() => React.createElement('div', null, 'hello'),
|
|
2486
|
+
))
|
|
2487
|
+
},
|
|
2488
|
+
}
|
|
2489
|
+
```
|
|
2490
|
+
|
|
2491
|
+
### `sidebar.right.pane.tab`
|
|
2492
|
+
|
|
2493
|
+
Kind `keyed`, scope `session`. One tab's body, dispatched with the `id` of the type in force for `tab.kind`.
|
|
2494
|
+
|
|
2495
|
+
One tab's body, dispatched with the `id` of the type in force for
|
|
2496
|
+
`tab.kind`. A tab type registers here under its definition's `id` and
|
|
2497
|
+
receives every tab of that kind, in every pane, docked or floating. A kind
|
|
2498
|
+
with no type in force renders the owner's "nothing can view this" notice
|
|
2499
|
+
rather than an empty pane.
|
|
2500
|
+
|
|
2501
|
+
Register options:
|
|
2502
|
+
|
|
2503
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
2504
|
+
|
|
2505
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
2506
|
+
|
|
2507
|
+
Already occupied by: client-ui-deliverables ReviewTab; client-ui-plan PlanPreview; client-ui-schedule ScheduleTaskTab; client-ui-sidebar-browser BrowserBody; client-ui-sidebar-documentpreview TextPreview; client-ui-sidebar-files FilesBody; client-ui-sidebar-right GuideBody; client-ui-sidebar-terminal LazyTerminalBody; client-ui-subagent SidebarChatTab. Replace risk: `none`.
|
|
2508
|
+
|
|
2509
|
+
Example:
|
|
2510
|
+
|
|
2511
|
+
```js
|
|
2512
|
+
return {
|
|
2513
|
+
inject: ['slots'],
|
|
2514
|
+
apply(ctx) {
|
|
2515
|
+
ctx.slots.inject('sidebar.right.pane.tab', () => ctx.slots.register(
|
|
2516
|
+
{ name: 'sidebar.right.pane.tab', key: '<one key the owner dispatches>' },
|
|
2517
|
+
() => React.createElement('div', null, 'hello'),
|
|
2518
|
+
))
|
|
2519
|
+
},
|
|
2520
|
+
}
|
|
2521
|
+
```
|
|
2522
|
+
|
|
2523
|
+
### `sidebar.right.pane.tab.title`
|
|
2524
|
+
|
|
2525
|
+
Kind `keyed`, scope `session`. A tab's title as its chip (and a floating panel's header) shows it, dispatched with the same key and information hook as the body.
|
|
2526
|
+
|
|
2527
|
+
A tab's title as its chip (and a floating panel's header) shows it,
|
|
2528
|
+
dispatched with the same key and information hook as the body. A type with a
|
|
2529
|
+
live title - a terminal named after its shell, a chat after its first
|
|
2530
|
+
line - registers here and reads its own store; one without registers
|
|
2531
|
+
nothing and the chip shows the registry's `title(address)` text captured
|
|
2532
|
+
at open time.
|
|
2533
|
+
|
|
2534
|
+
Register options:
|
|
2535
|
+
|
|
2536
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
2537
|
+
|
|
2538
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
2539
|
+
|
|
2540
|
+
Already occupied by: client-ui-plan PlanTitle; client-ui-schedule ScheduleTaskTabTitle; client-ui-sidebar-browser BrowserTitle; client-ui-sidebar-documentpreview TextTitle; client-ui-sidebar-files FilesTitle; client-ui-sidebar-right GuideTitle; client-ui-sidebar-terminal TerminalTitle. Replace risk: `none`.
|
|
2541
|
+
|
|
2542
|
+
Example:
|
|
2543
|
+
|
|
2544
|
+
```js
|
|
2545
|
+
return {
|
|
2546
|
+
inject: ['slots'],
|
|
2547
|
+
apply(ctx) {
|
|
2548
|
+
ctx.slots.inject('sidebar.right.pane.tab.title', () => ctx.slots.register(
|
|
2549
|
+
{ name: 'sidebar.right.pane.tab.title', key: '<one key the owner dispatches>' },
|
|
2550
|
+
() => React.createElement('div', null, 'hello'),
|
|
2551
|
+
))
|
|
2552
|
+
},
|
|
2553
|
+
}
|
|
2554
|
+
```
|
|
2555
|
+
|
|
2556
|
+
### `sidebar.right.tab.document`
|
|
2557
|
+
|
|
2558
|
+
Kind `keyed`, scope `session`. Document body selected by a registered implementation id.
|
|
2559
|
+
|
|
2560
|
+
Register options:
|
|
2561
|
+
|
|
2562
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
2563
|
+
|
|
2564
|
+
Props your component receives:
|
|
2565
|
+
|
|
2566
|
+
```ts
|
|
2567
|
+
/** Content and viewing inputs shared by document bodies and nested PDF presentation. */
|
|
2568
|
+
export interface DocumentBodyOwner {
|
|
2569
|
+
/** Observe a file read by this renderer. @param address - complete file resource address. */
|
|
2570
|
+
readonly addResource: (address: string) => void
|
|
2571
|
+
/** Replace this renderer's dependencies. @param addresses - complete file resource addresses. */
|
|
2572
|
+
readonly setResources: (addresses: readonly string[]) => void
|
|
2573
|
+
/** Original file address, also readable through the standard useResource hook. */
|
|
2574
|
+
readonly resourceAddress: string
|
|
2575
|
+
/** Ordinary file content or a renderer-owned loading request; text accumulates until eof. */
|
|
2576
|
+
readonly content: DocumentContent
|
|
2577
|
+
/** The document toolbar's current wrapping preference. */
|
|
2578
|
+
readonly wrap: boolean
|
|
2579
|
+
/** Report a renderer-owned scrollport; passing `null` restores the shared body as the owner. */
|
|
2580
|
+
readonly scrollportRef: RefCallback<HTMLElement>
|
|
2581
|
+
}
|
|
2582
|
+
```
|
|
2583
|
+
|
|
2584
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
2585
|
+
|
|
2586
|
+
Already occupied by: client-ui-sidebar-documentpreview CodeBody; client-ui-sidebar-documentpreview LazyExcelBody; client-ui-sidebar-documentpreview HtmlBody; client-ui-sidebar-documentpreview ImageBody; client-ui-sidebar-documentpreview MarkdownBody; client-ui-sidebar-documentpreview OfficeBody; client-ui-sidebar-documentpreview LazyPdfBody; client-ui-sidebar-documentpreview TextBody. Replace risk: `none`.
|
|
2587
|
+
|
|
2588
|
+
Example:
|
|
2589
|
+
|
|
2590
|
+
```js
|
|
2591
|
+
return {
|
|
2592
|
+
inject: ['slots'],
|
|
2593
|
+
apply(ctx) {
|
|
2594
|
+
ctx.slots.inject('sidebar.right.tab.document', () => ctx.slots.register(
|
|
2595
|
+
{ name: 'sidebar.right.tab.document', key: '<one key the owner dispatches>' },
|
|
2596
|
+
() => React.createElement('div', null, 'hello'),
|
|
2597
|
+
))
|
|
2598
|
+
},
|
|
2599
|
+
}
|
|
2600
|
+
```
|
|
2601
|
+
|
|
2602
|
+
### `sidebar.right.tab.document.action`
|
|
2603
|
+
|
|
2604
|
+
Kind `keyed`, scope `session`. Renderer-specific controls before the document toolbar's reload button.
|
|
2605
|
+
|
|
2606
|
+
Register options:
|
|
2607
|
+
|
|
2608
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
2609
|
+
|
|
2610
|
+
Props your component receives:
|
|
2611
|
+
|
|
2612
|
+
```ts
|
|
2613
|
+
/**
|
|
2614
|
+
* Ordinary file contents, or a request for the selected renderer to load its content.
|
|
2615
|
+
* Byte arrays are transient UI input, never persisted layout or Session data.
|
|
2616
|
+
*/
|
|
2617
|
+
export type DocumentContent =
|
|
2618
|
+
| { readonly kind: 'text'; readonly text: string; readonly pages: readonly DocumentTextPage[]; readonly eof: boolean }
|
|
2619
|
+
| { readonly kind: 'bytes'; readonly data: Uint8Array<ArrayBuffer> }
|
|
2620
|
+
| {
|
|
2621
|
+
readonly kind: 'renderer'
|
|
2622
|
+
/** Changes on reload or implementation replacement; retained contents belong to one revision. */
|
|
2623
|
+
readonly revision: number
|
|
2624
|
+
/** Report the displayed source version; stale revisions cannot update the owner. @param version - loaded source version. */
|
|
2625
|
+
readonly loaded: (version: string) => void
|
|
2626
|
+
/** End a failed load; a later file change can start another revision. */
|
|
2627
|
+
readonly failed: () => void
|
|
2628
|
+
/** Cancel the current load and start a new revision. */
|
|
2629
|
+
readonly reload: () => void
|
|
2630
|
+
}
|
|
2631
|
+
```
|
|
2632
|
+
|
|
2633
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
2634
|
+
|
|
2635
|
+
Already occupied by: client-ui-sidebar-documentpreview OfficeFontAction. Replace risk: `none`.
|
|
2636
|
+
|
|
2637
|
+
Example:
|
|
2638
|
+
|
|
2639
|
+
```js
|
|
2640
|
+
return {
|
|
2641
|
+
inject: ['slots'],
|
|
2642
|
+
apply(ctx) {
|
|
2643
|
+
ctx.slots.inject('sidebar.right.tab.document.action', () => ctx.slots.register(
|
|
2644
|
+
{ name: 'sidebar.right.tab.document.action', key: '<one key the owner dispatches>' },
|
|
2645
|
+
() => React.createElement('div', null, 'hello'),
|
|
2646
|
+
))
|
|
2647
|
+
},
|
|
2648
|
+
}
|
|
2649
|
+
```
|
|
2650
|
+
|
|
2651
|
+
### `sidebar.right.tab.document.actions`
|
|
2652
|
+
|
|
2653
|
+
Kind `list`, scope `session`. Header toolbar contributions acting on the previewed file, rendered after the preview's own controls once the file's Host path is known.
|
|
2654
|
+
|
|
2655
|
+
Header toolbar contributions acting on the previewed file, rendered
|
|
2656
|
+
after the preview's own controls once the file's Host path is known.
|
|
2657
|
+
|
|
2658
|
+
Register options:
|
|
2659
|
+
|
|
2660
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2661
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2662
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2663
|
+
|
|
2664
|
+
Already occupied by: client-ui-open-in-app OpenPathAction id 'open-in-app'. Replace risk: `none`.
|
|
2665
|
+
|
|
2666
|
+
Example:
|
|
2667
|
+
|
|
2668
|
+
```js
|
|
2669
|
+
return {
|
|
2670
|
+
inject: ['slots'],
|
|
2671
|
+
apply(ctx) {
|
|
2672
|
+
ctx.slots.inject('sidebar.right.tab.document.actions', () => ctx.slots.register(
|
|
2673
|
+
{ name: 'sidebar.right.tab.document.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2674
|
+
() => React.createElement('div', null, 'hello'),
|
|
2675
|
+
))
|
|
2676
|
+
},
|
|
2677
|
+
}
|
|
2678
|
+
```
|
|
2679
|
+
|
|
2680
|
+
### `sidebar.right.tab.document.office.pdf`
|
|
2681
|
+
|
|
2682
|
+
Kind `keyed`, scope `session`. PDF presentation supplied with Office-owned converted bytes.
|
|
2683
|
+
|
|
2684
|
+
Register options:
|
|
2685
|
+
|
|
2686
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
2687
|
+
|
|
2688
|
+
Props your component receives:
|
|
2689
|
+
|
|
2690
|
+
```ts
|
|
2691
|
+
/** Content and viewing inputs shared by document bodies and nested PDF presentation. */
|
|
2692
|
+
export interface DocumentBodyOwner {
|
|
2693
|
+
/** Observe a file read by this renderer. @param address - complete file resource address. */
|
|
2694
|
+
readonly addResource: (address: string) => void
|
|
2695
|
+
/** Replace this renderer's dependencies. @param addresses - complete file resource addresses. */
|
|
2696
|
+
readonly setResources: (addresses: readonly string[]) => void
|
|
2697
|
+
/** Original file address, also readable through the standard useResource hook. */
|
|
2698
|
+
readonly resourceAddress: string
|
|
2699
|
+
/** Ordinary file content or a renderer-owned loading request; text accumulates until eof. */
|
|
2700
|
+
readonly content: DocumentContent
|
|
2701
|
+
/** The document toolbar's current wrapping preference. */
|
|
2702
|
+
readonly wrap: boolean
|
|
2703
|
+
/** Report a renderer-owned scrollport; passing `null` restores the shared body as the owner. */
|
|
2704
|
+
readonly scrollportRef: RefCallback<HTMLElement>
|
|
2705
|
+
}
|
|
2706
|
+
```
|
|
2707
|
+
|
|
2708
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
2709
|
+
|
|
2710
|
+
Already occupied by: client-ui-sidebar-documentpreview LazyPdfBody. Replace risk: `none`.
|
|
2711
|
+
|
|
2712
|
+
Example:
|
|
2713
|
+
|
|
2714
|
+
```js
|
|
2715
|
+
return {
|
|
2716
|
+
inject: ['slots'],
|
|
2717
|
+
apply(ctx) {
|
|
2718
|
+
ctx.slots.inject('sidebar.right.tab.document.office.pdf', () => ctx.slots.register(
|
|
2719
|
+
{ name: 'sidebar.right.tab.document.office.pdf', key: '<one key the owner dispatches>' },
|
|
2720
|
+
() => React.createElement('div', null, 'hello'),
|
|
2721
|
+
))
|
|
2722
|
+
},
|
|
2723
|
+
}
|
|
2724
|
+
```
|
|
2725
|
+
|
|
2726
|
+
### `sidebar.right.tab.document.unpreviewable`
|
|
2727
|
+
|
|
2728
|
+
Kind `list`, scope `session`. Empty-state contributions for a file this preview cannot render, offered where Retry would stand once the file's Host path is known.
|
|
2729
|
+
|
|
2730
|
+
Empty-state contributions for a file this preview cannot render,
|
|
2731
|
+
offered where Retry would stand once the file's Host path is known.
|
|
2732
|
+
|
|
2733
|
+
Register options:
|
|
2734
|
+
|
|
2735
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2736
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2737
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2738
|
+
|
|
2739
|
+
Already occupied by: client-ui-open-in-app OpenPathEmptyAction id 'open-in-app'. Replace risk: `none`.
|
|
2740
|
+
|
|
2741
|
+
Example:
|
|
2742
|
+
|
|
2743
|
+
```js
|
|
2744
|
+
return {
|
|
2745
|
+
inject: ['slots'],
|
|
2746
|
+
apply(ctx) {
|
|
2747
|
+
ctx.slots.inject('sidebar.right.tab.document.unpreviewable', () => ctx.slots.register(
|
|
2748
|
+
{ name: 'sidebar.right.tab.document.unpreviewable', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2749
|
+
() => React.createElement('div', null, 'hello'),
|
|
2750
|
+
))
|
|
2751
|
+
},
|
|
2752
|
+
}
|
|
2753
|
+
```
|
|
2754
|
+
|
|
2755
|
+
### `sidebar.right.tab.files.actions`
|
|
2756
|
+
|
|
2757
|
+
Kind `list`, scope `session`. Workspace directory actions after the file tree's reload control.
|
|
2758
|
+
|
|
2759
|
+
Register options:
|
|
2760
|
+
|
|
2761
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2762
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2763
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2764
|
+
|
|
2765
|
+
Already occupied by: client-ui-open-in-app OpenInAppAction id 'open-in-app'. Replace risk: `none`.
|
|
2766
|
+
|
|
2767
|
+
Example:
|
|
2768
|
+
|
|
2769
|
+
```js
|
|
2770
|
+
return {
|
|
2771
|
+
inject: ['slots'],
|
|
2772
|
+
apply(ctx) {
|
|
2773
|
+
ctx.slots.inject('sidebar.right.tab.files.actions', () => ctx.slots.register(
|
|
2774
|
+
{ name: 'sidebar.right.tab.files.actions', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2775
|
+
() => React.createElement('div', null, 'hello'),
|
|
2776
|
+
))
|
|
2777
|
+
},
|
|
2778
|
+
}
|
|
2779
|
+
```
|
|
2780
|
+
|
|
2781
|
+
### `sidebar.right.tab.guide`
|
|
2782
|
+
|
|
2783
|
+
Kind `chain`, scope `session`. The guide tab's body.
|
|
2784
|
+
|
|
2785
|
+
The guide tab's body. Selectors run in chain order and the first
|
|
2786
|
+
non-declining entry replaces the shipped guide entirely; with no entry, or
|
|
2787
|
+
with every entry declining, the shipped guide renders.
|
|
2788
|
+
|
|
2789
|
+
Register options:
|
|
2790
|
+
|
|
2791
|
+
- `select` (required, `(owner) => unknown \| null`): Pure routing selector. Entries are tried in ascending order; the first non-null result wins and arrives as the component's `matched` prop. All-null falls through to the owner's fallback.
|
|
2792
|
+
|
|
2793
|
+
Example:
|
|
2794
|
+
|
|
2795
|
+
```js
|
|
2796
|
+
return {
|
|
2797
|
+
inject: ['slots'],
|
|
2798
|
+
apply(ctx) {
|
|
2799
|
+
ctx.slots.inject('sidebar.right.tab.guide', () => ctx.slots.register(
|
|
2800
|
+
{ name: 'sidebar.right.tab.guide', select: owner => null },
|
|
2801
|
+
() => React.createElement('div', null, 'hello'),
|
|
2802
|
+
))
|
|
2803
|
+
},
|
|
2804
|
+
}
|
|
2805
|
+
```
|
|
2806
|
+
|
|
2807
|
+
### `sidebar.right.tab.guide.entry`
|
|
2808
|
+
|
|
2809
|
+
Kind `keyed`, scope `session`. One provider's guide card, with the standard card as the owner's fallback.
|
|
2810
|
+
|
|
2811
|
+
Register options:
|
|
2812
|
+
|
|
2813
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
2814
|
+
|
|
2815
|
+
Props your component receives:
|
|
2816
|
+
|
|
2817
|
+
```ts
|
|
2818
|
+
/** Resolved guide copy and entry identity supplied to a provider's card renderer. */
|
|
2819
|
+
export interface SidebarRightGuideEntryOwnerProps {
|
|
2820
|
+
readonly entryId: string
|
|
2821
|
+
readonly kind: string
|
|
2822
|
+
readonly title: string
|
|
2823
|
+
readonly description?: string
|
|
2824
|
+
}
|
|
2825
|
+
```
|
|
2826
|
+
|
|
2827
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
2828
|
+
|
|
2829
|
+
Already occupied by: client-ui-sidebar-terminal TerminalGuide. Replace risk: `none`.
|
|
2830
|
+
|
|
2831
|
+
Example:
|
|
2832
|
+
|
|
2833
|
+
```js
|
|
2834
|
+
return {
|
|
2835
|
+
inject: ['slots'],
|
|
2836
|
+
apply(ctx) {
|
|
2837
|
+
ctx.slots.inject('sidebar.right.tab.guide.entry', () => ctx.slots.register(
|
|
2838
|
+
{ name: 'sidebar.right.tab.guide.entry', key: '<one key the owner dispatches>' },
|
|
2839
|
+
() => React.createElement('div', null, 'hello'),
|
|
2840
|
+
))
|
|
2841
|
+
},
|
|
2842
|
+
}
|
|
2843
|
+
```
|
|
2844
|
+
|
|
2845
|
+
### `sidebar.right.tab.menu.item`
|
|
2846
|
+
|
|
2847
|
+
Kind `list`, scope `session`. Extra items at the end of one tab's actions menu, in registration order.
|
|
2848
|
+
|
|
2849
|
+
Extra items at the end of one tab's actions menu, in registration order.
|
|
2850
|
+
Entries decide their own visibility from the tab they are given. Without a
|
|
2851
|
+
registrant the menu shows only the kit's own layout actions.
|
|
2852
|
+
|
|
2853
|
+
Register options:
|
|
2854
|
+
|
|
2855
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2856
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2857
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2858
|
+
|
|
2859
|
+
Props your component receives:
|
|
2860
|
+
|
|
2861
|
+
```ts
|
|
2862
|
+
/** Owner share of one tab-menu item occurrence. */
|
|
2863
|
+
export interface SidebarRightTabMenuOwnerProps {
|
|
2864
|
+
/** The tab whose menu is open. */
|
|
2865
|
+
tab: TabRecord
|
|
2866
|
+
/**
|
|
2867
|
+
* Dismiss the menu.
|
|
2868
|
+
*
|
|
2869
|
+
* An item that acts MUST call this: the menu is the kit's, and it closes on
|
|
2870
|
+
* its own actions only. An item that leaves it open leaves a menu floating
|
|
2871
|
+
* over content the action may have just replaced.
|
|
2872
|
+
*/
|
|
2873
|
+
dismiss: () => void
|
|
2874
|
+
}
|
|
2875
|
+
```
|
|
2876
|
+
|
|
2877
|
+
Example:
|
|
2878
|
+
|
|
2879
|
+
```js
|
|
2880
|
+
return {
|
|
2881
|
+
inject: ['slots'],
|
|
2882
|
+
apply(ctx) {
|
|
2883
|
+
ctx.slots.inject('sidebar.right.tab.menu.item', () => ctx.slots.register(
|
|
2884
|
+
{ name: 'sidebar.right.tab.menu.item', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2885
|
+
() => React.createElement('div', null, 'hello'),
|
|
2886
|
+
))
|
|
2887
|
+
},
|
|
2888
|
+
}
|
|
2889
|
+
```
|
|
2890
|
+
|
|
2891
|
+
### `sidebar.session.row.hover`
|
|
2892
|
+
|
|
2893
|
+
Kind `list`, scope `root`. Section of the Session row's hover card between its relative time and its trailing status line.
|
|
2894
|
+
|
|
2895
|
+
Section of the Session row's hover card between its relative time and
|
|
2896
|
+
its trailing status line. Mounted only while that card is open.
|
|
2897
|
+
|
|
2898
|
+
Register options:
|
|
2899
|
+
|
|
2900
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2901
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2902
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2903
|
+
|
|
2904
|
+
Props your component receives:
|
|
2905
|
+
|
|
2906
|
+
```ts
|
|
2907
|
+
/**
|
|
2908
|
+
* Owner share of the two Session-row schedule seats. Both receive only the
|
|
2909
|
+
* row's Session identity: the occupant reads that Session's own scheduled
|
|
2910
|
+
* tasks, and reading them activates nothing.
|
|
2911
|
+
*/
|
|
2912
|
+
export interface SessionRowScheduleOwnerProps {
|
|
2913
|
+
/** Session this row shows; the occupant addresses its own data by this id. */
|
|
2914
|
+
readonly sessionId: SessionId
|
|
2915
|
+
}
|
|
2916
|
+
```
|
|
2917
|
+
|
|
2918
|
+
Already occupied by: client-ui-schedule SessionScheduleHover id 'schedule-tasks'. Replace risk: `none`.
|
|
2919
|
+
|
|
2920
|
+
Example:
|
|
2921
|
+
|
|
2922
|
+
```js
|
|
2923
|
+
return {
|
|
2924
|
+
inject: ['slots'],
|
|
2925
|
+
apply(ctx) {
|
|
2926
|
+
ctx.slots.inject('sidebar.session.row.hover', () => ctx.slots.register(
|
|
2927
|
+
{ name: 'sidebar.session.row.hover', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2928
|
+
() => React.createElement('div', null, 'hello'),
|
|
2929
|
+
))
|
|
2930
|
+
},
|
|
2931
|
+
}
|
|
2932
|
+
```
|
|
2933
|
+
|
|
2934
|
+
### `sidebar.session.row.leading`
|
|
2935
|
+
|
|
2936
|
+
Kind `list`, scope `root`. Leading decoration of one Session row, in the 16px cell before the title that the row's own state dot otherwise occupies.
|
|
2937
|
+
|
|
2938
|
+
Leading decoration of one Session row, in the 16px cell before the title
|
|
2939
|
+
that the row's own state dot otherwise occupies. A higher-priority state
|
|
2940
|
+
(a pending interaction, a new message, live activity) replaces the seat
|
|
2941
|
+
with that dot for the same row, so an occupant here never renders beside
|
|
2942
|
+
a status dot and is mounted only by a row whose primary state is idle.
|
|
2943
|
+
An archived row keeps that cell blank - neither its status dot nor this
|
|
2944
|
+
seat renders there, and its live status appears on the hover card only.
|
|
2945
|
+
|
|
2946
|
+
Register options:
|
|
2947
|
+
|
|
2948
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
2949
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
2950
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
2951
|
+
|
|
2952
|
+
Props your component receives:
|
|
2953
|
+
|
|
2954
|
+
```ts
|
|
2955
|
+
/**
|
|
2956
|
+
* Owner share of the two Session-row schedule seats. Both receive only the
|
|
2957
|
+
* row's Session identity: the occupant reads that Session's own scheduled
|
|
2958
|
+
* tasks, and reading them activates nothing.
|
|
2959
|
+
*/
|
|
2960
|
+
export interface SessionRowScheduleOwnerProps {
|
|
2961
|
+
/** Session this row shows; the occupant addresses its own data by this id. */
|
|
2962
|
+
readonly sessionId: SessionId
|
|
2963
|
+
}
|
|
2964
|
+
```
|
|
2965
|
+
|
|
2966
|
+
Already occupied by: client-ui-schedule SessionScheduleMark id 'schedule-mark'. Replace risk: `none`.
|
|
2967
|
+
|
|
2968
|
+
Example:
|
|
2969
|
+
|
|
2970
|
+
```js
|
|
2971
|
+
return {
|
|
2972
|
+
inject: ['slots'],
|
|
2973
|
+
apply(ctx) {
|
|
2974
|
+
ctx.slots.inject('sidebar.session.row.leading', () => ctx.slots.register(
|
|
2975
|
+
{ name: 'sidebar.session.row.leading', id: 'my-entry', order: 100, label: 'My entry' },
|
|
2976
|
+
() => React.createElement('div', null, 'hello'),
|
|
2977
|
+
))
|
|
2978
|
+
},
|
|
2979
|
+
}
|
|
2980
|
+
```
|
|
2981
|
+
|
|
2982
|
+
### `sidebar.settings`
|
|
2983
|
+
|
|
2984
|
+
Kind `single`, scope `root`. The settings seat at the sidebar foot.
|
|
2985
|
+
|
|
2986
|
+
The settings seat at the sidebar foot. Declared by this package's
|
|
2987
|
+
'sidebar' entry; ui-settings registers its trigger row + modal panel.
|
|
2988
|
+
The sidebar passes only its column state - it holds no settings state.
|
|
2989
|
+
|
|
2990
|
+
Props your component receives:
|
|
2991
|
+
|
|
2992
|
+
```ts
|
|
2993
|
+
/**
|
|
2994
|
+
* Owner share of the sidebar settings seat: the column display state the
|
|
2995
|
+
* occupant's trigger row must render against (wide row vs rail icon).
|
|
2996
|
+
*/
|
|
2997
|
+
export interface SidebarSettingsOwnerProps {
|
|
2998
|
+
/** Whether the sidebar renders wide content (false = 56px rail). */
|
|
2999
|
+
wide: boolean
|
|
3000
|
+
}
|
|
3001
|
+
```
|
|
3002
|
+
|
|
3003
|
+
Already occupied by: client-ui-settings-general SettingsRoot. Replace risk: `shadows-shipped-ui`.
|
|
3004
|
+
|
|
3005
|
+
Example:
|
|
3006
|
+
|
|
3007
|
+
```js
|
|
3008
|
+
return {
|
|
3009
|
+
inject: ['slots'],
|
|
3010
|
+
apply(ctx) {
|
|
3011
|
+
ctx.slots.inject('sidebar.settings', () => ctx.slots.register(
|
|
3012
|
+
{ name: 'sidebar.settings' },
|
|
3013
|
+
() => React.createElement('div', null, 'hello'),
|
|
3014
|
+
))
|
|
3015
|
+
},
|
|
3016
|
+
}
|
|
3017
|
+
```
|
|
3018
|
+
|
|
3019
|
+
### `sidebar.toggle.badge`
|
|
3020
|
+
|
|
3021
|
+
Kind `single`, scope `root`. Non-interactive notification inside the collapsed sidebar expand button.
|
|
3022
|
+
|
|
3023
|
+
Already occupied by: client-ui-settings-general DesktopUpdateBadge. Replace risk: `shadows-shipped-ui`.
|
|
3024
|
+
|
|
3025
|
+
Example:
|
|
3026
|
+
|
|
3027
|
+
```js
|
|
3028
|
+
return {
|
|
3029
|
+
inject: ['slots'],
|
|
3030
|
+
apply(ctx) {
|
|
3031
|
+
ctx.slots.inject('sidebar.toggle.badge', () => ctx.slots.register(
|
|
3032
|
+
{ name: 'sidebar.toggle.badge' },
|
|
3033
|
+
() => React.createElement('div', null, 'hello'),
|
|
3034
|
+
))
|
|
3035
|
+
},
|
|
3036
|
+
}
|
|
3037
|
+
```
|
|
3038
|
+
|
|
3039
|
+
### `sidebar.workspaces`
|
|
3040
|
+
|
|
3041
|
+
Kind `single`, scope `root`. The workspace/session browsing region: section header, search, the grouped/flat session list, and every workspace dialog.
|
|
3042
|
+
|
|
3043
|
+
The workspace/session browsing region: section header, search, the
|
|
3044
|
+
grouped/flat session list, and every workspace dialog. Declared by this
|
|
3045
|
+
package's 'sidebar' entry (declaring is claiming); ui-workspace
|
|
3046
|
+
registers the browser.
|
|
3047
|
+
|
|
3048
|
+
Props your component receives:
|
|
3049
|
+
|
|
3050
|
+
```ts
|
|
3051
|
+
/**
|
|
3052
|
+
* Owner share of the browser hole - the only facts crossing the shell/region
|
|
3053
|
+
* boundary. Business data and actions arrive through the region's own inject.
|
|
3054
|
+
*/
|
|
3055
|
+
export interface SidebarSectionOwnerProps {
|
|
3056
|
+
/** Shell fold-state output: wide renders the full browser, rail the icon column. */
|
|
3057
|
+
wide: boolean
|
|
3058
|
+
/** Rail icons request expansion; the browser rides the wide flip for focus. */
|
|
3059
|
+
expandSidebar: () => void
|
|
3060
|
+
}
|
|
3061
|
+
```
|
|
3062
|
+
|
|
3063
|
+
Already occupied by: client-ui-workspace WorkspaceBrowser. Replace risk: `shadows-shipped-ui`.
|
|
3064
|
+
|
|
3065
|
+
Example:
|
|
3066
|
+
|
|
3067
|
+
```js
|
|
3068
|
+
return {
|
|
3069
|
+
inject: ['slots'],
|
|
3070
|
+
apply(ctx) {
|
|
3071
|
+
ctx.slots.inject('sidebar.workspaces', () => ctx.slots.register(
|
|
3072
|
+
{ name: 'sidebar.workspaces' },
|
|
3073
|
+
() => React.createElement('div', null, 'hello'),
|
|
3074
|
+
))
|
|
3075
|
+
},
|
|
3076
|
+
}
|
|
3077
|
+
```
|
|
3078
|
+
|
|
3079
|
+
### `sidebar.workspaces.directoryFlow`
|
|
3080
|
+
|
|
3081
|
+
Kind `single`, scope `root`. Directory-flow hole under the sidebar browsing region (declared by the WorkspaceBrowser entry).
|
|
3082
|
+
|
|
3083
|
+
Props your component receives:
|
|
3084
|
+
|
|
3085
|
+
```ts
|
|
3086
|
+
/**
|
|
3087
|
+
* Owner share of the directory-flow holes: the complete conversation between
|
|
3088
|
+
* the trigger surface and the picking interaction. The occupant reads `open`
|
|
3089
|
+
* to run/render its interaction and reports exactly one outcome per open.
|
|
3090
|
+
*/
|
|
3091
|
+
export interface DirectoryFlowOwnerProps {
|
|
3092
|
+
/** True while a picking interaction is requested; flipping back to false withdraws the request. */
|
|
3093
|
+
open: boolean
|
|
3094
|
+
/** True while the owner adopts a picked path (`createWorkspace` in flight); occupants disable their commit affordances. */
|
|
3095
|
+
busy: boolean
|
|
3096
|
+
/** The operator picked a directory (absolute host path); the owner adopts it. */
|
|
3097
|
+
onPicked: (path: string) => void
|
|
3098
|
+
/** The operator dismissed the interaction; the owner just closes the flow. */
|
|
3099
|
+
onCancel: () => void
|
|
3100
|
+
/** The interaction itself failed (chooser missing, listing denied); the owner shows its error surface. */
|
|
3101
|
+
onError: (message: string) => void
|
|
3102
|
+
}
|
|
3103
|
+
```
|
|
3104
|
+
|
|
3105
|
+
Already occupied by: client-ui-directory-picker-browse BrowseDirectoryFlow; client-ui-directory-picker-native NativeDirectoryFlow. Replace risk: `shadows-shipped-ui`.
|
|
3106
|
+
|
|
3107
|
+
Example:
|
|
3108
|
+
|
|
3109
|
+
```js
|
|
3110
|
+
return {
|
|
3111
|
+
inject: ['slots'],
|
|
3112
|
+
apply(ctx) {
|
|
3113
|
+
ctx.slots.inject('sidebar.workspaces.directoryFlow', () => ctx.slots.register(
|
|
3114
|
+
{ name: 'sidebar.workspaces.directoryFlow' },
|
|
3115
|
+
() => React.createElement('div', null, 'hello'),
|
|
3116
|
+
))
|
|
3117
|
+
},
|
|
3118
|
+
}
|
|
3119
|
+
```
|
|
3120
|
+
|
|
3121
|
+
### `sidebar.workspaces.session.menu.item`
|
|
3122
|
+
|
|
3123
|
+
Kind `list`, scope `root`. The rows of one Session's "..." menu, in ascending `order`.
|
|
3124
|
+
|
|
3125
|
+
The rows of one Session's "..." menu, in ascending `order`. ui-workspace
|
|
3126
|
+
registers the shipped rows here - `pin` (100), `rename` (200), `fork`
|
|
3127
|
+
(300), `archive` (400) - so a plugin row is placed by its own `order`
|
|
3128
|
+
among them. Use a package-namespaced `id`; reusing a shipped id at
|
|
3129
|
+
another `priority` shadows that row. Each entry renders one
|
|
3130
|
+
`role="menuitem"` `<button>` (the shipped rows use ui-primitives'
|
|
3131
|
+
`MenuItemButton`, which adds the host styling and `separatorBefore`),
|
|
3132
|
+
decides its own visibility from its own state, and dismisses the menu
|
|
3133
|
+
through the injected `useMenuOpenState` hook after acting; the list's
|
|
3134
|
+
keyboard walk and focus return read the DOM, so any such button joins
|
|
3135
|
+
them. Labels come from the contributing package's locale namespace.
|
|
3136
|
+
|
|
3137
|
+
Register options:
|
|
3138
|
+
|
|
3139
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
3140
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
3141
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
3142
|
+
|
|
3143
|
+
Props your component receives:
|
|
3144
|
+
|
|
3145
|
+
```ts
|
|
3146
|
+
/** Owner share of one Session row action occurrence: the row the action belongs to. */
|
|
3147
|
+
export interface SessionRowOwnerProps {
|
|
3148
|
+
/** Session the row shows. */
|
|
3149
|
+
sessionId: SessionId
|
|
3150
|
+
/** Row display title: persisted title, or empty when the Session has none. */
|
|
3151
|
+
displayTitle: string
|
|
3152
|
+
}
|
|
3153
|
+
```
|
|
3154
|
+
|
|
3155
|
+
Already occupied by: client-ui-workspace PinSessionMenuItem id 'pin'; client-ui-workspace RenameSessionMenuItem id 'rename'; client-ui-workspace ForkSessionMenuItem id 'fork'; client-ui-workspace ArchiveSessionMenuItem id 'archive'. Replace risk: `none`.
|
|
3156
|
+
|
|
3157
|
+
Example:
|
|
3158
|
+
|
|
3159
|
+
```js
|
|
3160
|
+
return {
|
|
3161
|
+
inject: ['slots'],
|
|
3162
|
+
apply(ctx) {
|
|
3163
|
+
const copyLabel = 'Copy Session ID' // Localize in the contributing package.
|
|
3164
|
+
ctx.slots.inject('sidebar.workspaces.session.menu.item', () => ctx.slots.register(
|
|
3165
|
+
{ name: 'sidebar.workspaces.session.menu.item', id: 'copy-session-id', order: 500 },
|
|
3166
|
+
({ sessionId, useMenuOpenState }) => {
|
|
3167
|
+
const [, setMenuOpen] = useMenuOpenState()
|
|
3168
|
+
return React.createElement(
|
|
3169
|
+
'button',
|
|
3170
|
+
{ type: 'button', role: 'menuitem', onClick: () => { setMenuOpen(false); void navigator.clipboard.writeText(sessionId) } },
|
|
3171
|
+
copyLabel,
|
|
3172
|
+
)
|
|
3173
|
+
},
|
|
3174
|
+
))
|
|
3175
|
+
},
|
|
3176
|
+
}
|
|
3177
|
+
```
|
|
3178
|
+
|
|
3179
|
+
### `sidebar.workspaces.session.row.action`
|
|
3180
|
+
|
|
3181
|
+
Kind `list`, scope `root`. The hover buttons at the end of one Session row, in ascending `order`, after the "..." menu trigger.
|
|
3182
|
+
|
|
3183
|
+
The hover buttons at the end of one Session row, in ascending `order`,
|
|
3184
|
+
after the "..." menu trigger. ui-workspace registers `archive` (100) and
|
|
3185
|
+
`pin` (200) here. An entry renders one icon button (or nothing, when its
|
|
3186
|
+
action does not apply to the row) and owns the action it performs. Clicks
|
|
3187
|
+
inside the strip stay in the strip, so the button needs no propagation
|
|
3188
|
+
handling to keep the row from opening.
|
|
3189
|
+
|
|
3190
|
+
Register options:
|
|
3191
|
+
|
|
3192
|
+
- `id` (required, `string`): Your cell key. Use an id of your own: a fresh id is added beside the shipped entries, while reusing a shipped id puts you in THAT cell and replaces it. Owners that filter by id address you by it.
|
|
3193
|
+
- `order` (optional, `number`): Position among the entries, ascending (default 0).
|
|
3194
|
+
- `label` (optional, `string \| (() => string)`): Display text where the owner projects one (nav rows, tabs). A thunk is re-read on every projection, so localized text follows the active locale without re-registering.
|
|
3195
|
+
|
|
3196
|
+
Props your component receives:
|
|
3197
|
+
|
|
3198
|
+
```ts
|
|
3199
|
+
/** Owner share of one Session row action occurrence: the row the action belongs to. */
|
|
3200
|
+
export interface SessionRowOwnerProps {
|
|
3201
|
+
/** Session the row shows. */
|
|
3202
|
+
sessionId: SessionId
|
|
3203
|
+
/** Row display title: persisted title, or empty when the Session has none. */
|
|
3204
|
+
displayTitle: string
|
|
3205
|
+
}
|
|
3206
|
+
```
|
|
3207
|
+
|
|
3208
|
+
Already occupied by: client-ui-workspace ArchiveSessionRowButton id 'archive'; client-ui-workspace PinSessionRowButton id 'pin'. Replace risk: `none`.
|
|
3209
|
+
|
|
3210
|
+
Example:
|
|
3211
|
+
|
|
3212
|
+
```js
|
|
3213
|
+
return {
|
|
3214
|
+
inject: ['slots'],
|
|
3215
|
+
apply(ctx) {
|
|
3216
|
+
ctx.slots.inject('sidebar.workspaces.session.row.action', () => ctx.slots.register(
|
|
3217
|
+
{ name: 'sidebar.workspaces.session.row.action', id: 'my-entry', order: 100, label: 'My entry' },
|
|
3218
|
+
() => React.createElement('div', null, 'hello'),
|
|
3219
|
+
))
|
|
3220
|
+
},
|
|
3221
|
+
}
|
|
3222
|
+
```
|
|
3223
|
+
|
|
3224
|
+
### `tool.call.images`
|
|
3225
|
+
|
|
3226
|
+
Kind `single`, scope `session`. Durable images of a settled image-bearing Tool call, rendered through the attachment presentation plugin.
|
|
3227
|
+
|
|
3228
|
+
Durable images of a settled image-bearing Tool call, rendered through
|
|
3229
|
+
the attachment presentation plugin. The Tool layer never imports an
|
|
3230
|
+
attachment implementation: a toolview declares this slot as a child and
|
|
3231
|
+
renders it with the image card's references plus the session-authorized
|
|
3232
|
+
loader it received in its owner, and the attachment plugin fills the
|
|
3233
|
+
gallery. Composing no attachment presentation plugin renders nothing,
|
|
3234
|
+
which is why the image card keeps its own envelope text beside the
|
|
3235
|
+
gallery. A child slot is declared by exactly one entry: registering a
|
|
3236
|
+
second toolview that declares the same child throws at load, so a
|
|
3237
|
+
future image-bearing tool must reuse this entry or own a distinct
|
|
3238
|
+
slot.
|
|
3239
|
+
|
|
3240
|
+
Props your component receives:
|
|
3241
|
+
|
|
3242
|
+
```ts
|
|
3243
|
+
/** Owner currency of the Tool image gallery slot: references plus the loader. */
|
|
3244
|
+
export interface ToolImagesOwnerProps {
|
|
3245
|
+
/** Durable references or submission-echo previews in result order. */
|
|
3246
|
+
images: readonly MessageImageSource[]
|
|
3247
|
+
/** Session-authorized image URL loader for the durable arm. */
|
|
3248
|
+
loadImage: MessageImageLoader
|
|
3249
|
+
/** Horizontal placement inside the owning record. */
|
|
3250
|
+
align: 'start' | 'end'
|
|
3251
|
+
}
|
|
3252
|
+
```
|
|
3253
|
+
|
|
3254
|
+
Already occupied by: client-ui-attachment MessageImages. Replace risk: `shadows-shipped-ui`.
|
|
3255
|
+
|
|
3256
|
+
Example:
|
|
3257
|
+
|
|
3258
|
+
```js
|
|
3259
|
+
return {
|
|
3260
|
+
inject: ['slots'],
|
|
3261
|
+
apply(ctx) {
|
|
3262
|
+
ctx.slots.inject('tool.call.images', () => ctx.slots.register(
|
|
3263
|
+
{ name: 'tool.call.images' },
|
|
3264
|
+
() => React.createElement('div', null, 'hello'),
|
|
3265
|
+
))
|
|
3266
|
+
},
|
|
3267
|
+
}
|
|
3268
|
+
```
|
|
3269
|
+
|
|
3270
|
+
### `tool.call.toolview`
|
|
3271
|
+
|
|
3272
|
+
Kind `keyed`, scope `session`. Keyed Tool call view dispatched by wire Tool name.
|
|
3273
|
+
|
|
3274
|
+
Keyed Tool call view dispatched by wire Tool name. Any name is allowed,
|
|
3275
|
+
including tools registered by your package. Register with
|
|
3276
|
+
`key: '<tool name>'`; a typo never renders.
|
|
3277
|
+
|
|
3278
|
+
Registering an occupied key replaces its view; unclaimed keys use the
|
|
3279
|
+
generic row. The owner supplies the call identity and frozen running
|
|
3280
|
+
or settled node through explicit phase props. Preparing blocks have no dispatched
|
|
3281
|
+
arguments; useToolCallArgumentsPartial optionally subscribes to their raw prefix.
|
|
3282
|
+
|
|
3283
|
+
Register options:
|
|
3284
|
+
|
|
3285
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
3286
|
+
|
|
3287
|
+
Props your component receives:
|
|
3288
|
+
|
|
3289
|
+
```ts
|
|
3290
|
+
/** Standard owner currency supplied to every atomic Tool view. */
|
|
3291
|
+
export interface ToolCallCommonProps {
|
|
3292
|
+
/** Stable Hook; each invocation owns its open state and subscribes to enclosing-Turn resets. */
|
|
3293
|
+
useDisclosure: UseDisclosure
|
|
3294
|
+
/** Call identity, stable across all stages. */
|
|
3295
|
+
callId: string
|
|
3296
|
+
/** Wire Tool name and keyed dispatch value. */
|
|
3297
|
+
toolName: string
|
|
3298
|
+
/** Session workspace root for relative summaries. */
|
|
3299
|
+
cwd?: string | undefined
|
|
3300
|
+
/** Host account home; POSIX home-rooted summaries display as `~`. */
|
|
3301
|
+
home?: string | undefined
|
|
3302
|
+
/** Open an argument path at its optional requested line. */
|
|
3303
|
+
openFile: (path: string, options?: OpenFileOptions) => void
|
|
3304
|
+
/** Chat-supplied, session-authorized loader for durable images; Tool views do not manage attachment URLs. */
|
|
3305
|
+
loadImage: MessageImageLoader
|
|
3306
|
+
/** Inspect this call in the trajectory view when available. */
|
|
3307
|
+
inspect?: (() => void) | undefined
|
|
3308
|
+
}
|
|
3309
|
+
|
|
3310
|
+
/** Common owner callbacks and the data admitted at the current tool stage. */
|
|
3311
|
+
export type ToolCallOwnerProps = ToolCallCommonProps & ToolCallPhaseProps
|
|
3312
|
+
|
|
3313
|
+
/** Stage-specific tool data; only start/result expose the dispatched call material. */
|
|
3314
|
+
export type ToolCallPhaseProps =
|
|
3315
|
+
| { readonly phase: 'preparing'; readonly block: PreparingToolCall }
|
|
3316
|
+
| { readonly phase: 'start'; readonly block: StartedToolCall }
|
|
3317
|
+
| { readonly phase: 'result'; readonly block: ToolResultNode }
|
|
3318
|
+
```
|
|
3319
|
+
|
|
3320
|
+
Keys: open: any string the owner dispatches (no compile-time key set), already taken: ask_user_question, bash, cordis_define, cordis_inspect_list, cordis_inspect_query, cordis_inspect_self, cordis_run, cordis_stop, cordis_undefine, create_goal, edit, get_goal, glob, grep, interrupt_agent, job_kill, job_list, job_output, list_agents, list_subagent_models, lsp, present, ralph, read, read_image, schedule_create, schedule_delete, schedule_list, schedule_update, send_message, session_event_read, session_event_search, session_event_trace, session_search, session_trace, skill, spawn_teammate, subagent, team_task_create, team_task_get, team_task_list, team_task_update, terminal_close, terminal_list, terminal_open, terminal_read, terminal_signal, todo_write, update_goal, wait_agent, web_fetch, web_search, workflow, write
|
|
3321
|
+
|
|
3322
|
+
Already occupied by: client-ui-deliverables PresentRow key 'present'; client-ui-skill SkillRow key 'skill'; client-ui-tool AskQuestionRow key 'ask_user_question'; client-ui-tool BashRow key 'bash'; client-ui-tool DetailsRow key 'create_goal'; client-ui-tool DetailsRow key 'get_goal'; client-ui-tool DetailsRow key 'update_goal'; client-ui-tool DetailsRow key 'schedule_create'; client-ui-tool DetailsRow key 'schedule_list'; client-ui-tool DetailsRow key 'schedule_delete'; client-ui-tool DetailsRow key 'schedule_update'; client-ui-tool DetailsRow key 'cordis_inspect_list'; client-ui-tool DetailsRow key 'cordis_inspect_query'; client-ui-tool DetailsRow key 'cordis_inspect_self'; client-ui-tool DetailsRow key 'workflow'; client-ui-tool DetailsRow key 'ralph'; client-ui-tool DetailsRow key 'session_event_read'; client-ui-tool DetailsRow key 'session_event_search'; client-ui-tool DetailsRow key 'session_event_trace'; client-ui-tool DetailsRow key 'session_search'; client-ui-tool DetailsRow key 'session_trace'; client-ui-tool DetailsRow key 'list_subagent_models'; client-ui-tool DetailsRow key 'subagent'; client-ui-tool DetailsRow key 'list_agents'; client-ui-tool DetailsRow key 'send_message'; client-ui-tool DetailsRow key 'interrupt_agent'; client-ui-tool DetailsRow key 'job_list'; client-ui-tool DetailsRow key 'job_output'; client-ui-tool DetailsRow key 'job_kill'; client-ui-tool DetailsRow key 'terminal_open'; client-ui-tool DetailsRow key 'terminal_read'; client-ui-tool DetailsRow key 'terminal_list'; client-ui-tool DetailsRow key 'terminal_signal'; client-ui-tool DetailsRow key 'terminal_close'; client-ui-tool DetailsRow key 'lsp'; client-ui-tool DetailsRow key 'spawn_teammate'; client-ui-tool DetailsRow key 'team_task_create'; client-ui-tool DetailsRow key 'team_task_get'; client-ui-tool DetailsRow key 'team_task_update'; client-ui-tool DetailsRow key 'team_task_list'; client-ui-tool DetailsRow key 'wait_agent'; client-ui-tool FileMutationRow key 'edit'; client-ui-tool FileMutationRow key 'write'; client-ui-tool ReadImageRow key 'read_image'; client-ui-tool ReadRow key 'read'; client-ui-tool SearchRow key 'grep'; client-ui-tool SearchRow key 'glob'; client-ui-tool TodoRow key 'todo_write'; client-ui-tool WebRow key 'web_search'; client-ui-tool WebRow key 'web_fetch'; client-ui-cordis CordisDefineRow key 'cordis_define'; client-ui-cordis CordisRunRow key 'cordis_run'; client-ui-cordis CordisActionRow key 'cordis_stop'; client-ui-cordis CordisActionRow key 'cordis_undefine'. Replace risk: `shadows-shipped-ui`.
|
|
3323
|
+
|
|
3324
|
+
Example:
|
|
3325
|
+
|
|
3326
|
+
```js
|
|
3327
|
+
return {
|
|
3328
|
+
inject: ['slots'],
|
|
3329
|
+
apply(ctx) {
|
|
3330
|
+
ctx.slots.inject('tool.call.toolview', () => ctx.slots.register(
|
|
3331
|
+
{ name: 'tool.call.toolview', key: '<one key the owner dispatches>' },
|
|
3332
|
+
() => React.createElement('div', null, 'hello'),
|
|
3333
|
+
))
|
|
3334
|
+
},
|
|
3335
|
+
}
|
|
3336
|
+
```
|
|
3337
|
+
|
|
3338
|
+
### `tool.view.cordis`
|
|
3339
|
+
|
|
3340
|
+
Kind `keyed`, scope `session`. Interactive Package-owned region rendered inside the latest eligible `cordis_run` card in the conversation flow.
|
|
3341
|
+
|
|
3342
|
+
Interactive Package-owned region rendered inside the latest eligible
|
|
3343
|
+
`cordis_run` card in the conversation flow. Use it for controls and other
|
|
3344
|
+
UI the user can interact with. Dynamic Client code registers with
|
|
3345
|
+
`key: 'self'`; the Guard binds that key to the current Plugin and Package.
|
|
3346
|
+
|
|
3347
|
+
Register options:
|
|
3348
|
+
|
|
3349
|
+
- `key` (required, `string`): Your cell key: the entry renders where the owner dispatches this exact key. Registering an already-occupied key replaces that occupant.
|
|
3350
|
+
|
|
3351
|
+
Props your component receives:
|
|
3352
|
+
|
|
3353
|
+
```ts
|
|
3354
|
+
/** Owner currency delivered to a dynamic Package's business view. */
|
|
3355
|
+
export interface CordisToolViewOwnerProps {
|
|
3356
|
+
readonly pluginId: CordisDynamicPluginId
|
|
3357
|
+
readonly packageId: CordisDynamicPackageId
|
|
3358
|
+
readonly pluginRunId: CordisDynamicPluginRunId
|
|
3359
|
+
}
|
|
3360
|
+
```
|
|
3361
|
+
|
|
3362
|
+
Keys: open: any string the owner dispatches (no compile-time key set), none are taken yet
|
|
3363
|
+
|
|
3364
|
+
Example:
|
|
3365
|
+
|
|
3366
|
+
```js
|
|
3367
|
+
return {
|
|
3368
|
+
inject: ['slots'],
|
|
3369
|
+
apply(ctx) {
|
|
3370
|
+
ctx.slots.inject('tool.view.cordis', () => ctx.slots.register(
|
|
3371
|
+
{ name: 'tool.view.cordis', key: '<one key the owner dispatches>' },
|
|
3372
|
+
() => React.createElement('div', null, 'hello'),
|
|
3373
|
+
))
|
|
3374
|
+
},
|
|
3375
|
+
}
|
|
3376
|
+
```
|