Options
All
  • Public
  • Public/Protected
  • All
Menu

Component Metadata is a static Javascript object that describes the component, it is required by Zyllio Studio to display its properties and styles from Design Editor.

Hierarchy

  • ComponentMetadataModel

Index

Properties

category?: string

Category in which the component is displayed in Zyllio Studio

editorEvents?: "screen.update"[]

Studio editor events

family?: string

A family groups compatible components (interchangeable)

help?: string

Help link

icon: string

SVG icon displayed in Zyllio Studio

id: string

Unique identifier, must be lower case and contain a dash character

label: string

Label displayed in Zyllio Studio

metadataVersion?: number
position?: "none" | "header" | "footer"

Indicats whether the component is in fixed position (header, footer) Default is none

properties: PropertyMetadataModel[]

Properties to configure the component

Styles to configure the component (width and height styles are mandatory)

Translations