canvas-component-metadata

To validate component.yml metadata for Canvas components, enforce required keys like name, machineName, status, props, and slots. This ensures a complete contract and prevents inconsistent files that degrade editor experience and break tooling across design-to-code lifecycles.

The required keys for a Canvas component.yml file are name, machineName, status, required, props, and slots. Defining these keys correctly ensures a complete metadata contract, aligning UI controls with code and maintaining structural consistency.

To define props and enums in Canvas component metadata, use proper prop titles and camelCase IDs. Enum definitions must include human-readable labels and meta mappings to accurately align UI controls with the underlying code structure.

Yes, you can include optional directories such as scripts/, references/, and assets/ in Canvas components. These directories extend component.yml metadata by providing actionable assets and extended resources for your design-to-code workflows.

Canvas component metadata breaks tooling when component.yml files lack structure and validation. Missing required keys, improper camelCase IDs, or invalid enum definitions create inconsistent schemas that degrade the editor experience and disrupt the design-to-code lifecycle.