Skip to main content
The Component type represents a published UI component ready for execution in native apps.

Type Definition

Fields

FieldTypeDescription
idID!Unique identifier
nameString!Component name (used in code references)
titleString!Human-readable display title
descriptionString!Component description
contentString!TypeScript source code
compiledString!JavaScript compiled code (ready for execution)
schemaString!JSON Schema defining component props
statusString!Component status (e.g., “draft”, “published”)
createdAtDateTime!Creation timestamp
updatedAtDateTime!Last update timestamp

Field Details

name

The component name is used when referencing the component in code. It follows PascalCase naming convention.

compiled

The compiled field contains JavaScript code that can be executed by the BindJS runtime. This is generated from the TypeScript source during the publish process.

schema

The schema field contains a JSON Schema that defines the component’s props:

Example Query

Response: