ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

Home > @activeviam/activeui-sdk > PluginDescription

PluginDescription interface

Signature:

export interface PluginDescription 

Properties

PropertyTypeDescription
createProperties(parameters: PluginParameters<any, any>, activeUI: ActiveUI) => {}Should return an object matching the type of the corresponding plugin properties.
keyPluginKeyUsed 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.
parametersSerializationFnPluginParametersSerializationFnNeeds to be given when the implementation requires some parameters.
staticProperties{}Should be an object matching the type of the corresponding plugin static properties.
  • PluginDescription interface
  • Properties
Copyright © 2019 ActiveViam