Class PanelRegistry

Single dispatch point for opening, hiding, and toggling every panel and tool Studio exposes, keyed by panel id rather than a dedicated openX/hideX/toggleX method per panel.

Add a new panel by:

Module-augmenting PanelMap with its id, panel type, params type.
Calling register with a PanelProvider. Studio code never has to change.

Index

Constructors

constructor

Methods

get has hide open register toggle

Constructors

constructor

new PanelRegistry(ctx: PanelContext): PanelRegistry
Parameters
- ctx: PanelContext
Returns PanelRegistry
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:92

Methods

get

get<K extends keyof PanelMap>(
id: K,
params?: PanelEntry<K>["params"],
): PanelEntry<K>["panel"]
Locate the live instance for id without mounting one. Returns undefined when nothing is mounted.
Type Parameters
- K extends keyof PanelMap
Parameters
- id: K
- Optionalparams: PanelEntry<K>["params"]
Returns PanelEntry<K>["panel"]
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:172

has

has(id: string): boolean
True when a provider is registered for id.
Parameters
- id: string
Returns boolean
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:183

hide

hide<K extends keyof PanelMap>(id: K, params?: PanelEntry<K>["params"]): void
Hide (without destroying) the panel registered under id, if one is currently mounted. No-op when nothing is mounted.
Type Parameters
- K extends keyof PanelMap
Parameters
- id: K
- Optionalparams: PanelEntry<K>["params"]
Returns void
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:136

open

open<K extends keyof PanelMap>(
id: K,
params?: PanelEntry<K>["params"],
): PanelEntry<K>["panel"]
Open (or reveal) the panel registered under id.

If the panel is already mounted, ensures it's visible and runs the provider's onReveal hook; otherwise constructs a new one via the provider's create. Returns undefined when a provider's preconditions reject construction.
Type Parameters
- K extends keyof PanelMap
Parameters
- id: K
- Optionalparams: PanelEntry<K>["params"]
Returns PanelEntry<K>["panel"]
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:114

register

register<K extends keyof PanelMap>(
    id: K,
    provider: PanelProvider<
        PanelEntry<K>["params"],
        PanelEntry<K>["panel"] & PanelLike,
    >,
): void
Register a panel provider under the given id. Re-registering an existing id replaces the previous provider — useful for tests and for SDK consumers that want to swap a built-in.
Type Parameters
- K extends keyof PanelMap
Parameters
- id: K
- provider: PanelProvider<PanelEntry<K>["params"], PanelEntry<K>["panel"] & PanelLike>
Returns void
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:99

toggle

toggle<K extends keyof PanelMap>(
id: K,
params?: PanelEntry<K>["params"],
): PanelEntry<K>["panel"]
Toggle the panel registered under id. Constructs the panel on first call; once mounted, flips its visibility via the panel's own toggle.
Type Parameters
- K extends keyof PanelMap
Parameters
- id: K
- Optionalparams: PanelEntry<K>["params"]
Returns PanelEntry<K>["panel"]
- Defined in packages/sdk/src/studio/panels/PanelRegistry.ts:151

Class PanelRegistry

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PanelRegistry

Methods

get

Type Parameters

Parameters

Returns PanelEntry<K>["panel"]

has

Parameters

Returns boolean

hide

Type Parameters

Parameters

Returns void

open

Type Parameters

Parameters

Returns PanelEntry<K>["panel"]

register

Type Parameters

Parameters

Returns void

toggle

Type Parameters

Parameters

Returns PanelEntry<K>["panel"]

Settings

On This Page