Skip to main content

Component YAML

Defines a reusable dashboard component that can be embedded in canvas dashboards

Properties​

type​

[string] - Refers to the resource type and must be component (required)

display_name​

[string] - Refers to the display name for the component

description​

[string] - Detailed description of the component's purpose and functionality

input​

[array of object] - List of input variables that can be passed to the component

  • name - [string] - Unique identifier for the variable (required)

  • type - [string] - Data type of the variable (e.g., string, number, boolean) (required)

  • value - [string, number, boolean, object, array] - Default value for the variable. Can be any valid JSON value type

output​

[object] - Output variable that the component produces

  • name - [string] - Unique identifier for the variable (required)

  • type - [string] - Data type of the variable (e.g., string, number, boolean) (required)

  • value - [string, number, boolean, object, array] - Default value for the variable. Can be any valid JSON value type

Common Properties​

name​

[string] - Name is usually inferred from the filename, but can be specified manually.

refs​

[array of string] - List of resource references

dev​

[object] - Overrides any properties in development environment.

prod​

[object] - Overrides any properties in production environment.