Home > @xoram/plugin-panoramique > ComponentDefinition

ComponentDefinition interface

A precursor for a ComponentHarness used to register a component into panoramique.

Signature:

export interface ComponentDefinition<component extends Component, identifier extends string = string>

Properties

Property	Modifiers	Type	Description
children?		ChildrenIds | HarnessChildren<component>	(Optional) The id of the other harnesses to mount as the component's children in its slots.
events?		Multiplex<HarnessListenableEvents<component>>	(Optional) The listeners to bind to the component when mounting it in the application.
id		identifier	The unique string identifying the harness in the pinia store, unlike plugins it's not using a symbol because the pinia dev tools don't show properties registered with a symbol, and it's nice to be able to see the harness you registered. Makes sure you use a unique string value for this field as duplicated entries will be ignored and a warning will be printed to the console for any subsequent registration attempt with a pre-existing id.
props?		ComponentPropAndModels<component>	(Optional) The props to pass to the Vue component when mounting it in the application.
type		component	The Vue component to use when mounting the harness, you can use any Vue component (Setup API, Option API, Functional, one of yours or from a library).