Home > @activeviam/activeui-sdk > ActiveUIPlugin
ActiveUIPlugin interface
Signature:
export interface ActiveUIPlugin<Properties = {}, StaticProperties = {}, Parameters = PluginParameters<any, any>>
Properties
| Property | Type | Description |
|---|---|---|
| createProperties | (parameters: Parameters, activeUI: ActiveUI) => Properties | Should return an object matching the type of the corresponding plugin properties. |
| key | PluginKey | Used to reference this plugin implementation. This key will be used to declare the plugin in the configuration of a component. The couple (type, key) should be unique among your project to avoid any conflicts. |
| parametersSerializationFn | PluginParametersSerializationFn | Needs to be given when the implementation requires some parameters. |
| staticProperties | StaticProperties | Should be an object matching the type of the corresponding plugin static properties. |