YuvWidgetGridComponent
Component Metadata
Section titled “Component Metadata”Selector: yuv-widget-grid
Standalone: No
Implements: OnInit
Inputs
Section titled “Inputs”buckets
Section titled “buckets”Type: string[] | undefined
Default Value: undefined
Collection of buckets to load available widgets from. Wildcards are also possible: [buckets]="['app.default', '*.public.*', 'app.no?.widgets']"``* represents any character 0-n times ? represents exactly one character
editMode
Section titled “editMode”Type: boolean
Default Value: false
Whether or not to enable edit mode. In edit mode controls for editing existing tiles and creating new ones are shown. This mode also enables positioning and resizing of the tiles.
gridConfig
Section titled “gridConfig”Type: Partial<WidgetGridConfig> | undefined
gridItemConfig
Section titled “gridItemConfig”Type: WidgetGridItemConfig[] | undefined
Default Value: undefined
Outputs
Section titled “Outputs”gridChange
Section titled “gridChange”Type: WidgetGridItemConfig[]
Emitted when the grid has been changed
gridItemEvent
Section titled “gridItemEvent”Type: GridItemEvent
widgetPickerOpen
Section titled “widgetPickerOpen”Type: boolean
Emitted when the widget picker is opened or closed in edit mode
Properties
Section titled “Properties”_editMode
Section titled “_editMode”Type: unknown
Default Value: signal<boolean>(false)
gridster
Section titled “gridster”Type: unknown
Default Value: viewChild(Gridster)
options
Section titled “options”Type: unknown
Default Value: signal<GridsterConfig>(\{ gridType: GridType.Fit, displayGrid: DisplayGrid.None, pushItems: false, outerMargin: false, swap: false, draggable: \{ enabled: false, ignoreContent: true, dragHandleClass: 'dragHandle' \}, resizable: \{ enabled: false \}, // eslint-disable-next-line @typescript-eslint/no-unused-vars itemChangeCallback: (item: GridsterItemConfig, itemComponent: GridsterItem) => \{ this.#emitChange(); \} \})
Held as a signal so gridster’s options InputSignal sees a new reference whenever edit mode or grid config changes. Mutating the inner object would keep the same reference and gridster’s $options computed would never recompute — leaving draggable/resizable stuck at their initial false.
widgetGrid
Section titled “widgetGrid”Type: WidgetGridItem[]
Default Value: []
widgetPicker
Section titled “widgetPicker”Type: unknown
Default Value: viewChild.required('widgetPicker', \{ read: TemplateRef \})
widgetPickerData
Section titled “widgetPickerData”Type: WidgetPickerData | undefined
Methods
Section titled “Methods”onAddItem
Section titled “onAddItem”Add a new widget to the grid by opening the widget picker
onAddItem(): voidonOpenWidgetPicker
Section titled “onOpenWidgetPicker”onOpenWidgetPicker(item?: WidgetGridItem): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| item | WidgetGridItem |
onRemoveItem
Section titled “onRemoveItem”Removes a widget from the grid
onRemoveItem(item: WidgetGridItem): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| item | WidgetGridItem |