Skip to main content

@thatopen/ui

Classes

ClassDescription
ButtonA custom button web component for BIM applications. HTML tag: bim-button
CheckboxA custom checkbox web component for BIM applications. HTML tag: bim-checkbox
ColorInputA custom color input web component for BIM applications. HTML tag: bim-color-input
ComponentA base class for UI components that utilizes the LitElement library. Provides functionality for rendering stateless and stateful components, as well as lazy loading of elements using Intersection Observer.
DropdownA custom dropdown web component for BIM applications.
GridA custom grid component for web applications.
IconA custom icon web component for BIM applications. HTML tag: bim-icon
InputA custom input web component for BIM applications. HTML tag: bim-input
LabelA custom label web component for BIM applications. HTML tag: bim-label
ManagerManager class is responsible for initializing the BIM UI library, defining custom elements, and providing configuration options.
NumberInputA custom number input web component for BIM applications. HTML tag: bim-number-input
OptionA custom option web component for BIM applications. HTML tag: bim-option
PanelA custom panel web component for BIM applications. HTML tag: bim-panel
PanelSectionA custom panel section web component for BIM applications. HTML tag: bim-panel-section
SelectorA custom selector web component for BIM applications. HTML tag: bim-selector
TabA custom tab web component for BIM applications. HTML tag: bim-tab
TableA custom table web component for BIM applications. HTML tag: bim-table
TabsA custom tabs web component for BIM applications. HTML tag: bim-tabs
TextInputA custom text input web component for BIM applications. HTML tag: bim-text-input
ToolbarA custom toolbar web component for BIM applications. HTML tag: bim-toolbar
ToolbarGroupA custom toolbar group web component for BIM applications. HTML tag: bim-toolbar-group
ToolbarSectionA custom toolbar section web component for BIM applications. HTML tag: bim-toolbar-section
ViewportA custom viewport web component for BIM applications. HTML tag: bim-viewport

Interfaces

InterfaceDescription
CellCreatedEventDetailRepresents the detail of a cell created event.
ColumnDataRepresents a column in the table.
EntryQueryRepresents a single query condition.
HasNameRepresents an object that has a name and an optional label.
HasValueRepresents an object that has a value and an event for value changes.
ManagerConfigConfiguration interface for the Manager class. Defines the properties and their types that can be configured for the Manager.
QueryGroupRepresents a group of queries with an operator.
RowCreatedEventDetailRepresents the detail of a row created event.
RowDeselectedEventDetailRepresents the detail of a row deselected event.
RowSelectedEventDetailRepresents the detail of a row selected event.
TableGroupDataRepresents a group of table rows with optional children.
TableGroupTemplateRepresents a template for rendering a group of table rows in a table.

Type Aliases

Type aliasDescription
ConditionFunctionsRepresents a map of condition functions, where the key is a QueryCondition and the value is a function that evaluates the condition.
GridLayoutsDefinitionRepresents a collection of predefined grid layouts for the Grid component. Each layout is defined by a unique name, a grid template string, and a map of area names to HTMLElement instances. The grid template string defines the structure of the grid, and the area names correspond to the grid-area property of the HTMLElement instances. The HTMLElement instances are used to populate the grid with content.
QueryRepresents a query, which can be a single query or a group of queries.
QueryConditionRepresents a condition used in query building.
QueryOperatorsRepresents an operator used in query building.
StatefullComponentRepresents a function that returns a TemplateResult for a stateful component.
StatelessComponentRepresents a function that returns a TemplateResult for a stateless component.
TableDataTransformRepresents a transformation function for table data.
TableRowDataRepresents a row of data for a table.
TableRowTemplateRepresents a template for rendering a row of data in a table.

Functions

FunctionDescription
getElementValueExtracts and returns the value of an HTML element's attributes.