InstancePlugin
Plugin

Base class for plugins. Published functions will be available from the other class. this in published functions is referenced to the plugin, access the other class using this.client.

Observe that plugin doesn't apply itself on class level but instead on instance level. Plugin is its own instance that can have own functions and data that is not exposed to target class.

Functions can be published in four ways:

assign (when function is not already available on target)
before (when function is already available on target, will be called before original function)
after (when function is already available on target, will be called after original function)
override (replaces function on target, but old function can be reached)

To configure which functions get published and in what way, specify pluginConfig getter on plugin:

class Sort extends InstancePlugin {
  static get pluginConfig {
     return {
         before   : ['init'],
         after    : ['destroy', 'onElementClick'],
         override : ['render']
     };
  }
}

Useful configs and properties

Config / Property	Description
disabled	The plugin disabled state
client	Reference to the owning widget

Configs

Configs are options you supply in a configuration object when creating an instance of this class

disabled : Booleanfalse

The plugin/feature disabled state.

For a feature that is off by default that you want to enable later during runtime, configure it with disabled : true.

const grid = new Grid({
     features : {
         featureName : {
             disabled : true // on and disabled, can be enabled later
         }
     }
});

// enable the feature
grid.features.featureName.disabled = false;

If the feature is disabled by default, and you want to include and enable the feature, configure it as true:

const grid = new Grid({
     features : {
         featureName : true // on and enabled, can be disabled later
     }
});

// disable the feature
grid.features.featureName.disabled = true;

If the feature is on by default, but you want to turn it off, configure it as false:

const grid = new Grid({
     features : {
         featureName : false // turned off, not included at all
     }
});

If the feature is enabled by default and you have no need of reconfiguring it, you can omit the feature configuration.

Has a corresponding runtime disabled property.

client : Widget

ADVANCED

The widget which this plugin is to attach to.

Has a corresponding runtime client property.

Properties

Properties are getters/setters or publicly accessible variables on this class

isInstancePlugin : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of InstancePlugin class, or subclass thereof.

disabled : Booleanfalse

The plugin/feature disabled state.

For a feature that is off by default that you want to enable later during runtime, configure it with disabled : true.

const grid = new Grid({
     features : {
         featureName : {
             disabled : true // on and disabled, can be enabled later
         }
     }
});

// enable the feature
grid.features.featureName.disabled = false;

If the feature is disabled by default, and you want to include and enable the feature, configure it as true:

const grid = new Grid({
     features : {
         featureName : true // on and enabled, can be disabled later
     }
});

// disable the feature
grid.features.featureName.disabled = true;

If the feature is on by default, but you want to turn it off, configure it as false:

const grid = new Grid({
     features : {
         featureName : false // turned off, not included at all
     }
});

If the feature is enabled by default and you have no need of reconfiguring it, you can omit the feature configuration.

Has a corresponding disabled config.

enabled : Boolean

internal

READONLY
Simple wrapper for disabled to make optional chaining simple:
```
grid.features.myFeature?.enabled // returns true when feature exists and is enabled
```
isInstancePlugin : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of InstancePlugin class, or subclass thereof.
client : Widget

READONLY

ADVANCED

The Widget which was passed into the constructor, which is the Widget we are providing extra services for.

Has a corresponding client config.

Functions

Functions are methods available for calling on the class

initPlugin( plugInto, PluginClass, config )
: InstancePlugin

internal

static

Call from another instance to add a plugin to it
initPlugins( plugInto, ...plugins )

internal

static
Call from another instance to add plugins to it.
```
InstancePlugin.initPlugins(this, Search, Stripe);
```

applyAfter( plugInto, functions, aftertrue )

private

Applies after/before hooks for specified functions.
applyAssign( plugInto, fnNames )

private

Applies assigning for specified functions.
applyOverride( plugInto, fnNames )

private

Applies override for specified functions.
applyPluginConfig( plugInto )

private

Applies config as found in plugInto.pluginConfig, or published all if no config found.
assign( plugInto, fnName )

private

Assigns specified functions.
doAfterHook( plugInto, intoName, hookName, aftertrue )

private

Hooks functions. When the function is called on the target class all functions in the hook chain will be called in the order they were added.
functionChainRunner( chain, params )
: *

private

Used to run multiple plugged in functions with the same name, see after() above. Returning false from a function will abort the hook chain.
updateKeyMap( )

private

This will merge a feature's (subclass of InstancePlugin) keyMap with it's client's keyMap.
doDisable( )

ADVANCED

Called when disabling/enabling the plugin/feature, not intended to be called directly. To enable or disable a plugin/feature, see disabled.

By default removes the cls of the plugin from its client. Override in subclasses to take any other actions necessary.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

disable

Fired when the plugin/feature is disabled.
enable

Fired when the plugin/feature is enabled.

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

InstancePlugin
Plugin

Useful configs and properties

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree2

Mixins2

Contents

InstancePlugin Plugin

Useful configs and properties

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree2

Mixins2

Contents

InstancePlugin
Plugin