Skip to content

Function: defineRegistry()

API / @xmachines/play-vue / defineRegistry

function defineRegistry<C>(catalog, options): DefineRegistryResult;

Defined in: packages/play-vue/src/define-registry.ts:131

Create a component registry, automatically wrapping .vue SFCs so they work correctly with @json-render/vue’s rendering pipeline.

Drop-in replacement for defineRegistry from @json-render/vue. Import from @xmachines/play-vue to get SFC support for free.

Type Parameters

Type Parameter
C extends Catalog<SchemaDefinition<SchemaType<string, unknown>, SchemaType<string, unknown>>, unknown>

Parameters

ParameterTypeDescription
catalogCThe json-render catalog defining component prop shapes.
optionsDefineRegistryOptions<C>Registry options. components entries may be .vue SFCs (objects) or plain ComponentFn functions — both are handled automatically.

Returns

DefineRegistryResult