Skip to content

docs: correct which sidebar tab field surface.* verbs accept (#12803) #12872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aliyansajid wants to merge 1 commit into from
Closed

docs: correct which sidebar tab field surface.* verbs accept (#12803) #12872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/custom-sidebars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,9 @@ examples.
`TextField(value, opts)` opts: `placeholder`, `onSubmit(text)`, `onCancel()`,
`onEdit(text)` (fires per keystroke - live search), `autofocus` (default
true; pass `false` for persistent fields so mounting never steals focus).
Each workspace's `tabs[i]` carries `surfaceId` for `surface.*` verbs
(`tabs[i].id` is the panel behind the tab, not interchangeable).
Each workspace's `tabs[i]` carries `id` for `surface.*` verbs
(`tabs[i].surfaceId` correlates a tab with `agents[j].surfaceId`; the two
are not interchangeable).

A sidebar file is a single SwiftUI-style view expression (no `struct`, no
`var body` wrapper, just the view).
Expand Down Expand Up @@ -276,10 +277,12 @@ with:
(display name), `status` (`idle`|`working`|`needs_input`|`ended`), and
`lastActivityAt` (epoch); when available it adds `sinceEpoch` (when the
current working/needs-input state began), `title` (first user prompt),
`panelId` (the hosting terminal's `tabs[k].id`), `surfaceId` (the hosting
tab's `tabs[k].surfaceId`, accepted by `surface.focus`), `directory`,
`panelId` (the hosting terminal's `tabs[k].id`, accepted by `surface.*`
verbs), `surfaceId` (the hosting tab's `tabs[k].surfaceId`, for
correlating an agent with its tab), `directory`,
`transcriptPath`, and `pid`.
- `tabs` (per workspace) — array of surfaces. Always: `id`, `title`,
- `tabs` (per workspace) — array of surfaces. Always: `id` (the value
`surface.*` verbs accept as `surface_id`), `title`,
`focused` (Bool), `pinned` (Bool). When available: `directory`, `branch` +
`dirty`, `ports` (array of Int).
- `workspaceCount` — Int. `selectedTitle` — active workspace's title.
Expand Down
4 changes: 2 additions & 2 deletions docs/subagents-panel-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ per workspace. Each `agents[j]`:
| `lastActivityAt` | yes | epoch seconds of last hook/transcript activity |
| `sinceEpoch` | working / needs_input | when the current state began |
| `title` | when known | conversation title (first user prompt) |
| `panelId` | when bound | hosting terminal panel UUID (= `tabs[k].id`) |
| `surfaceId` | when bound | hosting tab surface UUID (= `tabs[k].surfaceId`, accepted by `surface.focus`) |
| `panelId` | when bound | hosting terminal panel UUID (= `tabs[k].id`, accepted by `surface.focus`) |
| `surfaceId` | when bound | hosting tab surface UUID (= `tabs[k].surfaceId`, for correlating an agent with its tab) |
| `directory` | when known | session working directory |
| `transcriptPath` | when resolved | absolute transcript JSONL path |
| `pid` | when known | agent process id |
Expand Down
Loading