Class MarqueeSelectPlugin

Hierarchy

BasePlugin
- MarqueeSelectPlugin

Index

Constructors

Properties

Methods

create onInstall onUninstall install uninstall addEventListener addDOMListener setTimeout setInterval getState setState requiresFeature

Constructors

constructor

new MarqueeSelectPlugin(options?: MarqueeSelectOptions): MarqueeSelectPlugin
Parameters
- Optionaloptions: MarqueeSelectOptions
Returns MarqueeSelectPlugin
Overrides BasePlugin.constructor
- Defined in src/plugins/MarqueeSelectPlugin.ts:255

Properties

`Readonly`name

name: "MarqueeSelect" = 'MarqueeSelect'

`Readonly`version

version: "2.0.0" = '2.0.0'

Methods

`Static`create

create(options?: MarqueeSelectOptions): MarqueeSelectPlugin
Parameters
- Optionaloptions: MarqueeSelectOptions
Returns MarqueeSelectPlugin
- Defined in src/plugins/MarqueeSelectPlugin.ts:251

`Protected`onInstall

onInstall(sortable: SortableInstance): void
Override this method to implement plugin installation logic
Parameters
- sortable: SortableInstance
Returns void
Overrides BasePlugin.onInstall
- Defined in src/plugins/MarqueeSelectPlugin.ts:264

`Protected`onUninstall

onUninstall(sortable: SortableInstance): void
Override this method to implement plugin uninstallation logic
Parameters
- sortable: SortableInstance
Returns void
Overrides BasePlugin.onUninstall
- Defined in src/plugins/MarqueeSelectPlugin.ts:309

install

install(sortable: SortableInstance): void
Install the plugin on a sortable instance
Parameters
- sortable: SortableInstance
Returns void
Inherited from BasePlugin.install
- Defined in src/plugins/PluginUtils.ts:52

uninstall

uninstall(sortable: SortableInstance): void
Uninstall the plugin from a sortable instance
Parameters
- sortable: SortableInstance
Returns void
Inherited from BasePlugin.uninstall
- Defined in src/plugins/PluginUtils.ts:64

`Protected`addEventListener

addEventListener(
    sortable: SortableInstance,
    eventName: string,
    listener: EventListener,
): void
Add an event listener to the sortable's event system
Parameters
- sortable: SortableInstance
- eventName: string
- listener: EventListener
Returns void
Inherited from BasePlugin.addEventListener
- Defined in src/plugins/PluginUtils.ts:91

`Protected`addDOMListener

addDOMListener(
    sortable: SortableInstance,
    element: Element,
    eventName: string,
    listener: EventListener,
): void
Add a DOM event listener
Parameters
- sortable: SortableInstance
- element: Element
- eventName: string
- listener: EventListener
Returns void
Inherited from BasePlugin.addDOMListener
- Defined in src/plugins/PluginUtils.ts:116

`Protected`setTimeout

setTimeout(
    sortable: SortableInstance,
    callback: () => void,
    delay: number,
): number
Set a timeout and track it for cleanup
Parameters
- sortable: SortableInstance
- callback: () => void
- delay: number
Returns number
Inherited from BasePlugin.setTimeout
- Defined in src/plugins/PluginUtils.ts:136

`Protected`setInterval

setInterval(
    sortable: SortableInstance,
    callback: () => void,
    interval: number,
): number
Set an interval and track it for cleanup
Parameters
- sortable: SortableInstance
- callback: () => void
- interval: number
Returns number
Inherited from BasePlugin.setInterval
- Defined in src/plugins/PluginUtils.ts:159

`Protected`getState

getState<T = unknown>(sortable: SortableInstance): undefined | T
Get or set plugin state for a sortable instance
Type Parameters
- T = unknown
Parameters
- sortable: SortableInstance
Returns undefined | T
Inherited from BasePlugin.getState
- Defined in src/plugins/PluginUtils.ts:178
getState<T = unknown>(sortable: SortableInstance, defaultValue: T): T
Get or set plugin state for a sortable instance
Type Parameters
- T = unknown
Parameters
- sortable: SortableInstance
- defaultValue: T
Returns T
Inherited from BasePlugin.getState
- Defined in src/plugins/PluginUtils.ts:179

`Protected`setState

setState<T = unknown>(sortable: SortableInstance, state: T): void
Set plugin state for a sortable instance
Type Parameters
- T = unknown
Parameters
- sortable: SortableInstance
- state: T
Returns void
Inherited from BasePlugin.setState
- Defined in src/plugins/PluginUtils.ts:198

`Protected`requiresFeature

requiresFeature(sortable: SortableInstance, feature: string): boolean
Check if sortable has required features
Parameters
- sortable: SortableInstance
- feature: string
Returns boolean
Inherited from BasePlugin.requiresFeature
- Defined in src/plugins/PluginUtils.ts:205

Class MarqueeSelectPlugin

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MarqueeSelectPlugin

Properties

Readonlyname

Readonlyversion

Methods

Staticcreate

Parameters

Returns MarqueeSelectPlugin

ProtectedonInstall

Parameters

Returns void

ProtectedonUninstall

Parameters

Returns void

install

Parameters

Returns void

uninstall

Parameters

Returns void

ProtectedaddEventListener

Parameters

Returns void

ProtectedaddDOMListener

Parameters

Returns void

ProtectedsetTimeout

Parameters

Returns number

ProtectedsetInterval

Parameters

Returns number

ProtectedgetState

Type Parameters

Parameters

Returns undefined | T

Type Parameters

Parameters

Returns T

ProtectedsetState

Type Parameters

Parameters

Returns void

ProtectedrequiresFeature

Parameters

Returns boolean

Settings

On This Page

`Readonly`name

`Readonly`version

`Static`create

`Protected`onInstall

`Protected`onUninstall

`Protected`addEventListener

`Protected`addDOMListener

`Protected`setTimeout

`Protected`setInterval

`Protected`getState

`Protected`setState

`Protected`requiresFeature