Interface IFeature

The feature interface.

interface IFeature {
    get name(): string;
    destroy(): void;
    init(proxy: IProxy): void;
    update(data: UpdateEvent): void;
}

Implemented by

Index

Accessors

Methods

destroy init update

Accessors

name

get name(): string
Each feature needs to return a constant name that identifies the plugin. Build in features are using the prefix buildin:.

Returns string
- Defined in types.ts:77

Methods

destroy

destroy(): void
Destroys this feature. This function will be called by the carousel instance and should not be called manually.

Returns void
- Defined in types.ts:90

init

init(proxy): void
Initializes this feature. This function will be called by the carousel instance and should not be called manually.
Parameters
- proxy: IProxy
  the proxy instance between carousel and feature
Returns void
- Defined in types.ts:84

update

update(data): void
This triggers the feature to update its inner state. This function will be called by the carousel instance and should not be called manually. The carousel passes a data object that includes the update reason. This can be used to selectively/partially update sections of the feature.
Parameters
- data: UpdateEvent
  dataset that triggered the update
Returns void
- Defined in types.ts:100