Class UmbHintController<HintType, IncomingHintType>

This mixin enables a web-component to host controllers. This enables controllers to be added to the life cycle of this element.

Type Parameters

HintType extends UmbHint = UmbHint
IncomingHintType extends UmbIncomingHintBase = UmbPartialSome<HintType, "unique" | "weight" | "path">

Hierarchy (View Summary)

UmbControllerBase
- UmbHintController
  - UmbHintContext

Constructors

constructor

new UmbHintController<
    HintType extends UmbHint = UmbHint,
    IncomingHintType extends
        UmbIncomingHintBase = UmbPartialSome<
        HintType,
        "weight"
        | "path"
        | "unique",
    >,
>(
    host: UmbControllerHost,
    args?: UmbHintControllerArgs<HintType>,
): UmbHintController<HintType, IncomingHintType>
Type Parameters
- HintType extends UmbHint = UmbHint
- IncomingHintType extends UmbIncomingHintBase = UmbPartialSome<HintType, "weight" | "path" | "unique">
Parameters
- host: UmbControllerHost
- Optionalargs: UmbHintControllerArgs<HintType>
Returns UmbHintController<HintType, IncomingHintType>
Overrides UmbControllerBase.constructor
- Defined in src/packages/core/hint/context/hint.controller.ts:48

Properties

_host

_host: UmbControllerHost

`Readonly`firstHint

firstHint: Observable<HintType> = ...

`Readonly`hints

hints: Observable<HintType[]> = ...

`Readonly`scaffold

scaffold: Observable<Partial<HintType>> = ...

Accessors

controllerAlias

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

Methods

_internal_descendingHintsByFilter

_internal_descendingHintsByFilter(
filter: (path: string[]) => boolean,
): Observable<undefined | UmbHint[]>
Internal
Parameters
- filter: (path: string[]) => boolean
  A filter function to filter the hints by their path.
Returns Observable<undefined | UmbHint[]>
An observable of an array of hints that match the filter.
- Defined in src/packages/core/hint/context/hint.controller.ts:106

add

add(hints: IncomingHintType[]): void
Add multiple rules
Parameters
- hints: IncomingHintType[]
  Array of hints to add
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:220

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

addOne

addOne(hint: IncomingHintType): string | symbol
Add a new hint
Parameters
- hint: IncomingHintType
  The hint to add
Returns string | symbol
Unique value of the hint
- Defined in src/packages/core/hint/context/hint.controller.ts:206

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

asObservablePart

asObservablePart<R>(fn: (hints: HintType[]) => R): Observable<R>
Type Parameters
- R
Parameters
- fn: (hints: HintType[]) => R
Returns Observable<R>
- Defined in src/packages/core/hint/context/hint.controller.ts:86

clear

clear(): void
Clear all hints

Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:262

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

descendingHints

descendingHints(viewAlias?: null | string): Observable<undefined | UmbHint[]>
Parameters
- OptionalviewAlias: null | string
Returns Observable<undefined | UmbHint[]>
- Defined in src/packages/core/hint/context/hint.controller.ts:90

destroy

destroy(): void
Returns void
Overrides UmbControllerBase.destroy
- Defined in src/packages/core/hint/context/hint.controller.ts:266

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

finishChange

finishChange(): void
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:197

getAll

getAll(): HintType[]
Get all hints

Returns HintType[]
Array of hints
- Defined in src/packages/core/hint/context/hint.controller.ts:255

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

getHostElement

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

getScaffold

getScaffold(): Partial<HintType>
Returns Partial<HintType>
- Defined in src/packages/core/hint/context/hint.controller.ts:44

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

getViewAlias

getViewAlias(): null | string
Returns null | string
- Defined in src/packages/core/hint/context/hint.controller.ts:20

has

has(unique: HintType["unique"]): boolean
Check if a hint exists
Parameters
- unique: HintType["unique"]
  Unique value of the hint to check
Returns boolean
True if the hint exists, false otherwise
- Defined in src/packages/core/hint/context/hint.controller.ts:247

inheritFrom

inheritFrom(
    parent:
        | undefined
        | UmbHintController<
            UmbHint,
            UmbPartialSome<UmbHint, "weight" | "path" | "unique">,
        >,
): void
Parameters
- parent:
      | undefined
      | UmbHintController<
          UmbHint,
          UmbPartialSome<UmbHint, "weight" | "path" | "unique">,
      >
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:122

initiateChange

initiateChange(): void
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:194

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

provideAt

provideAt(controllerHost: UmbClassInterface): void
Provide this validation context to a specific controller host. This can be used to Host a validation context in a Workspace, but provide it on a certain scope, like a specific Workspace View.
Parameters
- controllerHost: UmbClassInterface
  The controller host to provide this validation context to.
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:66

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

remove

remove(uniques: HintType["unique"][]): void
Remove multiple hints
Parameters
- uniques: HintType["unique"][]
  Array of unique values to remove
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:238

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

removeOne

removeOne(unique: HintType["unique"]): void
Remove a hint
Parameters
- unique: HintType["unique"]
  Unique value of the hint to remove
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:230

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

setPathFilter

setPathFilter(filter: (path: string[]) => boolean): void
Parameters
- filter: (path: string[]) => boolean
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:24

unprovide

unprovide(): void
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:75

updateScaffold

updateScaffold(updates: Partial<HintType>): void
Parameters
- updates: Partial<HintType>
Returns void
- Defined in src/packages/core/hint/context/hint.controller.ts:41

Class UmbHintController<HintType, IncomingHintType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbHintController<HintType, IncomingHintType>

Properties

_host

ReadonlyfirstHint

Readonlyhints

Readonlyscaffold

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

_internal_descendingHintsByFilter

Parameters

Returns Observable<undefined | UmbHint[]>

add

Parameters

Returns void

addEventListener

Parameters

Returns void

addOne

Parameters

Returns string | symbol

addUmbController

Parameters

Returns void

asObservablePart

Type Parameters

Parameters

Returns Observable<R>

clear

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

descendingHints

Parameters

Returns Observable<undefined | UmbHint[]>

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

finishChange

Returns void

getAll

Returns HintType[]

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getScaffold

Returns Partial<HintType>

getUmbControllers

Parameters

Returns UmbController[]

getViewAlias

Returns null | string

has

Parameters

Returns boolean

hasUmbController

`Readonly`firstHint

`Readonly`hints

`Readonly`scaffold