v1.ContainerWidget
export interface ContainerWidget
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | (Optional) An optional width of the widget within the grid. When the parent container’s direction is set to ‘row’, widget widths can vary up to the width of the container. Widgets are placed next to each other and wrap to the next row when their combined width exceeds that of the container. When the direction is set to ‘column’, the width does not need to be set, or it should match the width of the container. | ||
boolean | (Optional) Whether header of sections in the layout is enabled. Defaults to true | ||
“row” | “column” | (Optional) Layout direction for the container widgets | ||
number | (Optional) An optional height of the widget within the grid, where each row is approximately 20px high. When the parent container’s direction is ‘row’, the height should be greater than the total height of all rows formed by wrapped widgets in the container where row height is determined by highest widget in the row. When the direction is ‘column’, each widget occupies one row; therefore, the height must be equal to or greater than the combined height of all widgets in the container. | ||
{ title?: string; description?: string; widgets: Widget[]; }[] | A list of sections contained in this container |
Property details
v1.ContainerWidget.columnsproperty
An optional width of the widget within the grid. When the parent container’s direction is set to ‘row’, widget widths can vary up to the width of the container. Widgets are placed next to each other and wrap to the next row when their combined width exceeds that of the container. When the direction is set to ‘column’, the width does not need to be set, or it should match the width of the container.
columns?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
v1.ContainerWidget.containerproperty
container: Id14;
v1.ContainerWidget.enable_section_headersproperty
Whether header of sections in the layout is enabled. Defaults to true
enable_section_headers?: boolean;
v1.ContainerWidget.layout_directionproperty
Layout direction for the container widgets
layout_direction?: "row" | "column";
v1.ContainerWidget.rowsproperty
An optional height of the widget within the grid, where each row is approximately 20px high. When the parent container’s direction is ‘row’, the height should be greater than the total height of all rows formed by wrapped widgets in the container where row height is determined by highest widget in the row. When the direction is ‘column’, each widget occupies one row; therefore, the height must be equal to or greater than the combined height of all widgets in the container.
rows?: number;
v1.ContainerWidget.sectionsproperty
A list of sections contained in this container
sections: {
title?: string;
description?: string;
widgets: Widget[];
}[];