quilt-react / Interface: PaneContext<State>

Defined in: packages/dom/src/types.ts:21

Type Parameters

State

State = unknown

Properties

document

document: Document

Defined in: packages/dom/src/types.ts:32

---

element

element: HTMLElement

Defined in: packages/dom/src/types.ts:24

---

location

location: "popout" | "main"

Defined in: packages/dom/src/types.ts:37

---

pane

pane: Pane

Defined in: packages/dom/src/types.ts:34

---

signal

signal: AbortSignal

Defined in: packages/dom/src/types.ts:26

Aborted when this view is torn down, including a failed mount.

---

state

state: State

Defined in: packages/dom/src/types.ts:36

Stable application-owned reference. The library does not serialize this value.

---

window

window: Window

Defined in: packages/dom/src/types.ts:33

Methods

deferReady()

deferReady(ready): void

Defined in: packages/dom/src/types.ts:30

Delay pane readiness until application resources initialize. Register during mount/commit.

Parameters

ready

Promise<void>

Returns

void

---

onCleanup()

onCleanup(callback): void

Defined in: packages/dom/src/types.ts:28

Register view-owned cleanup; callbacks run once in reverse order.

Parameters

callback

() => void

Returns

void

---

registerScrollArea()

registerScrollArea(elements): () => void

Defined in: packages/dom/src/types.ts:23

Register an application-owned host and direct-child viewport. Returns idempotent cleanup.

Parameters

elements

ScrollAreaElements

Returns

() => void

---

reportError()

reportError(error): void

Defined in: packages/dom/src/types.ts:31

Parameters

error

unknown

Returns

void