Class UmbSorterController<T, ElementType>

UmbSorterController

Implements

Description

This controller can make user able to sort items.

Example

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)

UmbControllerBase
- UmbSorterController

Constructors

constructor

new UmbSorterController<T, ElementType extends HTMLElement = HTMLElement>(
host: UmbControllerHostElement,
config: UmbSorterConfig<T, ElementType>,
): UmbSorterController<T, ElementType>
Type Parameters
- T
- ElementType extends HTMLElement = HTMLElement
Parameters
- host: UmbControllerHostElement
- config: UmbSorterConfig<T, ElementType>
Returns UmbSorterController<T, ElementType>
Overrides UmbControllerBase.constructor
- Defined in src/packages/core/sorter/sorter.controller.ts:319

Properties

_host

_host: UmbControllerHost

`Static` `Optional`activeDragElement

activeDragElement?: HTMLElement

`Static` `Optional`activeElement

activeElement?: HTMLElement

`Static` `Optional`activeIndex

activeIndex?: number

`Static` `Optional`activeItem

activeItem?: any

`Static` `Optional`activeSorter

activeSorter?: UmbSorterController<unknown, HTMLElement>

`Static` `Optional`dropSorter

dropSorter?: UmbSorterController<unknown, HTMLElement>

`Static` `Optional`lastIndicationSorter

lastIndicationSorter?: UmbSorterController<unknown, HTMLElement>

`Static` `Optional`originalIndex

originalIndex?: number

`Static` `Optional`originalSorter

originalSorter?: UmbSorterController<unknown, HTMLElement>

`Static` `Optional`rqaId

rqaId?: number

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbControllerBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

identifier

get identifier(): UniqueType
Returns UniqueType
- Defined in src/packages/core/sorter/sorter.controller.ts:309
set identifier(identifier: UniqueType): void
Parameters
- identifier: UniqueType
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:312

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbControllerBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Inherited from UmbControllerBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

destroyItem

destroyItem(element: HTMLElement): void
Parameters
- element: HTMLElement
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:667

disable

disable(): void
Disables the sorter, this will prevent any sorting to happen.

Returns void
{void}

Memberof
UmbSorterController
- Defined in src/packages/core/sorter/sorter.controller.ts:367

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

enable

enable(): void
Enables the sorter, this will allow sorting to happen.

Returns void
{void}

Memberof
UmbSorterController
- Defined in src/packages/core/sorter/sorter.controller.ts:354

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getElementOfItem

getElementOfItem(item: T): undefined | ElementType
Parameters
- item: T
Returns undefined | ElementType
- Defined in src/packages/core/sorter/sorter.controller.ts:1232

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbControllerBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getItem

getItem(unique: UniqueType): undefined | T
Parameters
- unique: UniqueType
Returns undefined | T
- Defined in src/packages/core/sorter/sorter.controller.ts:392

getItemOfElement

getItemOfElement(element: ElementType): undefined | T
Management methods:
Parameters
- element: ElementType
Returns undefined | T
- Defined in src/packages/core/sorter/sorter.controller.ts:1220

getModel

getModel(): T[]
Returns the model of the sorter.

Returns T[]
The model of this sorter.

Memberof
UmbSorterController
- Defined in src/packages/core/sorter/sorter.controller.ts:384

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbControllerBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

hasItem

hasItem(unique: UniqueType): boolean
Parameters
- unique: UniqueType
Returns boolean
- Defined in src/packages/core/sorter/sorter.controller.ts:388

hasOtherItemsThan

hasOtherItemsThan(item: T): boolean
Parameters
- item: T
Returns boolean
- Defined in src/packages/core/sorter/sorter.controller.ts:1261

moveItemInModel

moveItemInModel(
newIndex: number,
fromCtrl: undefined | UmbSorterController<T, ElementType>,
): Promise<boolean>
Parameters
- newIndex: number
- fromCtrl: undefined | UmbSorterController<T, ElementType>
Returns Promise<boolean>
- Defined in src/packages/core/sorter/sorter.controller.ts:1265

notifyAllowed

notifyAllowed(): void
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:1491

notifyDisallowed

notifyDisallowed(): void
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:1483

notifyRequestMove

notifyRequestMove(data: any): boolean
Parameters
- data: any
Returns boolean
- Defined in src/packages/core/sorter/sorter.controller.ts:1499

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeAllowIndication

removeAllowIndication(): void
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:1415

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbControllerBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeItem

removeItem(item: T): Promise<boolean>
Parameters
- item: T
Returns Promise<boolean>
- Defined in src/packages/core/sorter/sorter.controller.ts:1242

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbControllerBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

setModel

setModel(model: undefined | T[]): void
Parameters
- model: undefined | T[]
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:375

setupItem

setupItem(element: ElementType): void
Parameters
- element: ElementType
Returns void
- Defined in src/packages/core/sorter/sorter.controller.ts:632

updateAllowIndication

updateAllowIndication(item: T): boolean
Parameters
- item: T
Returns boolean
- Defined in src/packages/core/sorter/sorter.controller.ts:1400

Class UmbSorterController<T, ElementType>

Implements

Description

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbSorterController<T, ElementType>

Properties

_host

Static OptionalactiveDragElement

Static OptionalactiveElement

Static OptionalactiveIndex

Static OptionalactiveItem

Static OptionalactiveSorter

Static OptionaldropSorter

Static OptionallastIndicationSorter

Static OptionaloriginalIndex

Static OptionaloriginalSorter

Static OptionalrqaId

Accessors

controllerAlias

Returns UmbControllerAlias

identifier

Returns UniqueType

Parameters

Returns void

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

destroyItem

Parameters

Returns void

disable

Returns void

Memberof

dispatchEvent

Parameters

Returns boolean

enable

Returns void

Memberof

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getElementOfItem

Parameters

Returns undefined | ElementType

getHostElement

Returns Element

getItem

Parameters

Returns undefined | T

getItemOfElement

Parameters

Returns undefined | T

getModel

`Static` `Optional`activeDragElement

`Static` `Optional`activeElement

`Static` `Optional`activeIndex

`Static` `Optional`activeItem

`Static` `Optional`activeSorter

`Static` `Optional`dropSorter

`Static` `Optional`lastIndicationSorter

`Static` `Optional`originalIndex

`Static` `Optional`originalSorter

`Static` `Optional`rqaId