Home > @xoram/plugin-panoramique

plugin-panoramique package

Vue and Pinia integration for xoram.

View doc at https://xoram.dev/plugins/panoramique/.

Functions

Function	Description
addChild(parent, child, slot, index)	Register a component as the child of another when the host plugin is created and sever the link on teardown. Additionally, flag the host component as depending on panoramique's plugin.
defineComponentDefinition(id, component, setup)	Programmatically describe a ComponentDefinition
register(definition)	Register a Vue Component in panoramique when the host plugin is created and de-register the component on tear down. Additionally, flag the host component as depending on panoramique's plugin.

Interfaces

Interface	Description
ComponentDefinition	A precursor for a ComponentHarness used to register a component into panoramique.
ComponentDefinitionHelpers	Provide tools to describe a ComponentHarness in a composable way instead of using the option syntax.
ComponentHarness	Describe how a component should be mounted into the Vue app.
PanoramiqueStore	Store a collection `ComponentHarness` to build dynamically structured UI in a Vue application.
VueService	Create and expose a Vue app instance for panoramique to mount components into.

Variables

Variable	Description
panoramiquePlugin	Provide the panoramique and vue services to enable the use of Vue components to build dynamic UIs.
rootHarness	The identifier of the harness mounted as the application root.

Type Aliases

Type Alias	Description
_ExtractActionsFromSetupStore_Keys	List all keys of action-like members of an object. Stolen from Pinia's types
_ExtractActionsFromSetupStore	List all action-like members of an object. Stolen from Pinia's types
_ExtractGettersFromSetupStore_Keys	List all keys of getter-like members of an object. Stolen from Pinia's types
_ExtractGettersFromSetupStore	List all getter-like members of an object. Stolen from Pinia's types
_ExtractStateFromSetupStore_Keys	List all keys of state-like members of an object. Stolen from Pinia's types
_ExtractStateFromSetupStore	List all state-like members of an object. Stolen from Pinia's types
_Method	Generic type for a function that can infer arguments and return type Stolen from Pinia's types
AfterFirst	Extract everything but the first element of a tuple
ChildrenIds	An ordered array of harness ids meant to be mounted as the children of another harness.
ComponentEvents	Extract a component's declared events as a strongly typed Record<EventName, EventHandler>.
ComponentPropAndModels	List all props the component exposes and any potential modifier list for the models it defines.
DefinedComponentDefinition
ExposedComponentProps	List all props the component exposes.
First	Extract the first element from a tuple
HarnessChildren	Maps the slots advertised by a component to a list of children IDs to be bound to those same slots. A looser openly indexed slot to children IDs record is available is the slot names can't be inferred from the component's type.
HarnessListenableEvents	List all events that can be listened for on a component.
Multiplex	Turn a record of stuff into a record of arrays of stuff
NativeEvents	List native events that can be fired on any HTML Element as a strongly typed Record<EventName, EventHandler>.
NonNever	Filter out any property of record that evaluates to never.
OverloadParameters	Utility for extracting the parameters from a function overload (for typed emits) https://github.com/microsoft/TypeScript/issues/32164\#issuecomment-1146737709
OverloadProps
OverloadUnion
OverloadUnionRecursive
RemoveIndex	remove index signatures from object types
ServiceAsStore	Convert a Service into the corresponding Pinia `store` interface.
StoreAsService	Turn a Pinia `store` into a xoram `Service`.
Writable	Make all properties in record writable