StickyPanelProps

Defined in: react/components/overlay/sticky-panel.tsx:9

Props shared by every ztui React component (plus each component’s own props).

Extends

• ComponentProps

Properties

anchorRef?

optional anchorRef?: RefObject<Widget | null>

Defined in: react/components/overlay/sticky-panel.tsx:42

Anchor the panel to a widget (e.g. the chat input): pass a ref obtained from that widget. The panel sits flush above or below the anchor — see placement — and tracks it as the layout changes. When omitted, the panel is positioned at the screen offsets in panelStyle.

const inputRef = useRef<InputWidget>(null);
<Input ref={inputRef} />
<StickyPanel anchorRef={inputRef} placement="above">…</StickyPanel>

---

children?

optional children?: ReactNode

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

Child elements.

Inherited from

ComponentProps.children

---

className?

optional className?: string

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

Space-separated class names (currently advisory; no CSS cascade).

Inherited from

ComponentProps.className

---

closeOnEscape?

optional closeOnEscape?: boolean

Defined in: react/components/overlay/sticky-panel.tsx:27

Esc dismisses the panel (calls onClose). Defaults to true.

---

disabled?

optional disabled?: boolean

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

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

---

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

---

onClose?

optional onClose?: () => void

Defined in: react/components/overlay/sticky-panel.tsx:29

Called when the panel asks to close (Esc). Drive your open state here.

Returns

void

---

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

---

onKeyIntercept?

optional onKeyIntercept?: (ev) => void

Defined in: react/components/overlay/sticky-panel.tsx:25

Sees key events before they reach the focused control below, so the panel can claim navigation keys (↑/↓/Enter) while ordinary typing still flows to the focused input. Call ev.handled = true to consume the key; leave it alone to let it pass through.

onKeyIntercept={(ev) => {
  if (ev.name === "down") { moveSelection(1); ev.handled = true; }
  if (ev.name === "enter") { choose(); ev.handled = true; }
}}

Parameters

ev

KeyEvent

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

---

open?

optional open?: boolean

Defined in: react/components/overlay/sticky-panel.tsx:11

Whether the panel is shown. Defaults to true.

---

panelStyle?

optional panelStyle?: WidgetStyles

Defined in: react/components/overlay/sticky-panel.tsx:50

Style overrides for the panel box. Set width here; when not anchored, also left/top/right/bottom to position it. The panel is always clamped to stay fully on-screen.

---

placement?

optional placement?: OverlayPlacement

Defined in: react/components/overlay/sticky-panel.tsx:44

Side of the anchor to prefer (default auto: above only if below won’t fit).

---

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