Home > @xoram/plugin-panoramique > defineComponentDefinition

defineComponentDefinition() function

Programmatically describe a ComponentDefinition

Signature:

export declare function defineComponentDefinition<id extends string, component extends Component>(id: id, component: component, setup?: (helpers: ComponentDefinitionHelpers<component>) => void): DefinedComponentDefinition<component, id>;

Parameters

Parameter	Type	Description
id	id	the unique identifier of the definition to create
component	component	the Vue component to mount when using the harness
setup	(helpers: ComponentDefinitionHelpers<component>) => void	(Optional) a function to programmatically describe the props, event listeners and children of the harness

Returns:

DefinedComponentDefinition<component, id>