Interface EventsMixinInterface

Hierarchy

EventsMixinInterface
- Vue

Implemented by

EventsMixin

Index

Methods

Methods

$attachEvent

$attachEvent(add: Function, remove: Function): void

- Defined in components/mixins/events.ts:21
Bind an event to this Vue instance

Parameters
- add: Function
  
  Callback that attaches the event
- remove: Function
  
  Callback that detaches the event
Returns void

$onDocumentVisibility

$onDocumentVisibility(listener: function): void

- Defined in components/mixins/events.ts:77
Bind a document visibility change event to this Vue instance.

Parameters
- listener: function
  - - (hidden: boolean): void
    - Parameters
      - hidden: boolean
      Returns void
Returns void

$onEcho

$onEcho(type: ChannelType, channel: string, event: string, listener: Function): void

- Defined in components/mixins/events.ts:62
Bind an Echo event to this Vue instance.

Parameters
- type: ChannelType
  
  Channel type
- channel: string
  
  Channel name
- event: string
  
  Event name
- listener: Function
Returns void

$onEchoWhisper

$onEchoWhisper(type: ChannelType, channel: string, event: string, listener: Function): void

- Defined in components/mixins/events.ts:71
Bind an Echo whisper event to this Vue instance.

Parameters
- type: ChannelType
  
  Channel type
- channel: string
  
  Channel name
- event: string
  
  Event name
- listener: Function
Returns void

$onElResize

$onElResize(el: Element, listener: Function): void

- Defined in components/mixins/events.ts:36
Bind an element resize event to this Vue instance.

Parameters
- el: Element
  
  The element to await resize of
- listener: Function
Returns void

$onEventListener

$onEventListener<Payloads, T>(eventListener: EventListener<Payloads, string>, event: T, listener: function): void

- Defined in components/mixins/events.ts:52
Bind an EventListener event to this Vue instance.

Type parameters
- Payloads: EventListenerPayloads
- T: keyof Payloads
Parameters
- eventListener: EventListener<Payloads, string>
  
  The event listener
- event: T
  
  The event name/type
- listener: function
  - - (payload: Payloads[T]): void
    - Parameters
      - payload: Payloads[T]
      Returns void
Returns void

$onJS

$onJS(target: EventTarget, event: string, listener: EventListenerOrEventListenerObject): void

- Defined in components/mixins/events.ts:29
Bind an EventTarget event to this Vue instance.

Parameters
- target: EventTarget
  
  The target of the event
- event: string
  
  Event name
- listener: EventListenerOrEventListenerObject
Returns void

$onVue

$onVue(vm: Vue, event: string, listener: Function): void

- Defined in components/mixins/events.ts:44
Bind an event of another Vue instance to this Vue instance.

Parameters
- vm: Vue
  
  The other Vue instace
- event: string
  
  Event name
- listener: Function
Returns void

Generated using TypeDoc