canvas-component-metadata

What problem does it solve?

Canvas component metadata validation is tedious and error-prone; this guide standardizes the process to ensure consistent, correct definitions across projects.

Core Features & Use Cases

• Validate and document component.yml structures (name, machineName, status, required, props, slots).
• Provide a canonical schema to avoid common mistakes when creating or updating Canvas components.
• Use cases include defining new components, updating props/slots, and troubleshooting prop validation errors in the Canvas UI.

Quick Start

Create a valid component.yml by following this schema and then validate it against the guidelines.