Skip to content

widget

FieldValue
Prefixwidget
Namespace constantWidgetNamespace
Subjects constantWidgetSubjects
Kindbus
Schema recordWidgetSchemas
Tierframework
Package@makaio/ui-kernel
Defined inui/kernel/src/widgets/namespace.ts
KeyWireTypeSchema
listwidget.listrpcschemas.ts
registerwidget.registereventschemas.ts
unregisterwidget.unregistereventschemas.ts

List all registered widgets.

Subject: widget.list Type: Local request (RPC, never sent to transports) Purpose: Query available widgets, optionally filtered by scope.

Request:

FieldTypeRequired
scopestring | undefinedno

Response:

FieldTypeRequired
widgets{ id: string; name: string; scope: string | string[]; supportedSizes: ("small" | "medium" | "large" | "full-width")[]; defaultSize: "small" | "medium" | "large" | "full-width"; component: {} | null; description?: string | undefined; defaultConfig?: unknown; allowMultiple?: boolean | undefined; }[]yes

Register a widget.

Subject: widget.register Type: Local event (fire-and-forget, never sent to transports) Purpose: Plugins or built-in widgets emit this to register themselves.

FieldTypeRequired
allowMultipleboolean | undefinedno
component{} | nullyes
defaultConfigunknownno
defaultSize"small" | "medium" | "large" | "full-width"yes
descriptionstring | undefinedno
idstringyes
namestringyes
scopestring | string[]yes
supportedSizes("small" | "medium" | "large" | "full-width")[]yes

Unregister a widget.

Subject: widget.unregister Type: Local event (fire-and-forget, never sent to transports) Purpose: Remove a widget from the registry by ID.

FieldTypeRequired
widgetIdstringyes

Auto-generated by yarn docs:bus. Do not edit manually.