TComponents

TComponents Namespace

Classes

Accessors_A
Base_A
Button
CheckboxGroup_A
Checkbox_A
Component_A
Container_A
DigitalLed
DropDown
DroppablePlaceholder_A
Eventing_A
Hamburger
Image
Input
LayoutInfobox
Menu_A
MultiView
Page
Pdf
Popup_A
Radio
Select
Slider
Switch
Tab
Table
Text
Toggle_A
VarIncrDecr
VarSlider
View_A

Methods

tComponentsLoadCSS(href)

Loads a CSS file

Parameters:
NameTypeDescription
hrefstring

Path of css file

Type Definitions

ButtonProps

Properties
NameTypeAttributesDescription
onClickfunction<optional>

Function to be called when button is pressed

iconstring | null<optional>

Path to image file

textstring<optional>

Button text

colorstring<optional>

Button text color

backgroundColorstring<optional>

Button background color

borderstring<optional>

Button border style

borderRadiusnumber<optional>

Button border radius

onPointerReleasefunction<optional>

Function to be called when pointer is released

onPointerDownfunction<optional>

Function to be called when pointer is pressed down

tipsstring<optional>

Tooltip text for the button

fontobject<optional>

Font properties for the button text This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
optionsobject<optional>

Additional options for the button Items in this object include:

  • responsive (boolean, default: false): Whether the button is responsive
onCreatedfunction<optional>

Function to be called when the button is created

onMountedfunction<optional>

Function to be called when the button is mounted

functionalityobject<optional>

Configuration object for component functionality. This object contains settings to control the component's behavior:

  • type (string): Defines the specific type of functionality to enable.
  • params (string): Additional parameters or arguments required by the functionality type.
  • isHidden (boolean, default: false): If true, the functionality is visually hidden from the user interface.
positionstring<optional>

CSS position property, default is 'static'

widthnumber<optional>

Button width in pixels, default is 100

heightnumber<optional>

Button height in pixels, default is 32

topnumber<optional>

Button top position in pixels, default is 0

leftnumber<optional>

Button left position in pixels, default is 0

rotationnumber<optional>

Button rotation in degrees, default is 0

zIndexnumber<optional>

Button z-index, default is 0

sizestring<optional>

Size style template

styleTemplatestring<optional>

Style template

defaultStatestring<optional>

Default state of the button, default is 'show_enable'

dataStructstring<optional>

Data structure associated with the button

CheckboxGroupProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the component Items in this object include:

  • responsive (boolean, default: false): Whether the checkbox group should be responsive
tipsstring<optional>

Tooltip text for the component

onCreatedfunction<optional>

Function to be called when the component is created

onMountedfunction<optional>

Function to be called when the component is mounted

onChangefunction<optional>

Function to be called when checkbox state changes

positionstring<optional>

CSS position property

widthnumber<optional>

Width of the component

heightnumber<optional>

Height of the component

topnumber<optional>

Top position of the component

leftnumber<optional>

Left position of the component

rotationnumber<optional>

Rotation angle of the component

zIndexnumber<optional>

Z-index of the component

borderRadiusnumber<optional>

Invalid attribute. Border radius of the component.

colorstring<optional>

Text color of the component

fontobject<optional>

Font properties of the component This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
optionItemsstring<optional>

Formatted string representing the checkbox options

optionConfigobject<optional>

Configuration for dynamic options This object controls how options are provided:

  • mode (string, default: 'fixed'): Options mode, e.g. 'fixed', 'sync', 'initialize'
  • type (string): Data source type
  • isHidden (boolean, default: false): Whether the option configuration is hidden
  • variablePath (string): Path of the variable used for dynamic options
defaultStatestring<optional>

Default state of the component

dataStructstring<optional>

Data structure associated with the component

CheckboxProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the checkbox component Items in this object include:

  • responsive (boolean, default: false): Whether the checkbox should be responsive
onCreatedfunction<optional>

Function to be called when the component is created

onMountedfunction<optional>

Function to be called when the component is mounted

onChangefunction<optional>

Function to be called when checkbox state changes

positionstring<optional>

CSS position property

topnumber<optional>

Top position in pixels

leftnumber<optional>

Left position in pixels

borderRadiusnumber<optional>

Border radius of the component

rotationnumber<optional>

Rotation of the component in degrees

zIndexnumber<optional>

Z-index of the component

textstring<optional>

Checkbox text

valuestring<optional>

Checkbox value

selectedIndexnumber<optional>

Invalid attribute.

colorstring<optional>

Color of the checkbox text

fontobject<optional>

Font settings for the checkbox text This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
inputVarobject<optional>

Data binding configuration This object configures the bound input variable:

  • type (string): Input variable type. Default is Component_A.INPUTVAR_TYPE.BOOL
  • func (string): Binding behavior. Default is Component_A.INPUTVAR_FUNC.CUSTOM
  • value (*): Initial bound value, default is 0
  • isHidden (boolean, default: false): Whether the variable is hidden
enabledboolean<optional>

Whether the checkbox is enabled

checkedboolean<optional>

Checked state of the checkbox

dataStructstring<optional>

Data structure name for binding

ComponentProps

Properties
NameTypeAttributesDescription
labelstring<optional>

Label text

labelPosstring<optional>

Label position: "top|bottom|left|right|top-center|bottom-center"

optionsobject<optional>

A set of options to modify the behaviour of the component

  • async : if true, the subcomponents are instantiated asynchronously and onRender is executed inmediatelly without waiting for the subcomponents to finish.

ContainerProps

Properties
NameTypeAttributesDescription
childrenTComponents.Component_A | HTMLElement | Array.<TComponents.Component_A> | Array.<HTMLElement><optional>
boxboolean<optional>

If true, the container will have a box around it

widthstring<optional>

Width of the container. Default value is “auto”.

heightstring<optional>

Height of the container. Default value is “auto”.

classNamesstring<optional>

Additional class names to be added to the container. It can be a string, e.g. 'flex-row items-start justify-start', or an array of strings, e.g. ['flex-row', 'items-start', 'justify-start']

idstring<optional>

Name of container (optional). For instance, if container is part of a layout, the name of the prop corresponding to the container shall be given further to the container. The name will be then exposed in the DOM element as data-name attribute.

DropdownProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the dropdown component Items in this object include:

  • responsive (boolean, default: false): Whether the dropdown should be responsive
tipsstring<optional>

Tooltip text for the component

onCreatedfunction<optional>

Function to be called when the component is created

onMountedfunction<optional>

Function to be called when the component is mounted

onChangefunction<optional>

Function to be called when dropdown value is changed

positionstring<optional>

CSS position property

widthnumber<optional>

Width of the component

heightnumber<optional>

Height of the component

topnumber<optional>

Top position of the component

leftnumber<optional>

Left position of the component

borderRadiusnumber<optional>

Border radius of the component

rotationnumber<optional>

Rotation angle of the component

zIndexnumber<optional>

Z-index of the component

iconstring | null<optional>

Prefix icon for the dropdown

textstring<optional>

Dropdown text

colorstring<optional>

Text color of the dropdown

backgroundColorstring<optional>

Background color of the dropdown

fontobject<optional>

Font settings for the dropdown text This object controls text appearance:

  • fontSize (number, default: 16): Font size of the displayed text
  • fontFamily (string, default: 'Arial'): Font family of the displayed text
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration
  • textAlign (string, default: 'center'): Text alignment inside the dropdown
optionItemsstring<optional>

Options for the dropdown in the format text1|value1;\\ntext2|value2;\\ntext3|value3

optionConfigobject<optional>

Configuration for dynamic options This object controls how options are provided:

  • mode (string, default: 'fixed'): Options mode, e.g. 'fixed' or 'variable'
  • type (string): Data source type
  • isHidden (boolean, default: false): Whether the option configuration is hidden
  • variablePath (string): Path of the variable used for dynamic options
optionIconsArray.<Object><optional>

Icon configuration for each option

optionActionsArray.<string><optional>

Action configuration for each option

defaultStatestring<optional>

Default state of the component

showArrowboolean<optional>

Whether to show the dropdown arrow

dataStructstring<optional>

Data structure associated with the component

DroppablePlaceholderProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Configuration options for the placeholder component. Items in this object include:

  • responsive (boolean, default: false): Whether the placeholder should be responsive.
positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

zIndexnumber<optional>

Z-index of the component.

borderstring<optional>

Border style of the component.

borderRadiusnumber<optional>

Border radius of the component.

backgroundColorstring<optional>

Background color of the component.

contentobject<optional>

Layout configuration for the placeholder content. This object controls how child components are arranged:

  • children (string[]): Identifiers of child components inside the placeholder.
  • row (boolean, default: true): Whether to arrange children in a row.
  • box (boolean, default: false): Whether to use box layout.
  • width (string, default: '100%'): Content width.
  • height (string, default: '100%'): Content height.
  • classNames (string[]): Extra class names applied to the content container.
childrenArray<optional>

Additional mapped child components.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

HamburgerProps

Properties accepted by the Hamburger component, defining its appearance, behavior, and lifecycle hooks. This class focuses on the specific properties of the Hamburger component. Since it inherits from Accessor_A, all basic properties (e.g., height, width) are available but documented in the Accessor_A part.

Type:
  • object
Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the hamburger component. Items in this object include:

  • responsive (boolean, default: false): Whether the hamburger should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Lifecycle hook invoked after component instantiation.

onMountedfunction<optional>

Lifecycle hook invoked after component is attached to the DOM.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the menu container.

heightnumber<optional>

Height of the menu container.

topnumber<optional>

Top offset in pixels.

leftnumber<optional>

Left offset in pixels.

borderRadiusnumber<optional>

Border radius in pixels.

rotationnumber<optional>

Rotation in degrees.

zIndexnumber<optional>

CSS z-index.

borderstring<optional>

CSS border shorthand.

colorstring<optional>

CSS text color.

backgroundColorstring<optional>

CSS background color.

fontobject<optional>

Font configuration. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
sizestring<optional>

Preset size key for the component.

styleTemplatestring<optional>

Key of a style template to apply.

useTitleboolean<optional>

Whether to reserve space for the title.

titlestring<optional>

Title displayed next to the hamburger icon when the menu is opened.

alwaysVisibleboolean<optional>

Whether the hamburger menu stays visible even when closed.

activeViewIndexnumber<optional>

Zero-based index of the currently active view.

onChangefunction<optional>

Callback triggered when the active view changes.

useViewIconboolean<optional>

Whether to display an icon alongside each view label.

viewsArray.<TComponents.ViewProps><optional>

Array of view objects to populate the menu.

defaultStatestring<optional>

Default state of the component.

expandHeightToParentBottomboolean<optional>

Whether to expand the height to the parent's bottom.

ImageProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the image component. Items in this object include:

  • responsive (boolean, default: false): Whether the image should be responsive.
onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

imgSrcstring<optional>

Path to the image file.

imgStyleobject<optional>

Visual style configuration for the image. This object controls how the image is rendered:

  • objectFit (string, default: 'contain'): How the image should fit inside its container.
  • opacity (number, default: 1.0): Opacity of the image, from 0 to 1.
onClickfunction<optional>

Function to be called when the image is clicked.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

zIndexnumber<optional>

Z-index of the component.

rotationnumber<optional>

Rotation angle of the component.

borderRadiusnumber<optional>

Border radius of the component.

defaultStatestring<optional>

Default state of the component.

InputProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the input component. Items in this object include:

  • responsive (boolean, default: false): Whether the input should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

borderstring<optional>

Border style of the input field.

colorstring<optional>

Text color of the input field.

backgroundColorstring<optional>

Background color of the input field.

sizestring<optional>

Size style template of the component.

fontobject<optional>

Font settings for the input text. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
readOnlyboolean<optional>

Set to true to use the input field only for displaying values.

useBorderboolean<optional>

Whether to draw a border around the value.

regexobject<optional>

Regular expression configuration for validation. This object defines validation behavior:

  • label (string, default: 'no regex'): Description of the regex rule.
  • value (string): Regex pattern used to validate the input.
textstring<optional>

Initial value of the input field.

inputVarobject<optional>

Configuration object for input variable binding. This object configures the bound input variable:

  • type (string): Input variable type. Default is Component_A.INPUTVAR_TYPE.ANY.
  • func (string): Binding behavior. Default is Component_A.INPUTVAR_FUNC.CUSTOM.
  • value (string): Initial bound value.
  • isHidden (boolean, default: false): Whether the variable is hidden.
onChangefunction<optional>

Function to be called when the input value changes.

keyboardHelperDescstring<optional>

Description text shown in the keyboard helper.

defaultStatestring<optional>

Default state of the component.

dataStructstring<optional>

Data structure associated with the component.

LayoutInfoboxProps

Type:
  • object
Properties
NameTypeAttributesDescription
optionsobject<optional>

Options for the layout infobox component. Items in this object include:

  • responsive (boolean, default: false): Whether the infobox should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

zIndexnumber<optional>

Z-index of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

colorstring<optional>

Text color of the component.

backgroundColorstring<optional>

Background color of the component.

useTitleboolean<optional>

Whether to display the title area.

titlestring<optional>

Title of the infobox.

fontobject<optional>

Font settings for the title text. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
  • textAlign (string, default: 'left'): Text alignment of the title.
useBorderboolean<optional>

Whether to draw a border around the infobox.

borderstring<optional>

Border style of the infobox.

contentobject<optional>

Props to be passed to the internal content container. This object controls how child components are arranged:

  • children (string[]): Identifiers of child components inside the infobox.
  • row (boolean, default: true): Whether to arrange children in a row.
  • box (boolean, default: false): Whether to use box layout.
  • width (string, default: '100%'): Content width.
  • height (string, default: '100%'): Content height.
  • classNames (string[]): Extra class names applied to the content container.
defaultStatestring<optional>

Default state of the component.

expandHeightToParentBottomboolean<optional>

Whether to expand the height to the parent's bottom.

MenuProps

Properties accepted by the TComponents.Menu_A component, defining its appearance, behavior, and lifecycle hooks.

Type:
  • object
Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the menu component. Items in this object include:

  • responsive (boolean, default: false): Whether the menu should be responsive.
onCreatedfunction<optional>

Lifecycle hook invoked after component instantiation.

onMountedfunction<optional>

Lifecycle hook invoked after component is attached to the DOM.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the menu container.

heightnumber<optional>

Height of the menu container.

topnumber<optional>

Top offset in pixels.

leftnumber<optional>

Left offset in pixels.

borderRadiusnumber<optional>

Border radius in pixels.

rotationnumber<optional>

Rotation in degrees.

zIndexnumber<optional>

CSS z-index.

borderstring<optional>

CSS border shorthand.

colorstring<optional>

CSS text color.

backgroundColorstring<optional>

CSS background color.

fontobject<optional>

Font configuration. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
sizestring<optional>

Preset size key for the component.

styleTemplatestring<optional>

Key of a style template to apply.

useTitleboolean<optional>

Whether to reserve space for the title.

titlestring<optional>

Title displayed for the menu.

activeViewIndexnumber<optional>

Zero-based index of the currently active view.

onChangefunction | string<optional>

Callback triggered when the active view changes.

useViewIconboolean<optional>

Whether to display an icon alongside each view label.

viewsArray.<TComponents.ViewProps><optional>

Array of view objects to populate the menu.

defaultStatestring<optional>

Default state of the component.

PageProps

Properties
NameTypeAttributesDescription
onCreatedfunction<optional>

Function to be called when the page is created.

onMountedfunction<optional>

Function to be called when the page is mounted.

positionstring<optional>

CSS position property of the page.

widthnumber<optional>

Width of the page.

heightnumber<optional>

Height of the page.

topnumber<optional>

Top offset of the page.

leftnumber<optional>

Left offset of the page.

zIndexnumber<optional>

Z-index of the page.

backgroundColorstring<optional>

Background color of the page.

idstring<optional>

Unique identifier for the page.

namestring<optional>

Name of the page.

childrenArray.<any><optional>

Child components of the page.

PdfProps

Properties accepted by the Pdf component, defining its appearance, behavior, and lifecycle hooks. This class focuses on the specific properties of the Pdf component. Since it inherits from Accessor_A, all basic properties (e.g., height, width) are available but documented in the Accessor_A part.

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the pdf component. Items in this object include:

  • responsive (boolean, default: false): Whether the pdf container should be responsive.
onCreatedfunction | string<optional>

Lifecycle hook invoked after component instantiation.

onMountedfunction | string<optional>

Lifecycle hook invoked after component is attached to the DOM.

positionstring<optional>

CSS positioning of the element.

widthnumber<optional>

Component width.

heightnumber<optional>

Component height.

topnumber<optional>

Top offset in pixels.

leftnumber<optional>

Left offset in pixels.

rotationnumber<optional>

Rotation angle in degrees for visual transform.

borderRadiusnumber<optional>

Corner radius in pixels.

zIndexnumber<optional>

z-index stacking order.

pdfSrcstring<optional>

The source location of the pdf component.

emptyMessagestring<optional>

Message displayed when the content is empty.

RadioProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the radio component. Items in this object include:

  • responsive (boolean, default: false): Whether the radio group should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

onChangefunction<optional>

Callback function that is called when the selected radio option changes.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

functionalityobject<optional>

Configuration object for component functionality. This object contains settings to control the component's behavior:

  • types (Array): A list of functionality types enabled for the component.
  • params (Array): Additional parameters, each containing type, variablePath, isHidden.
colorstring<optional>

Text color of the component.

fontobject<optional>

Font settings for the radio labels. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
optionItemsstring<optional>

Radio options in the format text1|value1;text2|value2;text3|value3.

optionConfigobject<optional>

Configuration for dynamic radio options. This object controls how options are provided:

  • mode (string, default: 'fixed'): Options mode, e.g. 'fixed', 'sync', 'initialize'.
  • type (string): Type of the options data source.
  • isHidden (boolean, default: false): Whether this option configuration is hidden.
  • variablePath (string): Variable path used when options are dynamic.
defaultStatestring<optional>

Initial state of the component.

textstring<optional>

Current selected option value, corresponds to the value field in optionItems.

selectedIndexnumber<optional>

Index of the initially selected option, -1 means no option is selected.

inputVarobject<optional>

Input variable binding configuration. This object configures the bound input variable:

  • type (string): Binding variable type. Default is Component_A.INPUTVAR_TYPE.ANY.
  • func (string): Binding mode. Default is Component_A.INPUTVAR_FUNC.CUSTOM.
  • value (string): Initial value or variable path used for binding.
  • isHidden (boolean, default: false): Whether this binding is hidden in variable selectors.
dataStructstring<optional>

Data structure associated with the component.

SelectProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the select component. Items in this object include:

  • responsive (boolean, default: false): Whether the select should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

onChangefunction<optional>

Callback function that is called when the selected option changes.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

functionalityobject<optional>

Configuration object for component functionality. This object contains settings to control the component's behavior:

  • types (Array): A list of functionality types enabled for the component.
  • params (Array): Additional parameters, each containing type, variablePath, isHidden.
sizestring<optional>

Size style template for the component.

labelPosstring<optional>

Position of the label relative to the select component.

placeHolderstring<optional>

Placeholder text shown when no option is selected.

colorstring<optional>

Font color of the selected text.

fontobject<optional>

Font configuration for the selected text. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
  • textAlign (string, default: 'left'): Text alignment of the text.
borderstring<optional>

CSS border style of the select element.

valueany<optional>

Invalid attribute.

optionItemsstring<optional>

Options list in the format text1|value1;\\ntext2|value2;\\ntext3|value3.

optionConfigobject<optional>

Configuration for dynamic options. This object controls how options are provided:

  • mode (string, default: 'fixed'): Options mode, e.g. 'fixed', 'sync', 'initialize'.
  • type (string): Type of the options data source.
  • isHidden (boolean, default: false): Whether this option configuration is hidden.
  • variablePath (string): Variable path used when options are dynamic.
  • sync (boolean, default: true): Whether to synchronize the options with the data source.
textstring<optional>

Current selected option value, corresponds to the value field in optionItems.

selectedIndexnumber<optional>

Index of the initially selected option.

inputVarobject<optional>

Input variable binding configuration. This object configures the bound input variable:

  • type (string): Binding variable type. Default is Component_A.INPUTVAR_TYPE.ANY.
  • func (string): Binding mode. Default is Component_A.INPUTVAR_FUNC.CUSTOM.
  • value (string): Initial value or variable path used for binding.
  • isHidden (boolean, default: false): Whether this binding is hidden in variable selectors.
defaultStatestring<optional>

Initial state of the component.

dataStructstring<optional>

Data structure associated with the component.

SignalIndicatorProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the digital LED component. Items in this object include:

  • responsive (boolean, default: false): Whether the component should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

borderRadiusnumber<optional>

Invalid attribute. Border radius of the component.

colorstring<optional>

The color of the digital LED component.

sizestring<optional>

Size style template of the component.

fontobject<optional>

Font settings for the digital LED component. This object controls text appearance:

  • fontSize (number, default: 20): Font size of the displayed text.
  • fontFamily (string, default: 'Segoe UI'): Font family of the displayed text.
textstring | number | boolean<optional>

The text value displayed by the digital LED component.

inputVarobject<optional>

Configuration object for input variable binding. This object configures the bound input variable:

  • type (string): Input variable type. Default is Component_A.INPUTVAR_TYPE.BOOL.
  • func (string): Binding behavior. Default is Component_A.INPUTVAR_FUNC.CUSTOM.
  • value (string): Initial bound value, default is '0'.
  • isHidden (boolean, default: false): Whether the variable is hidden.
onChangestring<optional>

Please use onClick, the change event will be deprecated soon. A string representing a function to be called when the signal changes its state.

onClickstring<optional>

A string representing a function to be called when the component is clicked.

readOnlyboolean<optional>

Indicates whether the digital LED component is read-only.

defaultStatestring<optional>

The default state of the component when initialized.

alignstring<optional>

The alignment of the digital LED component within its container.

dataStructstring<optional>

The data structure associated with the component.

SliderProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

General options for the slider behavior. Items in this object include:

  • responsive (boolean, default: false): Whether the slider width should adapt to the container width.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

onPointerReleasefunction<optional>

Callback function that is called when the pointer is released after dragging the slider.

onPointerDownfunction<optional>

Callback function that is called while the pointer is dragging the slider.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

colorstring<optional>

Font color of the description label.

fontobject<optional>

Font configuration for the description label. This object controls text appearance:

  • fontSize (number, default: 14): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
rangeValueColorstring<optional>

Font color of the min/max range values.

rangeValueFontobject<optional>

Font configuration for the min/max range values. This object controls range text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
backgroundColorstring<optional>

Background color of the slider container.

borderstring<optional>

CSS border style of the slider container.

displayLabelboolean<optional>

Whether to display the description label.

descrLabelstring<optional>

Text content of the description label.

displayValueboolean<optional>

Whether to display the current value label.

valuenumber<optional>

Current value of the slider.

minnumber<optional>

Minimum value of the slider range.

maxnumber<optional>

Maximum value of the slider range.

enabledboolean<optional>

Whether the slider is enabled and interactive.

activeColorstring<optional>

Color of the active (filled) part of the slider track.

inactiveColorstring<optional>

Color of the inactive part of the slider track.

displayTicksboolean<optional>

Whether to display tick marks along the track.

tickStepnumber<optional>

Step between tick marks and value increments.

defaultStatestring<optional>

Initial state of the component.

SwitchProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the switch component. Items in this object include:

  • responsive (boolean, default: false): Whether the switch should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

borderRadiusnumber<optional>

Invalid attribute. Border radius of the component.

textstring | number | boolean<optional>

Text value bound to the switch state.

inputVarobject<optional>

Input variable binding configuration. This object configures the bound input variable:

  • type (string): Binding variable type. Default is 'bool'.
  • func (string): Binding mode. Default is 'custom'.
  • value (string): Initial value or variable path used for binding.
  • isHidden (boolean, default: false): Whether this binding is hidden in variable selectors.
onChangefunction<optional>

Function to be called when the switch state changes.

readOnlyboolean<optional>

Indicates whether the switch is read-only.

defaultStatestring<optional>

Initial state of the component.

alignstring<optional>

Alignment of the switch inside its container.

dataStructstring<optional>

Custom data structure metadata for integration with other systems.

TabProps

Properties accepted by the Tab component, defining its appearance, behavior, and lifecycle hooks. This class focuses on the specific properties of the Tab component. Since it inherits from Accessor_A, all basic properties (e.g., height, width) are available but documented in the Accessor_A part.

Type:
  • object
Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the tab component. Items in this object include:

  • responsive (boolean, default: false): Whether the tab container should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction | string<optional>

Lifecycle hook invoked after component instantiation.

onMountedfunction | string<optional>

Lifecycle hook invoked after component is attached to the DOM.

positionstring<optional>

CSS positioning of the element.

widthnumber<optional>

Component width.

heightnumber<optional>

Component height.

topnumber<optional>

Top offset in pixels.

leftnumber<optional>

Left offset in pixels.

rotationnumber<optional>

Rotation angle in degrees for visual transform.

borderRadiusnumber<optional>

Corner radius in pixels.

zIndexnumber<optional>

z-index stacking order.

colorstring<optional>

Primary color for text and icons.

backgroundColorstring<optional>

Background color for the content area.

fontobject<optional>

Font configuration object containing size, family and style settings. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels used for labels and text.
  • fontFamily (string, default: 'Segoe UI'): Font family name for text rendering.
  • style (object): Font style object, containing fontStyle, fontWeight, textDecoration.
sizestring<optional>

Preset size key for the component.

tabPositionstring<optional>

Position of the tabs relative to content ('top' | 'bottom' | 'left' | 'right').

styleTemplatestring<optional>

Key of a style template to apply.

activeViewIndexnumber<optional>

Zero-based index of the currently active tab.

onChangefunction | string<optional>

Callback when the active tab changes.

useViewIconboolean<optional>

Whether to show each tab’s icon.

viewsArray.<TComponents.ViewProps><optional>

Array of view items to render as tabs.

defaultStatestring<optional>

Default state of the component.

expandHeightToParentBottomboolean<optional>

Whether to expand the height to the parent's bottom.

TableProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the table component. Items in this object include:

  • responsive (boolean, default: false): Whether the table should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

onRowClickfunction<optional>

Function to be called when a table row is clicked.

onCellClickfunction<optional>

Function to be called when a table cell is clicked.

onRowDblClickfunction<optional>

Function to be called when a table row is double-clicked.

onCellDblClickfunction<optional>

Function to be called when a table cell is double-clicked.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

dataConfigobject<optional>

Configurations for the table data. This object defines the table content:

  • columns (Array): Column definitions including icon, title, width, sortable.
  • data (Array<Array>): Table row data, each row is an array of cell values.
  • params (object): Dynamic data configuration containing mode, type, isHidden, variablePath.
headerFontColorstring<optional>

Font color of the header row.

headerBackgroundColorstring<optional>

Background color of the header row.

bodyFontColorstring<optional>

Font color of the body rows.

bodyBackgroundColorstring<optional>

Background color of the body rows.

headerFontobject<optional>

Font configuration for the header row. This object controls header text appearance:

  • fontSize (number, default: 24): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
bodyFontobject<optional>

Font configuration for the body rows. This object controls body text appearance:

  • fontSize (number, default: 16): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
borderstring<optional>

Border style of the table.

defaultStatestring<optional>

Default state of the component.

selectedRowstring | number<optional>

Identifier of the selected row.

selectedCellstring | number<optional>

Identifier of the selected cell.

dataStructstring<optional>

Custom data structure metadata for integration with other systems.

TextProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the text component. Items in this object include:

  • responsive (boolean, default: false): Whether the text component should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the text component is created.

onMountedfunction<optional>

Function to be called when the text component is mounted.

textTypestring<optional>

Type of the text content, e.g. 'body', 'header' or 'description'.

textstring<optional>

Text content to display.

backgroundColorstring<optional>

Background color of the text area.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

colorstring<optional>

Text color.

fontobject<optional>

Font configuration for the text. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
  • textAlign (string, default: 'left'): Text alignment of the text.
defaultStatestring<optional>

Default state of the component.

dataStructstring<optional>

Custom data structure metadata for integration with other systems.

ToggleProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the toggle component. Items in this object include:

  • responsive (boolean, default: false): Whether the toggle group should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the toggle component is created.

onMountedfunction<optional>

Function to be called when the toggle component is mounted.

onChangefunction<optional>

Function to be called when the toggle state changes.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

colorstring<optional>

Text color of the toggle items.

fontobject<optional>

Font configuration for the toggle labels. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
toggledColorstring<optional>

Background color of the toggled items.

multiboolean<optional>

Whether to allow multiple selections.

optionItemsstring<optional>

Formatted string representing the toggle options.

optionConfigobject<optional>

Configuration for dynamic options. This object controls how options are provided:

  • mode (string, default: 'fixed'): Options mode, e.g. 'fixed', 'sync', 'initialize'.
  • type (string): Type of the options data source.
  • isHidden (boolean, default: false): Whether this option configuration is hidden.
  • variablePath (string): Variable path used when options are dynamic.
optionIconsArray.<Object><optional>

Icon configuration for each option.

optionActionsArray.<string><optional>

Action configuration for each option.

defaultStatestring<optional>

Default state of the component.

VarIncrDecrProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

Additional options for the VarIncrDecr component. Items in this object include:

  • responsive (boolean, default: false): Whether the component should be responsive.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

borderstring<optional>

Border style of the component.

colorstring<optional>

Text color of the variable field.

sizestring<optional>

Size style template of the component.

fontobject<optional>

Font configuration for the variable value. This object controls text appearance:

  • fontSize (number, default: 12): Font size in pixels.
  • fontFamily (string, default: 'Segoe UI'): Font family name.
readOnlyboolean<optional>

If true, the value is displayed and can only be changed by increment/decrement.

useBorderboolean<optional>

Whether to draw a border around the variable field.

regexobject<optional>

Regular expression configuration for validation. This object defines validation behavior:

  • label (string, default: 'Number'): Description of the regex rule.
  • value (string): Regex pattern used to validate the input.
textstring | number<optional>

Initial text value bound to the variable.

inputVarobject<optional>

Input variable binding configuration. This object configures the bound input variable:

  • type (string): Binding variable type.
  • func (string): Binding mode.
  • value (string): Initial value or variable path used for binding.
  • isHidden (boolean, default: false): Whether this binding is hidden in variable selectors.
onChangefunction<optional>

Callback function when the value changes.

keyboardHelperDescstring<optional>

Description text shown in the keyboard helper.

stepstring | number<optional>

Increment/decrement step applied on each button click.

numRangeobject<optional>

Numeric range configuration. This object controls allowed value range:

  • min (number|null): Minimum allowed value.
  • max (number|null): Maximum allowed value.
defaultStatestring<optional>

Default state of the component.

dataStructstring<optional>

Custom data structure metadata for integration with other systems.

VarSliderProps

Properties
NameTypeAttributesDescription
optionsobject<optional>

General options for the slider behavior. Items in this object include:

  • responsive (boolean, default: false): Whether the slider width should adapt to the container width.
tipsstring<optional>

Tooltip text for the component.

onCreatedfunction<optional>

Function to be called when the component is created.

onMountedfunction<optional>

Function to be called when the component is mounted.

onPointerReleasefunction<optional>

Callback function that is called when the pointer is released after dragging the slider.

onPointerDownfunction<optional>

Callback function that is called while the pointer is dragging the slider.

positionstring<optional>

CSS position property.

widthnumber<optional>

Width of the component.

heightnumber<optional>

Height of the component.

topnumber<optional>

Top position of the component.

leftnumber<optional>

Left position of the component.

borderRadiusnumber<optional>

Border radius of the component.

rotationnumber<optional>

Rotation angle of the component.

zIndexnumber<optional>

Z-index of the component.

colorstring<optional>

Font color of the description label.

fontobject<optional>

Font configuration for the description label. This object controls text appearance:

  • fontSize (number): Font size in pixels.
  • fontFamily (string): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
rangeValueColorstring<optional>

Font color of the min/max range values.

rangeValueFontobject<optional>

Font configuration for the min/max range values. This object controls range text appearance:

  • fontSize (number): Font size in pixels.
  • fontFamily (string): Font family name.
  • style (object): Font style configuration, containing fontStyle, fontWeight, textDecoration.
backgroundColorstring<optional>

Background color of the slider container.

borderstring<optional>

CSS border style of the slider container.

displayLabelboolean<optional>

Whether to display the description label.

descrLabelstring<optional>

Text content of the description label.

displayValueboolean<optional>

Whether to display the current value label.

valuenumber<optional>

Current value of the slider.

minnumber<optional>

Minimum value of the slider range.

maxnumber<optional>

Maximum value of the slider range.

enabledboolean<optional>

Whether the slider is enabled and interactive.

activeColorstring<optional>

Color of the active (filled) part of the slider track.

inactiveColorstring<optional>

Color of the inactive part of the slider track.

displayTicksboolean<optional>

Whether to display tick marks along the track.

tickStepnumber<optional>

Step between tick marks and value increments.

inputVarobject<optional>

Input variable binding configuration used in VarSlider. This object configures the bound input variable:

  • type (string): Binding variable type. Default is 'group'.
  • func (string): Binding mode. Default is 'custom'.
  • value (number|string): Initial value or variable path used for binding.
  • isHidden (boolean, default: false): Whether this binding is hidden in variable selectors.
textstring | number<optional>

Value that is parsed and written into the slider value in VarSlider.

defaultStatestring<optional>

Initial state of the component.

dataStructstring<optional>

Custom data structure metadata for integration with other systems.

ViewChildProps

A map of view child components:

  • Key: an instance of Component_A
  • Value: the name of that child component as a string
Type:

ViewProps

Type:
  • object
Properties
NameTypeAttributesDefaultDescription
idany<optional>

The ID of the view.

namestring<optional>
''

Name of the view.

iconstring<optional>
''

Icon associated with the view.

contentstring | HTMLElement | null<optional>
null

Content to display in the view. The value should be a string when passed via props, but null or an HTMLElement when used in component_a's views property.

childrenArray.<TComponents.Component_A><optional>
[]

Child components.