Class UmbDictionaryPickerInputContext

This base provides the necessary for a class to become a context-api controller.

Hierarchy (View Summary)

UmbPickerInputContext<
    UmbDictionaryItemModel,
    UmbDictionaryTreeItemModel,
    UmbDictionaryPickerModalData,
    UmbDictionaryPickerModalValue,
>
- UmbDictionaryPickerInputContext

Constructors

constructor

new UmbDictionaryPickerInputContext(
host: UmbControllerHost,
): UmbDictionaryPickerInputContext
Parameters
- host: UmbControllerHost
Returns UmbDictionaryPickerInputContext
Overrides UmbPickerInputContext.constructor
- Defined in src/packages/dictionary/components/input-dictionary/input-dictionary.context.ts:18

Properties

_host

_host: UmbControllerHost

`Readonly`interactionMemory

interactionMemory: UmbInteractionMemoryManager = ...

`Optional`modalAlias

modalAlias?:
    | string
    | UmbModalToken<
        UmbPickerModalData<UmbDictionaryTreeItemModel>,
        UmbTreePickerModalValue,
    >

`Readonly`modalRoute

modalRoute: Observable<undefined | string> = ...

`Optional`repository

repository?: UmbItemRepository<UmbDictionaryItemModel>

`Readonly`selectedItems

selectedItems: Observable<UmbDictionaryItemModel[]>

`Readonly`selection

selection: Observable<string[]>

`Readonly`statuses

statuses: Observable<UmbRepositoryItemsStatus[]>

Accessors

controllerAlias

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

max

get max(): number
Define a maximum amount of selected items in this input, for this input to be valid.

Returns number
The maximum number of items required.
Inherited from UmbPickerInputContext.max
- Defined in src/packages/core/picker-input/picker-input.context.ts:44
set max(value: number): void
Parameters
- value: number
Returns void
Inherited from UmbPickerInputContext.max
- Defined in src/packages/core/picker-input/picker-input.context.ts:47

min

get min(): number
Define a minimum amount of selected items in this input, for this input to be valid.

Returns number
The minimum number of items required.
Inherited from UmbPickerInputContext.min
- Defined in src/packages/core/picker-input/picker-input.context.ts:56
set min(value: number): void
Parameters
- value: number
Returns void
Inherited from UmbPickerInputContext.min
- Defined in src/packages/core/picker-input/picker-input.context.ts:59

Methods

`Protected`_removeItem

_removeItem(unique: string): void
Parameters
- unique: string
Returns void
Inherited from UmbPickerInputContext._removeItem
- Defined in src/packages/core/picker-input/picker-input.context.ts:172

`Protected`_requestItemName

_requestItemName(unique: string): Promise<string>
Parameters
- unique: string
Returns Promise<string>
Inherited from UmbPickerInputContext._requestItemName
- Defined in src/packages/core/picker-input/picker-input.context.ts:156

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 UmbPickerInputContext.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbPickerInputContext.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 UmbPickerInputContext.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

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

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 UmbPickerInputContext.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

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 UmbPickerInputContext.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

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

getModalAlias

getModalAlias(): | undefined
| string
| UmbModalToken<
UmbPickerModalData<UmbDictionaryTreeItemModel>,
UmbTreePickerModalValue,
>
Gets the modal alias/token used for the picker modal.

Returns
    | undefined
    | string
    | UmbModalToken<
        UmbPickerModalData<UmbDictionaryTreeItemModel>,
        UmbTreePickerModalValue,
    >
The modal alias or token.

Memberof
UmbPickerInputContext
Inherited from UmbPickerInputContext.getModalAlias
- Defined in src/packages/core/picker-input/picker-input.context.ts:119

getModalData

getModalData(): undefined | Partial<UmbDictionaryPickerModalData>
Gets the stored modal data.

Returns undefined | Partial<UmbDictionaryPickerModalData>
The stored modal data.

Memberof
UmbPickerInputContext
Inherited from UmbPickerInputContext.getModalData
- Defined in src/packages/core/picker-input/picker-input.context.ts:137

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 UmbPickerInputContext.observe
- Defined in src/libs/class-api/class.interface.ts:27

openPicker

openPicker(pickerData?: Partial<UmbDictionaryPickerModalData>): Promise<void>
Parameters
- OptionalpickerData: Partial<UmbDictionaryPickerModalData>
Returns Promise<void>
Inherited from UmbPickerInputContext.openPicker
- Defined in src/packages/core/picker-input/picker-input.context.ts:141

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 UmbPickerInputContext.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

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 UmbPickerInputContext.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

requestRemoveItem

requestRemoveItem(unique: string): Promise<void>
Parameters
- unique: string
Returns Promise<void>
Inherited from UmbPickerInputContext.requestRemoveItem
- Defined in src/packages/core/picker-input/picker-input.context.ts:160

setModalAlias

setModalAlias(
    modalAlias:
        | string
        | UmbModalToken<
            UmbPickerModalData<UmbDictionaryTreeItemModel>,
            UmbTreePickerModalValue,
        >,
): void
Sets the modal alias/token to use for the picker modal.
Parameters
- modalAlias:
      | string
      | UmbModalToken<
          UmbPickerModalData<UmbDictionaryTreeItemModel>,
          UmbTreePickerModalValue,
      >
  The modal alias or token.
Returns void
Memberof
UmbPickerInputContext
Inherited from UmbPickerInputContext.setModalAlias
- Defined in src/packages/core/picker-input/picker-input.context.ts:109

setModalData

setModalData(modalData?: Partial<UmbDictionaryPickerModalData>): void
Sets modal data that will be used as base configuration for both direct openPicker() calls and modal route setup.
Parameters
- OptionalmodalData: Partial<UmbDictionaryPickerModalData>
  The modal data to store.
Returns void
Memberof
UmbPickerInputContext
Inherited from UmbPickerInputContext.setModalData
- Defined in src/packages/core/picker-input/picker-input.context.ts:128

setSelection

setSelection(selection: (null | string)[]): void
Parameters
- selection: (null | string)[]
Returns void
Inherited from UmbPickerInputContext.setSelection
- Defined in src/packages/core/picker-input/picker-input.context.ts:99

Class UmbDictionaryPickerInputContext

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbDictionaryPickerInputContext

Properties

_host

ReadonlyinteractionMemory

OptionalmodalAlias

ReadonlymodalRoute

Optionalrepository

ReadonlyselectedItems

Readonlyselection

Readonlystatuses

Accessors

controllerAlias

Returns UmbControllerAlias

max

Returns number

Parameters

Returns void

min

Returns number

Parameters

Returns void

Methods

Protected_removeItem

Parameters

Returns void

Protected_requestItemName

Parameters

Returns Promise<string>

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getModalAlias

Returns | undefined | string | UmbModalToken< UmbPickerModalData<UmbDictionaryTreeItemModel>, UmbTreePickerModalValue, >

Memberof

getModalData

Returns undefined | Partial<UmbDictionaryPickerModalData>

Memberof

getSelectedItemByUnique

Parameters

Returns undefined | UmbDictionaryItemModel

getSelectedItems

Returns UmbDictionaryItemModel[]

getSelection

Returns string[]

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

`Readonly`interactionMemory

`Optional`modalAlias

`Readonly`modalRoute

`Optional`repository

`Readonly`selectedItems

`Readonly`selection

`Readonly`statuses

`Protected`_removeItem

`Protected`_requestItemName

Returns
| undefined
| string
| UmbModalToken<
UmbPickerModalData<UmbDictionaryTreeItemModel>,
UmbTreePickerModalValue,
>