widget
widget
Section titled “widget”| Field | Value |
|---|---|
| Prefix | widget |
| Namespace constant | WidgetNamespace |
| Subjects constant | WidgetSubjects |
| Kind | bus |
| Schema record | WidgetSchemas |
| Tier | framework |
| Package | @makaio/ui-kernel |
| Defined in | ui/kernel/src/widgets/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
list | widget.list | rpc | schemas.ts |
register | widget.register | event | schemas.ts |
unregister | widget.unregister | event | schemas.ts |
Subject Details
Section titled “Subject Details”widget.list (rpc)
Section titled “widget.list (rpc)”List all registered widgets.
Subject: widget.list
Type: Local request (RPC, never sent to transports)
Purpose: Query available widgets, optionally filtered by scope.
Request:
| Field | Type | Required |
|---|---|---|
scope | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
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 |
widget.register (event)
Section titled “widget.register (event)”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.
| Field | Type | Required |
|---|---|---|
allowMultiple | boolean | undefined | no |
component | {} | null | yes |
defaultConfig | unknown | no |
defaultSize | "small" | "medium" | "large" | "full-width" | yes |
description | string | undefined | no |
id | string | yes |
name | string | yes |
scope | string | string[] | yes |
supportedSizes | ("small" | "medium" | "large" | "full-width")[] | yes |
widget.unregister (event)
Section titled “widget.unregister (event)”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.
| Field | Type | Required |
|---|---|---|
widgetId | string | yes |
Auto-generated by yarn docs:bus. Do not edit manually.