TComponents Namespace
- Source
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
- Popup_A
- Radio
- Select
- Slider
- Switch
- Tab
- Table
- Text
- Toggle_A
- VarIncrDecr
- VarSlider
- View_A
Methods
tComponentsLoadCSS(href)
Loads a CSS file
| Name | Type | Description |
|---|---|---|
href | string | Path of css file |
- Source
Type Definitions
ButtonProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
onClick | function | <optional> | Function to be called when button is pressed |
icon | string | | <optional> | Path to image file |
text | string | <optional> | Button text |
color | string | <optional> | Button text color |
backgroundColor | string | <optional> | Button background color |
border | string | <optional> | Button border style |
borderRadius | number | <optional> | Button border radius |
onPointerRelease | function | <optional> | Function to be called when pointer is released |
onPointerDown | function | <optional> | Function to be called when pointer is pressed down |
tips | string | <optional> | Tooltip text for the button |
font | object | <optional> | Font properties for the button text This object controls text appearance:
|
options | object | <optional> | Additional options for the button Items in this object include:
|
onCreated | function | <optional> | Function to be called when the button is created |
onMounted | function | <optional> | Function to be called when the button is mounted |
functionality | object | <optional> | Configuration object for component functionality. This object contains settings to control the component's behavior:
|
position | string | <optional> | CSS position property, default is 'static' |
width | number | <optional> | Button width in pixels, default is 100 |
height | number | <optional> | Button height in pixels, default is 32 |
top | number | <optional> | Button top position in pixels, default is 0 |
left | number | <optional> | Button left position in pixels, default is 0 |
rotation | number | <optional> | Button rotation in degrees, default is 0 |
zIndex | number | <optional> | Button z-index, default is 0 |
size | string | <optional> | Size style template |
styleTemplate | string | <optional> | Style template |
defaultState | string | <optional> | Default state of the button, default is 'show_enable' |
dataStruct | string | <optional> | Data structure associated with the button |
- Source
CheckboxGroupProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the component Items in this object include:
|
tips | string | <optional> | Tooltip text for the component |
onCreated | function | <optional> | Function to be called when the component is created |
onMounted | function | <optional> | Function to be called when the component is mounted |
onChange | function | <optional> | Function to be called when checkbox state changes |
position | string | <optional> | CSS position property |
width | number | <optional> | Width of the component |
height | number | <optional> | Height of the component |
top | number | <optional> | Top position of the component |
left | number | <optional> | Left position of the component |
rotation | number | <optional> | Rotation angle of the component |
zIndex | number | <optional> | Z-index of the component |
borderRadius | number | <optional> | Invalid attribute. Border radius of the component. |
color | string | <optional> | Text color of the component |
font | object | <optional> | Font properties of the component This object controls text appearance:
|
optionItems | string | <optional> | Formatted string representing the checkbox options |
optionConfig | object | <optional> | Configuration for dynamic options This object controls how options are provided:
|
defaultState | string | <optional> | Default state of the component |
dataStruct | string | <optional> | Data structure associated with the component |
- Source
CheckboxProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the checkbox component Items in this object include:
|
onCreated | function | <optional> | Function to be called when the component is created |
onMounted | function | <optional> | Function to be called when the component is mounted |
onChange | function | <optional> | Function to be called when checkbox state changes |
position | string | <optional> | CSS position property |
top | number | <optional> | Top position in pixels |
left | number | <optional> | Left position in pixels |
borderRadius | number | <optional> | Border radius of the component |
rotation | number | <optional> | Rotation of the component in degrees |
zIndex | number | <optional> | Z-index of the component |
text | string | <optional> | Checkbox text |
value | string | <optional> | Checkbox value |
selectedIndex | number | <optional> | Invalid attribute. |
color | string | <optional> | Color of the checkbox text |
font | object | <optional> | Font settings for the checkbox text This object controls text appearance:
|
inputVar | object | <optional> | Data binding configuration This object configures the bound input variable:
|
enabled | boolean | <optional> | Whether the checkbox is enabled |
checked | boolean | <optional> | Checked state of the checkbox |
dataStruct | string | <optional> | Data structure name for binding |
- Source
ComponentProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
label | string | <optional> | Label text |
labelPos | string | <optional> | Label position: "top|bottom|left|right|top-center|bottom-center" |
options | object | <optional> | A set of options to modify the behaviour of the component
|
- Source
ContainerProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
children | TComponents. | <optional> | |
box | boolean | <optional> | If true, the container will have a box around it |
width | string | <optional> | Width of the container. Default value is “auto”. |
height | string | <optional> | Height of the container. Default value is “auto”. |
classNames | string | <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'] |
id | string | <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. |
- Source
DropdownProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the dropdown component Items in this object include:
|
tips | string | <optional> | Tooltip text for the component |
onCreated | function | <optional> | Function to be called when the component is created |
onMounted | function | <optional> | Function to be called when the component is mounted |
onChange | function | <optional> | Function to be called when dropdown value is changed |
position | string | <optional> | CSS position property |
width | number | <optional> | Width of the component |
height | number | <optional> | Height of the component |
top | number | <optional> | Top position of the component |
left | number | <optional> | Left position of the component |
borderRadius | number | <optional> | Border radius of the component |
rotation | number | <optional> | Rotation angle of the component |
zIndex | number | <optional> | Z-index of the component |
icon | string | | <optional> | Prefix icon for the dropdown |
text | string | <optional> | Dropdown text |
color | string | <optional> | Text color of the dropdown |
backgroundColor | string | <optional> | Background color of the dropdown |
font | object | <optional> | Font settings for the dropdown text This object controls text appearance:
|
optionItems | string | <optional> | Options for the dropdown in the format |
optionConfig | object | <optional> | Configuration for dynamic options This object controls how options are provided:
|
optionIcons | Array.<Object> | <optional> | Icon configuration for each option |
optionActions | Array.<string> | <optional> | Action configuration for each option |
defaultState | string | <optional> | Default state of the component |
showArrow | boolean | <optional> | Whether to show the dropdown arrow |
dataStruct | string | <optional> | Data structure associated with the component |
- Source
DroppablePlaceholderProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Configuration options for the placeholder component. Items in this object include:
|
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
zIndex | number | <optional> | Z-index of the component. |
border | string | <optional> | Border style of the component. |
borderRadius | number | <optional> | Border radius of the component. |
backgroundColor | string | <optional> | Background color of the component. |
content | object | <optional> | Layout configuration for the placeholder content. This object controls how child components are arranged:
|
children | Array | <optional> | Additional mapped child components. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <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.
- object
| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the hamburger component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Lifecycle hook invoked after component instantiation. |
onMounted | function | <optional> | Lifecycle hook invoked after component is attached to the DOM. |
position | string | <optional> | CSS |
width | number | <optional> | Width of the menu container. |
height | number | <optional> | Height of the menu container. |
top | number | <optional> | Top offset in pixels. |
left | number | <optional> | Left offset in pixels. |
borderRadius | number | <optional> | Border radius in pixels. |
rotation | number | <optional> | Rotation in degrees. |
zIndex | number | <optional> | CSS |
border | string | <optional> | CSS border shorthand. |
color | string | <optional> | CSS text color. |
backgroundColor | string | <optional> | CSS background color. |
font | object | <optional> | Font configuration. This object controls text appearance:
|
size | string | <optional> | Preset size key for the component. |
styleTemplate | string | <optional> | Key of a style template to apply. |
useTitle | boolean | <optional> | Whether to reserve space for the title. |
title | string | <optional> | Title displayed next to the hamburger icon when the menu is opened. |
alwaysVisible | boolean | <optional> | Whether the hamburger menu stays visible even when closed. |
activeViewIndex | number | <optional> | Zero-based index of the currently active view. |
onChange | function | <optional> | Callback triggered when the active view changes. |
useViewIcon | boolean | <optional> | Whether to display an icon alongside each view label. |
views | Array.<TComponents.ViewProps> | <optional> | Array of view objects to populate the menu. |
defaultState | string | <optional> | Default state of the component. |
expandHeightToParentBottom | boolean | <optional> | Whether to expand the height to the parent's bottom. |
- Source
ImageProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the image component. Items in this object include:
|
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
imgSrc | string | <optional> | Path to the image file. |
imgStyle | object | <optional> | Visual style configuration for the image. This object controls how the image is rendered:
|
onClick | function | <optional> | Function to be called when the image is clicked. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
zIndex | number | <optional> | Z-index of the component. |
rotation | number | <optional> | Rotation angle of the component. |
borderRadius | number | <optional> | Border radius of the component. |
defaultState | string | <optional> | Default state of the component. |
- Source
InputProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the input component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
border | string | <optional> | Border style of the input field. |
color | string | <optional> | Text color of the input field. |
backgroundColor | string | <optional> | Background color of the input field. |
size | string | <optional> | Size style template of the component. |
font | object | <optional> | Font settings for the input text. This object controls text appearance:
|
readOnly | boolean | <optional> | Set to true to use the input field only for displaying values. |
useBorder | boolean | <optional> | Whether to draw a border around the value. |
regex | object | <optional> | Regular expression configuration for validation. This object defines validation behavior:
|
text | string | <optional> | Initial value of the input field. |
inputVar | object | <optional> | Configuration object for input variable binding. This object configures the bound input variable:
|
onChange | function | <optional> | Function to be called when the input value changes. |
keyboardHelperDesc | string | <optional> | Description text shown in the keyboard helper. |
defaultState | string | <optional> | Default state of the component. |
dataStruct | string | <optional> | Data structure associated with the component. |
- Source
LayoutInfoboxProps
- object
| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Options for the layout infobox component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
zIndex | number | <optional> | Z-index of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
color | string | <optional> | Text color of the component. |
backgroundColor | string | <optional> | Background color of the component. |
useTitle | boolean | <optional> | Whether to display the title area. |
title | string | <optional> | Title of the infobox. |
font | object | <optional> | Font settings for the title text. This object controls text appearance:
|
useBorder | boolean | <optional> | Whether to draw a border around the infobox. |
border | string | <optional> | Border style of the infobox. |
content | object | <optional> | Props to be passed to the internal content container. This object controls how child components are arranged:
|
defaultState | string | <optional> | Default state of the component. |
expandHeightToParentBottom | boolean | <optional> | Whether to expand the height to the parent's bottom. |
- Source
MenuProps
Properties accepted by the TComponents.Menu_A component, defining its appearance, behavior, and lifecycle hooks.
- object
| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the menu component. Items in this object include:
|
onCreated | function | <optional> | Lifecycle hook invoked after component instantiation. |
onMounted | function | <optional> | Lifecycle hook invoked after component is attached to the DOM. |
position | string | <optional> | CSS |
width | number | <optional> | Width of the menu container. |
height | number | <optional> | Height of the menu container. |
top | number | <optional> | Top offset in pixels. |
left | number | <optional> | Left offset in pixels. |
borderRadius | number | <optional> | Border radius in pixels. |
rotation | number | <optional> | Rotation in degrees. |
zIndex | number | <optional> | CSS |
border | string | <optional> | CSS border shorthand. |
color | string | <optional> | CSS text color. |
backgroundColor | string | <optional> | CSS background color. |
font | object | <optional> | Font configuration. This object controls text appearance:
|
size | string | <optional> | Preset size key for the component. |
styleTemplate | string | <optional> | Key of a style template to apply. |
useTitle | boolean | <optional> | Whether to reserve space for the title. |
title | string | <optional> | Title displayed for the menu. |
activeViewIndex | number | <optional> | Zero-based index of the currently active view. |
onChange | function | | <optional> | Callback triggered when the active view changes. |
useViewIcon | boolean | <optional> | Whether to display an icon alongside each view label. |
views | Array.<TComponents.ViewProps> | <optional> | Array of view objects to populate the menu. |
defaultState | string | <optional> | Default state of the component. |
- Source
PageProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
onCreated | function | <optional> | Function to be called when the page is created. |
onMounted | function | <optional> | Function to be called when the page is mounted. |
position | string | <optional> | CSS position property of the page. |
width | number | <optional> | Width of the page. |
height | number | <optional> | Height of the page. |
top | number | <optional> | Top offset of the page. |
left | number | <optional> | Left offset of the page. |
zIndex | number | <optional> | Z-index of the page. |
backgroundColor | string | <optional> | Background color of the page. |
id | string | <optional> | Unique identifier for the page. |
name | string | <optional> | Name of the page. |
children | Array.<any> | <optional> | Child components of the page. |
- Source
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.
| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the pdf component. Items in this object include:
|
onCreated | function | | <optional> | Lifecycle hook invoked after component instantiation. |
onMounted | function | | <optional> | Lifecycle hook invoked after component is attached to the DOM. |
position | string | <optional> | CSS positioning of the element. |
width | number | <optional> | Component width. |
height | number | <optional> | Component height. |
top | number | <optional> | Top offset in pixels. |
left | number | <optional> | Left offset in pixels. |
rotation | number | <optional> | Rotation angle in degrees for visual transform. |
borderRadius | number | <optional> | Corner radius in pixels. |
zIndex | number | <optional> | z-index stacking order. |
pdfSrc | string | <optional> | The source location of the pdf component. |
emptyMessage | string | <optional> | Message displayed when the content is empty. |
RadioProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the radio component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
onChange | function | <optional> | Callback function that is called when the selected radio option changes. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
functionality | object | <optional> | Configuration object for component functionality. This object contains settings to control the component's behavior:
|
color | string | <optional> | Text color of the component. |
font | object | <optional> | Font settings for the radio labels. This object controls text appearance:
|
optionItems | string | <optional> | Radio options in the format |
optionConfig | object | <optional> | Configuration for dynamic radio options. This object controls how options are provided:
|
defaultState | string | <optional> | Initial state of the component. |
text | string | <optional> | Current selected option value, corresponds to the |
selectedIndex | number | <optional> | Index of the initially selected option, |
inputVar | object | <optional> | Input variable binding configuration. This object configures the bound input variable:
|
dataStruct | string | <optional> | Data structure associated with the component. |
- Source
SelectProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the select component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
onChange | function | <optional> | Callback function that is called when the selected option changes. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
functionality | object | <optional> | Configuration object for component functionality. This object contains settings to control the component's behavior:
|
size | string | <optional> | Size style template for the component. |
labelPos | string | <optional> | Position of the label relative to the select component. |
placeHolder | string | <optional> | Placeholder text shown when no option is selected. |
color | string | <optional> | Font color of the selected text. |
font | object | <optional> | Font configuration for the selected text. This object controls text appearance:
|
border | string | <optional> | CSS border style of the select element. |
value | any | <optional> | Invalid attribute. |
optionItems | string | <optional> | Options list in the format |
optionConfig | object | <optional> | Configuration for dynamic options. This object controls how options are provided:
|
text | string | <optional> | Current selected option value, corresponds to the |
selectedIndex | number | <optional> | Index of the initially selected option. |
inputVar | object | <optional> | Input variable binding configuration. This object configures the bound input variable:
|
defaultState | string | <optional> | Initial state of the component. |
dataStruct | string | <optional> | Data structure associated with the component. |
- Source
SignalIndicatorProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the digital LED component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
borderRadius | number | <optional> | Invalid attribute. Border radius of the component. |
color | string | <optional> | The color of the digital LED component. |
size | string | <optional> | Size style template of the component. |
font | object | <optional> | Font settings for the digital LED component. This object controls text appearance:
|
text | string | | <optional> | The text value displayed by the digital LED component. |
inputVar | object | <optional> | Configuration object for input variable binding. This object configures the bound input variable:
|
onChange | string | <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. |
onClick | string | <optional> | A string representing a function to be called when the component is clicked. |
readOnly | boolean | <optional> | Indicates whether the digital LED component is read-only. |
defaultState | string | <optional> | The default state of the component when initialized. |
align | string | <optional> | The alignment of the digital LED component within its container. |
dataStruct | string | <optional> | The data structure associated with the component. |
- Source
SliderProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | General options for the slider behavior. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
onPointerRelease | function | <optional> | Callback function that is called when the pointer is released after dragging the slider. |
onPointerDown | function | <optional> | Callback function that is called while the pointer is dragging the slider. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
color | string | <optional> | Font color of the description label. |
font | object | <optional> | Font configuration for the description label. This object controls text appearance:
|
rangeValueColor | string | <optional> | Font color of the min/max range values. |
rangeValueFont | object | <optional> | Font configuration for the min/max range values. This object controls range text appearance:
|
backgroundColor | string | <optional> | Background color of the slider container. |
border | string | <optional> | CSS border style of the slider container. |
displayLabel | boolean | <optional> | Whether to display the description label. |
descrLabel | string | <optional> | Text content of the description label. |
displayValue | boolean | <optional> | Whether to display the current value label. |
value | number | <optional> | Current value of the slider. |
min | number | <optional> | Minimum value of the slider range. |
max | number | <optional> | Maximum value of the slider range. |
enabled | boolean | <optional> | Whether the slider is enabled and interactive. |
activeColor | string | <optional> | Color of the active (filled) part of the slider track. |
inactiveColor | string | <optional> | Color of the inactive part of the slider track. |
displayTicks | boolean | <optional> | Whether to display tick marks along the track. |
tickStep | number | <optional> | Step between tick marks and value increments. |
defaultState | string | <optional> | Initial state of the component. |
- Source
SwitchProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the switch component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
borderRadius | number | <optional> | Invalid attribute. Border radius of the component. |
text | string | | <optional> | Text value bound to the switch state. |
inputVar | object | <optional> | Input variable binding configuration. This object configures the bound input variable:
|
onChange | function | <optional> | Function to be called when the switch state changes. |
readOnly | boolean | <optional> | Indicates whether the switch is read-only. |
defaultState | string | <optional> | Initial state of the component. |
align | string | <optional> | Alignment of the switch inside its container. |
dataStruct | string | <optional> | Custom data structure metadata for integration with other systems. |
- Source
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.
- object
| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the tab component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | | <optional> | Lifecycle hook invoked after component instantiation. |
onMounted | function | | <optional> | Lifecycle hook invoked after component is attached to the DOM. |
position | string | <optional> | CSS positioning of the element. |
width | number | <optional> | Component width. |
height | number | <optional> | Component height. |
top | number | <optional> | Top offset in pixels. |
left | number | <optional> | Left offset in pixels. |
rotation | number | <optional> | Rotation angle in degrees for visual transform. |
borderRadius | number | <optional> | Corner radius in pixels. |
zIndex | number | <optional> | z-index stacking order. |
color | string | <optional> | Primary color for text and icons. |
backgroundColor | string | <optional> | Background color for the content area. |
font | object | <optional> | Font configuration object containing size, family and style settings. This object controls text appearance:
|
size | string | <optional> | Preset size key for the component. |
tabPosition | string | <optional> | Position of the tabs relative to content ('top' | 'bottom' | 'left' | 'right'). |
styleTemplate | string | <optional> | Key of a style template to apply. |
activeViewIndex | number | <optional> | Zero-based index of the currently active tab. |
onChange | function | | <optional> | Callback when the active tab changes. |
useViewIcon | boolean | <optional> | Whether to show each tab’s icon. |
views | Array.<TComponents.ViewProps> | <optional> | Array of view items to render as tabs. |
defaultState | string | <optional> | Default state of the component. |
expandHeightToParentBottom | boolean | <optional> | Whether to expand the height to the parent's bottom. |
TableProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the table component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
onRowClick | function | <optional> | Function to be called when a table row is clicked. |
onCellClick | function | <optional> | Function to be called when a table cell is clicked. |
onRowDblClick | function | <optional> | Function to be called when a table row is double-clicked. |
onCellDblClick | function | <optional> | Function to be called when a table cell is double-clicked. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
dataConfig | object | <optional> | Configurations for the table data. This object defines the table content:
|
headerFontColor | string | <optional> | Font color of the header row. |
headerBackgroundColor | string | <optional> | Background color of the header row. |
bodyFontColor | string | <optional> | Font color of the body rows. |
bodyBackgroundColor | string | <optional> | Background color of the body rows. |
headerFont | object | <optional> | Font configuration for the header row. This object controls header text appearance:
|
bodyFont | object | <optional> | Font configuration for the body rows. This object controls body text appearance:
|
border | string | <optional> | Border style of the table. |
defaultState | string | <optional> | Default state of the component. |
selectedRow | string | | <optional> | Identifier of the selected row. |
selectedCell | string | | <optional> | Identifier of the selected cell. |
dataStruct | string | <optional> | Custom data structure metadata for integration with other systems. |
- Source
TextProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the text component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the text component is created. |
onMounted | function | <optional> | Function to be called when the text component is mounted. |
textType | string | <optional> | Type of the text content, e.g. 'body', 'header' or 'description'. |
text | string | <optional> | Text content to display. |
backgroundColor | string | <optional> | Background color of the text area. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
color | string | <optional> | Text color. |
font | object | <optional> | Font configuration for the text. This object controls text appearance:
|
defaultState | string | <optional> | Default state of the component. |
dataStruct | string | <optional> | Custom data structure metadata for integration with other systems. |
- Source
ToggleProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the toggle component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the toggle component is created. |
onMounted | function | <optional> | Function to be called when the toggle component is mounted. |
onChange | function | <optional> | Function to be called when the toggle state changes. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
color | string | <optional> | Text color of the toggle items. |
font | object | <optional> | Font configuration for the toggle labels. This object controls text appearance:
|
toggledColor | string | <optional> | Background color of the toggled items. |
multi | boolean | <optional> | Whether to allow multiple selections. |
optionItems | string | <optional> | Formatted string representing the toggle options. |
optionConfig | object | <optional> | Configuration for dynamic options. This object controls how options are provided:
|
optionIcons | Array.<Object> | <optional> | Icon configuration for each option. |
optionActions | Array.<string> | <optional> | Action configuration for each option. |
defaultState | string | <optional> | Default state of the component. |
- Source
VarIncrDecrProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | Additional options for the VarIncrDecr component. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
border | string | <optional> | Border style of the component. |
color | string | <optional> | Text color of the variable field. |
size | string | <optional> | Size style template of the component. |
font | object | <optional> | Font configuration for the variable value. This object controls text appearance:
|
readOnly | boolean | <optional> | If true, the value is displayed and can only be changed by increment/decrement. |
useBorder | boolean | <optional> | Whether to draw a border around the variable field. |
regex | object | <optional> | Regular expression configuration for validation. This object defines validation behavior:
|
text | string | | <optional> | Initial text value bound to the variable. |
inputVar | object | <optional> | Input variable binding configuration. This object configures the bound input variable:
|
onChange | function | <optional> | Callback function when the value changes. |
keyboardHelperDesc | string | <optional> | Description text shown in the keyboard helper. |
step | string | | <optional> | Increment/decrement step applied on each button click. |
numRange | object | <optional> | Numeric range configuration. This object controls allowed value range:
|
defaultState | string | <optional> | Default state of the component. |
dataStruct | string | <optional> | Custom data structure metadata for integration with other systems. |
- Source
VarSliderProps
Properties| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | <optional> | General options for the slider behavior. Items in this object include:
|
tips | string | <optional> | Tooltip text for the component. |
onCreated | function | <optional> | Function to be called when the component is created. |
onMounted | function | <optional> | Function to be called when the component is mounted. |
onPointerRelease | function | <optional> | Callback function that is called when the pointer is released after dragging the slider. |
onPointerDown | function | <optional> | Callback function that is called while the pointer is dragging the slider. |
position | string | <optional> | CSS position property. |
width | number | <optional> | Width of the component. |
height | number | <optional> | Height of the component. |
top | number | <optional> | Top position of the component. |
left | number | <optional> | Left position of the component. |
borderRadius | number | <optional> | Border radius of the component. |
rotation | number | <optional> | Rotation angle of the component. |
zIndex | number | <optional> | Z-index of the component. |
color | string | <optional> | Font color of the description label. |
font | object | <optional> | Font configuration for the description label. This object controls text appearance:
|
rangeValueColor | string | <optional> | Font color of the min/max range values. |
rangeValueFont | object | <optional> | Font configuration for the min/max range values. This object controls range text appearance:
|
backgroundColor | string | <optional> | Background color of the slider container. |
border | string | <optional> | CSS border style of the slider container. |
displayLabel | boolean | <optional> | Whether to display the description label. |
descrLabel | string | <optional> | Text content of the description label. |
displayValue | boolean | <optional> | Whether to display the current value label. |
value | number | <optional> | Current value of the slider. |
min | number | <optional> | Minimum value of the slider range. |
max | number | <optional> | Maximum value of the slider range. |
enabled | boolean | <optional> | Whether the slider is enabled and interactive. |
activeColor | string | <optional> | Color of the active (filled) part of the slider track. |
inactiveColor | string | <optional> | Color of the inactive part of the slider track. |
displayTicks | boolean | <optional> | Whether to display tick marks along the track. |
tickStep | number | <optional> | Step between tick marks and value increments. |
inputVar | object | <optional> | Input variable binding configuration used in
|
text | string | | <optional> | Value that is parsed and written into the slider |
defaultState | string | <optional> | Initial state of the component. |
dataStruct | string | <optional> | Custom data structure metadata for integration with other systems. |
- Source
ViewChildProps
A map of view child components:
- Key: an instance of
Component_A - Value: the name of that child component as a string
- Map.<Component_A, string>
- Source
ViewProps
- object
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | any | <optional> | The ID of the view. | |
name | string | <optional> | '' | Name of the view. |
icon | string | <optional> | '' | Icon associated with the view. |
content | string | | <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. |
children | Array.<TComponents.Component_A> | <optional> | [] | Child components. |
- Source