WorkbenchProps

Marks the widget (and its descendants) as inert: not focusable, ignores key/mouse input, and interactive controls render in a muted style. A disabled container propagates to every control inside it.

Inherited from

ComponentProps.disabled

focusable?

optional focusable?: boolean

Defined in: react/components/types.ts:40

Allow this widget to take keyboard focus.

Inherited from

ComponentProps.focusable

focusOnClick?

optional focusOnClick?: boolean

Defined in: react/components/types.ts:46

When a click lands on this container (its padding, border, or a non-focusable child), move focus to its first focusable descendant — so clicking a Form/Panel/Box hands focus to its first field. Off by default.

Inherited from

ComponentProps.focusOnClick

hoverInterest?

optional hoverInterest?: boolean

Defined in: react/components/types.ts:66

Opt-in hint that this widget cares about passive hover movement.

Inherited from

ComponentProps.hoverInterest

id?

optional id?: string

Defined in: react/components/types.ts:22

Stable identifier, handy for tests and lookups.

Inherited from

ComponentProps.id

initialLayout?

optional initialLayout?: WorkbenchLayout

Defined in: react/components/layout/workbench.tsx:44

Serializable layout snapshot to restore on mount (open/size/active per region). Takes precedence over initialOpen/initialSizes. Pair with WorkbenchProps.onLayoutChange to persist and reload layout.

initialOpen?

optional initialOpen?: WorkbenchAnchor[]

Defined in: react/components/layout/workbench.tsx:36

Regions that start expanded (with their first panel active).

initialSizes?

optional initialSizes?: Partial<Record<WorkbenchAnchor, number>>

Defined in: react/components/layout/workbench.tsx:38

Starting sizes per region (cells). Defaults: side 26, bottom 8.

label?

optional label?: string

Defined in: react/components/types.ts:36

Structural/accessible label (also the tab title inside TabContainer).

Inherited from

ComponentProps.label

onClick?

optional onClick?: (ev) => void

Defined in: react/components/types.ts:54

Pointer click.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onClick

onDragEnd?

optional onDragEnd?: (x, y, moved) => void

Defined in: react/components/types.ts:72

Drag released; moved is false for a tap with no movement.

Parameters

x

number

y

number

moved

boolean

Returns

void

Inherited from

ComponentProps.onDragEnd

onDragMove?

optional onDragMove?: (x, y) => void

Defined in: react/components/types.ts:70

Pointer moved while dragging from this widget.

Parameters

x

number

y

number

Returns

void

Inherited from

ComponentProps.onDragMove

onDragStart?

optional onDragStart?: (x, y) => void

Defined in: react/components/types.ts:68

Pointer-drag lifecycle; moved is false for a tap with no movement.

Parameters

x

number

y

number

Returns

void

Inherited from

ComponentProps.onDragStart

onKey?

optional onKey?: (ev) => void

Defined in: react/components/types.ts:58

Key event while focused; set ev.handled to consume it.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onKey

onLayoutChange?

optional onLayoutChange?: (layout) => void

Defined in: react/components/layout/workbench.tsx:46

Fired with a fresh snapshot whenever the layout changes (for persistence).

Parameters

layout

WorkbenchLayout

Returns

void

onMouseDown?

optional onMouseDown?: (ev) => void

Defined in: react/components/types.ts:56

Pointer pressed (any button); the event carries button and x/y.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onMouseDown

onMouseEnter?

optional onMouseEnter?: (ev) => void

Defined in: react/components/types.ts:62

Pointer entered this widget’s region.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onMouseEnter

onMouseLeave?

optional onMouseLeave?: (ev) => void

Defined in: react/components/types.ts:64

Pointer left this widget’s region.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onMouseLeave

onScroll?

optional onScroll?: (ev) => void

Defined in: react/components/types.ts:60

Wheel / scroll event.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onScroll

panels

panels: WorkbenchPanel[]

Defined in: react/components/layout/workbench.tsx:32

The dockable panels.

ref?

optional ref?: Ref<Widget>

Defined in: react/components/types.ts:30

Captures the underlying widget instance (React 19 ref-as-prop). Defaults to the base Widget; narrow it with a cast when you need a subclass field, e.g. ref={inputRef as React.Ref<InputWidget>}.

Inherited from

ComponentProps.ref

style?

optional style?: WidgetStyles

Defined in: react/components/types.ts:32

Inline styles for this widget — see the Styling guide.

Inherited from

ComponentProps.style

theme?

optional theme?: string

Defined in: react/components/types.ts:34

Re-theme this subtree; descendants resolve $tokens against it.

Inherited from

ComponentProps.theme

toggleKeys?

optional toggleKeys?: Partial<Record<WorkbenchAnchor, string>>

Defined in: react/components/layout/workbench.tsx:54

Keys that toggle each region. Defaults to DEFAULT_TOGGLE_KEYS. Note: ctrl+j/ctrl+i/ctrl+m can’t be used — terminals deliver them as Enter/Tab — and alt/ctrl+alt combos only reach apps under the Kitty keyboard protocol. The default bottom key is `ctrl+“ (a.k.a. ctrl+space), which works on legacy terminals too.