Skip to content
XMachines

Variable: schema

API / @xmachines/play-dom / schema

const schema: Schema<{
  catalog: SchemaType<
    "object",
    {
      actions: SchemaType<
        "map",
        {
          description: SchemaType<"string", unknown>;
          params: SchemaType<"zod", unknown>;
        }
      >;
      components: SchemaType<
        "map",
        {
          description: SchemaType<"string", unknown>;
          example: SchemaType<"any", unknown>;
          props: SchemaType<"zod", unknown>;
          slots: SchemaType<"array", SchemaType<"string", unknown>>;
        }
      >;
    }
  >;
  spec: SchemaType<
    "object",
    {
      elements: SchemaType<
        "record",
        SchemaType<
          "object",
          {
            children: SchemaType<"array", SchemaType<"string", unknown>>;
            props: SchemaType<"propsOf", string>;
            type: SchemaType<"ref", string>;
            visible: SchemaType<"any", unknown>;
          }
        >
      >;
      root: SchemaType<"string", unknown>;
    }
  >;
}>;

Defined in: packages/play-dom/src/json-render/schema.ts:20

The schema for @xmachines/play-dom

Defines:

  • Spec: A flat tree of elements with keys, types, props, children, and on-bindings
  • Catalog: Components with props schemas, and optional actions with param schemas