canvas-component-metadata

To validate Canvas component metadata, define your component.yml with the correct name, machineName, status, props, slots, and enums, then check it against the canonical schema guidelines to ensure safe rendering and consistent discovery in editors.

The required structure for a Canvas component.yml includes valid YAML frontmatter defining name, machineName, status, required props, slots, and enums to satisfy the structural and type requirements of the component schema.

Canvas component prop validation fails when your component.yml definitions do not match the required schema structure, missing required props, slots, or enums, which prevents safe rendering and consistent discovery in the editor.

Yes, you can use this metadata schema to update existing Canvas components by applying the structural and type requirements to your current component.yml definitions, modifying props and slots while maintaining valid YAML frontmatter.

The best way to avoid common mistakes defining Canvas component props and slots is to follow a canonical schema that standardizes component.yml creation, ensuring correct type requirements and structural validation across projects.