Interface: SidebarItem

Defined in: module-registry/public-types.ts:61

A declarative entry a module contributes to the left "Places" sidebar. Serializable - crosses the worker boundary. Clicking navigates to path or runs command (provide one).

Properties

category?

optional category?: string;

Defined in: module-registry/public-types.ts:67

Group header. Use SidebarCategories or any custom string.

command?

optional command?: string;

Defined in: module-registry/public-types.ts:71

Or run this command id when clicked.

icon?

optional icon?: string;

Defined in: module-registry/public-types.ts:65

Icon registry key (e.g. "cloud", "folder") or an emoji.

id

id: string;

Defined in: module-registry/public-types.ts:62

label

label: string;

Defined in: module-registry/public-types.ts:63

path?

optional path?: string;

Defined in: module-registry/public-types.ts:69

Navigate here when clicked.

removable?

optional removable?: boolean;

Defined in: module-registry/public-types.ts:76

Show a remove (✕) affordance. Clicking it emits "sidebar:item-remove" with this item's id - the owning module listens and updates its dynamic items.