panels/catalog

The panel catalog: every panel a layout can show, in the order every layout shows them, with what decides whether the page shows it and what it draws. A layout decides only the arrangement and the skin: the sidebar folds each panel into a section, the toolbar puts the settings panels in its card of tabs, floats what floats beside its bar, and lists the rest in its menu. Adding a panel is one entry here.

The stream toggles every layout carries (video, audio, microphone, webcam, and the gamepad input) are a catalog of their own, STREAMS.

InterfacesCopy Anchor Link

PanelContextCopy Anchor Link

Defined in: panels/catalog.ts:34

What decides whether a panel shows.

PropertiesCopy Anchor Link

dCopy Anchor Link

d: DashboardState;

Defined in: panels/catalog.ts:35

panelsCopy Anchor Link

panels: any;

Defined in: panels/catalog.ts:37

Which settings panels and cards have anything to show.

sCopy Anchor Link

s: any;

Defined in: panels/catalog.ts:38

primaryCopy Anchor Link

primary: boolean;

Defined in: panels/catalog.ts:40

This page is the primary display's, not a second screen's.

PanelCardCopy Anchor Link

Defined in: panels/catalog.ts:44

One card of a settings panel: a section lists the cards one after the other, a tab folds them in an accordion.

PropertiesCopy Anchor Link

valueCopy Anchor Link

value: string;

Defined in: panels/catalog.ts:45

titleCopy Anchor Link

title: string;

Defined in: panels/catalog.ts:47

Dictionary key of its title.

shownCopy Anchor Link

shown: (ctx) => boolean;

Defined in: panels/catalog.ts:48

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

BodyCopy Anchor Link

Body: ComponentType;

Defined in: panels/catalog.ts:49

PanelSpecCopy Anchor Link

Defined in: panels/catalog.ts:53

One panel of the catalog.

PropertiesCopy Anchor Link

idCopy Anchor Link

id: string;

Defined in: panels/catalog.ts:54

contentIdCopy Anchor Link

contentId: string;

Defined in: panels/catalog.ts:56

The id of its content element, which the suites address.

titleCopy Anchor Link

title: string;

Defined in: panels/catalog.ts:58

Dictionary key of its title.

tab?Copy Anchor Link

tab?: string;

Defined in: panels/catalog.ts:60

Dictionary key of its short name, where a layout tabs it.

icon?Copy Anchor Link

icon?: LucideIcon;

Defined in: panels/catalog.ts:62

Its mark in a menu or on a bar.

kindCopy Anchor Link

kind: "settings" | "stats" | "panel";

Defined in: panels/catalog.ts:68

settings: the stream's settings, in cards. stats: the stats, which a layout lays out itself (LayoutSpec.stats over the stream). panel: anything else, drawn by Body.

shownCopy Anchor Link

shown: (ctx, place) => boolean;

Defined in: panels/catalog.ts:69

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

cards?Copy Anchor Link

cards?: PanelCard[];

Defined in: panels/catalog.ts:70

Body?Copy Anchor Link

Body?: ComponentType<{
  place: PanelPlace;
}>;

Defined in: panels/catalog.ts:71

dialog?Copy Anchor Link

dialog?: "apps" | "files";

Defined in: panels/catalog.ts:73

A menu opens this dialog rather than drawing the body.

menuClass?Copy Anchor Link

menuClass?: string;

Defined in: panels/catalog.ts:75

Classes of the menu popup that draws the body, where it needs a width of its own.

floats?Copy Anchor Link

floats?: boolean;

Defined in: panels/catalog.ts:77

A layout with a bar floats it beside the bar rather than listing it in a menu.

StreamSpecCopy Anchor Link

Defined in: panels/catalog.ts:153

One stream toggle of the catalog.

PropertiesCopy Anchor Link

idCopy Anchor Link

id: string;

Defined in: panels/catalog.ts:154

iconCopy Anchor Link

icon: LucideIcon;

Defined in: panels/catalog.ts:155

labelCopy Anchor Link

label: string;

Defined in: panels/catalog.ts:157

Dictionary key of its name in a menu.

enableCopy Anchor Link

enable: string;

Defined in: panels/catalog.ts:159

Dictionary keys of what a press does, while off and while on.

disableCopy Anchor Link

disable: string;

Defined in: panels/catalog.ts:160

input?Copy Anchor Link

input?: boolean;

Defined in: panels/catalog.ts:162

An input rather than a stream: a layout that floats the gamepads panel toggles it there.

allowedCopy Anchor Link

allowed: (r) => boolean;

Defined in: panels/catalog.ts:164

Whether the server lets the page toggle it (renderable).

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

onCopy Anchor Link

on: (d) => boolean;

Defined in: panels/catalog.ts:165

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

toggleCopy Anchor Link

toggle: (d) => void;

Defined in: panels/catalog.ts:166

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

Type AliasesCopy Anchor Link

PanelPlaceCopy Anchor Link

type PanelPlace = "section" | "menu" | "float";

Defined in: panels/catalog.ts:31

Where a panel is drawn: a section of its own, a menu's popup, or a panel floating beside a bar.

VariablesCopy Anchor Link

PANELSCopy Anchor Link

const PANELS: PanelSpec[];

Defined in: panels/catalog.ts:80

STREAMSCopy Anchor Link

const STREAMS: StreamSpec[];

Defined in: panels/catalog.ts:170

The stream toggles, in order: the streams, then the gamepad input.

FunctionsCopy Anchor Link

usePanelContext()Copy Anchor Link

function usePanelContext(): PanelContext;

Defined in: panels/catalog.ts:142

What every panel's shown reads, from the shared state.

ReturnsCopy Anchor Link

PanelContext

shownCards()Copy Anchor Link

function shownCards(panel, ctx): PanelCard[];

Defined in: panels/catalog.ts:148

The cards of a settings panel the page shows.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

PanelCard[]