Skip to content

explorer

Lite API 3.1, only at sidebar/explorer. read is synchronous; watch has no initial callback. State is display metadata and does not grant filesystem authority. A null rootDirectory means the Space root; a null activePath means no open file.

Usage guide: explorer. API index.

Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.

Source

Supported hosts: Lite

Read the current explorer display state synchronously.

read(): ExplorerState;

Returns: ExplorerState.

Supported hosts: Lite

Subscribe to state changes without an initial callback.

watch(listener: (state: ExplorerState) => void): Disposable;
Parameter Type Required
listener (state: ExplorerState) => void Yes

Returns: Disposable.

Related types: ExplorerState, Disposable.