Interface ListEventMap<Type>

Component events

See

ComponentEventMap

Type Parameters

  • Type

Hierarchy

Properties

added beforehide beforeremove beforerender beforeshow delete drop dropallowed focus hide navigate remove render renderrows rowclick rowcontextmenu rowdblclick rowmousedown scrolleddown show sort

Properties

added

added: ((comp, index, parent) => void)

Type declaration

    • (comp, index, parent): void

    • Fires when this component is added to a parent but before rendering

      Parameters

      • comp: Type
      • index: number

        the index in the parents' items

      • parent: Component

      Returns void

beforehide

beforehide: ((comp) => false | void)

Type declaration

    • (comp): false | void

    • Fires before hide. You can cancel the hide by returning false.

      Parameters

      • comp: Type

      Returns false | void

      See

      Component.hide()

beforeremove

beforeremove: ((comp) => false | void)

Type declaration

    • (comp): false | void

    • Fires before the element is removed. You can cancel the remove by returning false

      Parameters

      • comp: Type

      Returns false | void

      See

      Component.remove()

beforerender

beforerender: ((comp) => void)

Type declaration

    • (comp): void

    • Fires just before rendering

      Parameters

      • comp: Type

      Returns void

      See

      Component.render()

beforeshow

beforeshow: ((comp) => false | void)

Type declaration

    • (comp): false | void

    • Fires before show. You can cancel the show by returning false

      Parameters

      • comp: Type

      Returns false | void

      See

      Component.show()

delete

delete: ((list) => void)

Type declaration

    • (list): void

    • Fires when the delete key is pressed

      Parameters

      • list: Type

      Returns void

drop

drop: ((list, e, dropRow, dropIndex, position, dragData) => void)

Type declaration

    • (list, e, dropRow, dropIndex, position, dragData): void

    • Fires when something was dropped

      Parameters

      • list: Type
      • e: DragEvent

        The draag event

      • dropRow: HTMLElement

        The row element that is dropped on

      • dropIndex: number

        Store index

      • position: DROP_POSITION
      • dragData: any

        The arbitrary drag data that is set

      Returns void

dropallowed

dropallowed: ((list, e, dropRow, dragData) => void)

Type declaration

    • (list, e, dropRow, dragData): void

    • Parameters

      • list: Type
      • e: DragEvent
      • dropRow: HTMLElement
      • dragData: any

      Returns void

focus

focus: ((comp, o?) => void)

Type declaration

    • (comp, o?): void

    • Fires on focus

      Parameters

      • comp: Type
      • Optional o: FocusOptions

      Returns void

hide

hide: ((comp) => void)

Type declaration

    • (comp): void

    • Fires after hiding the component

      Parameters

      • comp: Type

      Returns void

      See

      Component.show()

navigate

navigate: ((list, storeIndex) => void)

Type declaration

    • (list, storeIndex): void

    • Fires when a row is clicked or navigated with arrows

      Parameters

      • list: Type
      • storeIndex: number

      Returns void

remove

remove: ((comp) => void)

Type declaration

    • (comp): void

    • Fires after the component has been removed

      Parameters

      • comp: Type

      Returns void

      See

      Component.remove()

render

render: ((comp) => void)

Type declaration

    • (comp): void

    • Fires when the component renders and is added to the DOM

      Parameters

      • comp: Type

      Returns void

      See

      Component.render()

renderrows

renderrows: ((list, records) => void)

Type declaration

    • (list, records): void

    • Fires when records are rendered into rows.

      Parameters

      • list: Type
      • records: any[]

      Returns void

rowclick

rowclick: ((list, storeIndex, row, ev) => void)

Type declaration

    • (list, storeIndex, row, ev): void

    • Fires when a row is clicked

      Parameters

      • list: Type
      • storeIndex: number
      • row: HTMLElement
      • ev: MouseEvent

      Returns void

rowcontextmenu

rowcontextmenu: ((list, storeIndex, row, ev) => void)

Type declaration

    • (list, storeIndex, row, ev): void

    • Fires when a row is right clicked

      Parameters

      • list: Type
      • storeIndex: number
      • row: HTMLElement
      • ev: MouseEvent

      Returns void

rowdblclick

rowdblclick: ((list, storeIndex, row, ev) => void)

Type declaration

    • (list, storeIndex, row, ev): void

    • Fires when a row is double clicked

      Parameters

      • list: Type
      • storeIndex: number
      • row: HTMLElement
      • ev: MouseEvent

      Returns void

rowmousedown

rowmousedown: ((list, storeIndex, row, ev) => void)

Type declaration

    • (list, storeIndex, row, ev): void

    • Fires when a row is mousedowned

      Parameters

      • list: Type
      • storeIndex: number
      • row: HTMLElement
      • ev: MouseEvent

      Returns void

scrolleddown

scrolleddown: ((list) => void)

Type declaration

    • (list): void

    • Fires when the user scrolled to the bottom

      Parameters

      • list: Type

      Returns void

show

show: ((comp) => void)

Type declaration

    • (comp): void

    • Fires after showing the component

      Parameters

      • comp: Type

      Returns void

      See

      Component.show()

sort

sort: ((list, dataIndex) => void)

Type declaration

    • (list, dataIndex): void

    • Fires when the user sorts the list

      Parameters

      • list: Type
      • dataIndex: string

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc