Interface: ChoicekitPluginInputGenerics

Properties

readonly optional api?: GenericObject

All the public props and functionality the plugin will attach the given namespace on the engine

readonly optional config?: GenericObject

Optional configuration exposed to users when your plugin should behave differently under situations

readonly optional dependencies?: ChoicekitPlugins

Optional external plugins this plugin needs to be mounted beforehand.

readonly optional engine?: ChoicekitEngine<ChoicekitEngineGenerics>

Optional engine structure that this plugin supports.

You will likely not have to modify this.

readonly id: string

Unique id / name / namespace.

Only one plugin can be mounted at a time on the engine with the same id.

NOTE: CHANGING THIS WILL BREAK PLUGIN SAVES

readonly optional overrideBehaviour?: ChoicekitPluginBehaviourOnOverride

How the engine will resolve “conflicts” when multiple plugins try to mount onto the same namespace

"err"

readonly optional serializedState?: GenericSerializableObject

Optional data shape if you need to persist some plugin state.

readonly optional state?: GenericObject

Optional internal state isolated to a single engine instance.

Ideal since you’d otherwise have to fiddle with weakmaps for partitioned state