Skip to content

Type Alias: BaseComponentProps<P>

API / @xmachines/play-dom / BaseComponentProps

type BaseComponentProps<P> = object;

Defined in: packages/play-dom/src/json-render/types.ts:351

Catalog-agnostic component props type.

Use this when building shared component libraries that should not be tied to a specific catalog instance. Mirrors BaseComponentProps<P> from @json-render/react, /vue, /svelte.

Example

import type { BaseComponentProps } from "@xmachines/play-dom";
function MyButton({ props, emit }: BaseComponentProps<{ label: string }>) {
const el = document.createElement("button");
el.textContent = props.label;
el.addEventListener("click", () => emit("click"));
return el;
}

Type Parameters

Type ParameterDefault type
P extends Record<string, unknown>Record<string, unknown>

Properties

bindings

bindings: Record<string, string> | undefined;

Defined in: packages/play-dom/src/json-render/types.ts:354


children

children: Node[];

Defined in: packages/play-dom/src/json-render/types.ts:353


ctx

ctx: DomRenderContext;

Defined in: packages/play-dom/src/json-render/types.ts:357


emit

emit: (event) => void;

Defined in: packages/play-dom/src/json-render/types.ts:355

Parameters

ParameterType
eventstring

Returns

void


on

on: (event) => EventHandle;

Defined in: packages/play-dom/src/json-render/types.ts:356

Parameters

ParameterType
eventstring

Returns

EventHandle


props

props: P;

Defined in: packages/play-dom/src/json-render/types.ts:352