Home Reference Source 
import Announcement from '@shopify/draggable/src/Draggable/Plugins/Announcement/Announcement.js'
public class | source

Announcement

Extends:

* → Announcement

Announcement plugin

Constructor Summary

Public Constructor
public

constructor(draggable: Draggable)

Announcement constructor.

Member Summary

Public Members
public

Plugin options
public

Original draggable trigger method.

Method Summary

Public Methods
public

attach()

Attaches listeners to draggable
public

detach()

Detaches listeners from draggable
public

getOptions(): *

Returns passed in options
Private Methods
private

Announces event
private

Announces message to screen reader
private

Destroy hander
private

Initialize hander

Public Constructors

public constructor(draggable: Draggable) source

Announcement constructor.

Params:

NameTypeAttributeDescription
draggable Draggable

Draggable instance

Public Members

public options: Object source

Plugin options

Properties:

NameTypeAttributeDescription
options *

public originalTriggerMethod: Function source

Original draggable trigger method. Hack until we have onAll or on('all')

Properties:

NameTypeAttributeDescription
originalTriggerMethod *

Public Methods

public attach() source

Attaches listeners to draggable

public detach() source

Detaches listeners from draggable

public getOptions(): * source

Returns passed in options

Return:

*

Private Methods

private [announceEvent](event: AbstractEvent) source

Announces event

Params:

NameTypeAttributeDescription
event AbstractEvent

private [announceMessage](message: String) source

Announces message to screen reader

Params:

NameTypeAttributeDescription
message String

private [onDestroy]() source

Destroy hander

private [onInitialize]() source

Initialize hander