Class Component

Definition of a UI component in the app

Hierarchy

  • Component

Constructors

constructor

Properties

additionalProperties? events? id? name properties type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional events

events?: AppBuilderEvent[]

Events to listen for on the UI component.

Optional id

id?: string

The ID of the UI component. This property is deprecated; use name to identify individual components instead.

name

name: string

A unique identifier for this UI component. This name is also visible in the app editor.

properties

properties: ComponentProperties

Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.

type

type: ComponentType

The UI component type.

Settings

Member Visibility

Theme

Generated using TypeDoc