Shared properties

Every component offers a specific set of properties, events and functions. These are used to modify the look-and-feel and behavior of each component for the particular use case in your app.
While every component type implies a different set of exposed features, there are certain properties that are shared among all components, regardless of the type. As general introduction to the component reference, this page introduces those shared properties first, so that they are not repeated in each reference page again.
Properties
Every component offers the following configuration options in the properties panel.
Property
Type
Default value
Behavior
Box shadow
Boolean
Component specific
When set to true, the affected component is rendered with a surrounding box-shadow. It is enabled by default for some larger components that are usually stand-alone, like a Chart, but disabled for all others. This property is situated in the Style tab of the properties panel.
Prevent deletion
Boolean
false
Usually, an app editor can freely delete any component without warning, assuming that there is no active usage. For components that are crucial to your particular app (e.g. a Tabbed Container that acts as app navigation) you might want to enforce confirmation before deletes. When set to true, the affected component cannot be deleted without an explicit confirmation.
Visible
Boolean
true
When set to true, the affected component will not be visible in the app for the end user. While editing the app you still see the component, for awareness of its existence and to access its configuration. It will however be rendered semi-transparently to highlight the invisibility setting.
Events
There are currently no events that all components have in common. Read the reference page of each component to learn more about their events.
API
Every component exposes the following properties and functions as part of its JavaScript API:
Property / Function
Type
Behavior
componentName
string
Type of the component, e.g. button or table
name
string
The name of the component as defined in the properties panel. This will always equal the variable name of the component in JavaScript code.
setVisible(value)
(value: boolean) => void
Sets the visibility of the affected component to the provided boolean value.
visible
boolean
Provides the current value of the "Visible" property, i.e. a boolean value whether the component is visible for the end user or not.

Property	Type	Default value	Behavior
Box shadow	Boolean	Component specific	When set to `true`, the affected component is rendered with a surrounding box-shadow. It is enabled by default for some larger components that are usually stand-alone, like a `Chart`, but disabled for all others. This property is situated in the `Style` tab of the properties panel.
Prevent deletion	Boolean	`false`	Usually, an app editor can freely delete any component without warning, assuming that there is no active usage. For components that are crucial to your particular app (e.g. a `Tabbed Container` that acts as app navigation) you might want to enforce confirmation before deletes. When set to `true`, the affected component cannot be deleted without an explicit confirmation.
Visible	Boolean	`true`	When set to `true`, the affected component will not be visible in the app for the end user. While editing the app you still see the component, for awareness of its existence and to access its configuration. It will however be rendered semi-transparently to highlight the invisibility setting.

Property / Function	Type	Behavior
`componentName`	`string`	Type of the component, e.g. `button` or `table`
`name`	`string`	The name of the component as defined in the properties panel. This will always equal the variable name of the component in JavaScript code.
`setVisible(value)`	`(value: boolean) => void`	Sets the visibility of the affected component to the provided boolean value.
`visible`	`boolean`	Provides the current value of the "Visible" property, i.e. a boolean value whether the component is visible for the end user or not.

Last modified 7mo ago