Class UmbPickerInputContext<PickedItemType, PickerItemType, PickerModalConfigType, PickerModalValueType>

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

Type Parameters

PickedItemType extends PickerItemBaseType = PickerItemBaseType
PickerItemType extends PickerItemBaseType = PickedItemType
PickerModalConfigType extends UmbPickerModalData<PickerItemType> = UmbPickerModalData<PickerItemType>
PickerModalValueType extends UmbPickerModalValue = UmbPickerModalValue

Hierarchy (View Summary)

UmbContextBase
- UmbPickerInputContext

Constructors

constructor

new UmbPickerInputContext<
    PickedItemType extends PickerItemBaseType = PickerItemBaseType,
    PickerItemType extends PickerItemBaseType = PickedItemType,
    PickerModalConfigType extends
        UmbPickerModalData<PickerItemType> = UmbPickerModalData<PickerItemType>,
    PickerModalValueType extends UmbPickerModalValue = UmbPickerModalValue,
>(
    host: UmbControllerHost,
    repositoryAlias: string,
    modalAlias:
        | string
        | UmbModalToken<UmbPickerModalData<PickerItemType>, PickerModalValueType>,
    getUniqueMethod?: (entry: PickedItemType) => undefined | string,
): UmbPickerInputContext<
    PickedItemType,
    PickerItemType,
    PickerModalConfigType,
    PickerModalValueType,
>
Creates an instance of UmbPickerInputContext.
Type Parameters
- PickedItemType extends PickerItemBaseType = PickerItemBaseType
- PickerItemType extends PickerItemBaseType = PickedItemType
- PickerModalConfigType extends UmbPickerModalData<PickerItemType> = UmbPickerModalData<PickerItemType>
- PickerModalValueType extends UmbPickerModalValue = UmbPickerModalValue
Parameters
- host: UmbControllerHost
  The host for the controller.
- repositoryAlias: string
  The alias of the repository to use.
- modalAlias: string | UmbModalToken<UmbPickerModalData<PickerItemType>, PickerModalValueType>
  The alias of the modal to use.
- OptionalgetUniqueMethod: (entry: PickedItemType) => undefined | string
  DEPRECATED since 15.3. Will be removed in v. 17: A method to get the unique key from the item.
Returns UmbPickerInputContext<
    PickedItemType,
    PickerItemType,
    PickerModalConfigType,
    PickerModalValueType,
>
Memberof
UmbPickerInputContext
Overrides UmbContextBase.constructor
- Defined in src/packages/core/picker-input/picker-input.context.ts:65

Properties

`Readonly`selection

selection: Observable<string[]>

`Readonly`statuses

statuses: Observable<UmbRepositoryItemsStatus[]>

Accessors

controllerAlias

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

max

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

Returns number
- Defined in src/packages/core/picker-input/picker-input.context.ts:38
set max(value: number): void
Parameters
- value: number
Returns void
- Defined in src/packages/core/picker-input/picker-input.context.ts:41

min

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

Returns number
- Defined in src/packages/core/picker-input/picker-input.context.ts:49
set min(value: number): void
Parameters
- value: number
Returns void
- Defined in src/packages/core/picker-input/picker-input.context.ts:52

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

addUmbController

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

destroy

destroy(): void
Returns void
Inherited from UmbContextBase.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 UmbContextBase.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 UmbContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

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

getSelection

getSelection(): string[]
Returns string[]
- Defined in src/packages/core/picker-input/picker-input.context.ts:92

getUmbControllers

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

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbContextBase.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Inherited from UmbContextBase.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbContextBase.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

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

openPicker

openPicker(pickerData?: Partial<PickerModalConfigType>): Promise<void>
Parameters
- OptionalpickerData: Partial<PickerModalConfigType>
Returns Promise<void>
- Defined in src/packages/core/picker-input/picker-input.context.ts:101

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

removeUmbController

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

removeUmbControllerByAlias

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

requestRemoveItem

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

setSelection

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

Class UmbPickerInputContext<PickedItemType, PickerItemType, PickerModalConfigType, PickerModalValueType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbPickerInputContext< PickedItemType, PickerItemType, PickerModalConfigType, PickerModalValueType,>

Memberof

Properties

_host

ReadonlyinteractionMemory

modalAlias

Optionalrepository

ReadonlyselectedItems

Readonlyselection

Readonlystatuses

Accessors

controllerAlias

Returns UmbControllerAlias

max

Returns number

Parameters

Returns void

min

Returns number

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

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getSelection

Returns string[]

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

openPicker

Parameters

Returns Promise<void>

Returns UmbPickerInputContext<
PickedItemType,
PickerItemType,
PickerModalConfigType,
PickerModalValueType,
>

`Readonly`interactionMemory

`Optional`repository

`Readonly`selectedItems

`Readonly`selection

`Readonly`statuses