UmbSorterController

This controller can make user able to sort items.

This example shows how to setup a sorter controller with no special needs. Assuming your declaring this on a Umbraco Element(UmbControllerHostElement):

const sorter = new UmbSorterController(this, {
itemSelector: '.item',
containerSelector: '.container',
getUniqueOfElement: (element) => element.dataset.id,
getUniqueOfModel: (model) => model.id
});

Type Parameters

  • T
  • ElementType extends HTMLElement = HTMLElement

Hierarchy (View Summary, Expand)

Constructors

Properties

activeDragElement?: HTMLElement
activeElement?: HTMLElement
activeIndex?: number
activeItem?: any
activeSorter?: UmbSorterController<unknown, HTMLElement>
dropSorter?: UmbSorterController<unknown, HTMLElement>
lastIndicationSorter?: UmbSorterController<unknown, HTMLElement>
originalIndex?: number
originalSorter?: UmbSorterController<unknown, HTMLElement>
rqaId?: number

Accessors

Methods

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

MMNEPVFCICPMFPCPTTAAATR