Class ComponentCaller<TData, TProperty, TMethod, TComponentExport>

constructor

• new ComponentCaller<TData, TProperty, TMethod, TComponentExport>(): ComponentCaller<TData, TProperty, TMethod, TComponentExport>

• Type Parameters

  • TData extends DataList
  • TProperty extends PropertyList
  • TMethod extends MethodList
  • TComponentExport

  Returns ComponentCaller<TData, TProperty, TMethod, TComponentExport>

_$

data

• get data(): Merge<AllData<TData, TProperty>>

• The component data and property values

  Returns Merge<AllData<TData, TProperty>>
• set data(value): void

• Parameters

  • value: AllData<TData, TProperty>

  Returns void

dataset

• get dataset(): null | {
      [key: string]: any;
  }

• The data-* field in the template

  Returns null | {
      [key: string]: any;
  }
• set dataset(value): void

• Parameters

  • value: null | {
        [key: string]: any;
    }

  Returns void

id

• get id(): string

• The id field in the template

  Returns string
• set id(value): void

• Parameters

  • value: string

  Returns void

is

• get is(): string

• The component path in the code space

  Returns string
• set is(value): void

• Parameters

  • value: string

  Returns void

properties

• get properties(): Merge<AllData<TData, TProperty>>

• The component data and property values (same as data )

  Returns Merge<AllData<TData, TProperty>>
• set properties(value): void

• Parameters

  • value: AllData<TData, TProperty>

  Returns void

applyDataUpdates

• applyDataUpdates(): void

• Apply all scheduled updates immediately

  Inside observers, it is generally not .

  Returns void

asInstanceOf

• asInstanceOf<UData, UProperty, UMethod, UComponentExport>(componentType): null | component.Component<UData, UProperty, UMethod, UComponentExport, Empty>

• Cast the component into the specified type

  Returns null if the component node is not the instance of the specified component.

  Type Parameters

  • UData extends DataList
  • UProperty extends PropertyList
  • UMethod extends MethodList
  • UComponentExport

  Parameters

  • componentType: ComponentType<UData, UProperty, UMethod, UComponentExport>

  Returns null | component.Component<UData, UProperty, UMethod, UComponentExport, Empty>

createIntersectionObserver

• createIntersectionObserver(options?): IntersectionObserver

• Create an intersection observer

  Parameters

  • Optional options: {
        initialRatio?: number;
        observeAll?: boolean;
        thresholds?: number[];
    }

    • Optional initialRatio?: number

    • Optional observeAll?: boolean

    • Optional thresholds?: number[]

  Returns IntersectionObserver

createMediaQueryObserver

• createMediaQueryObserver(): MediaQueryObserver

• Create an media query observer

  Returns MediaQueryObserver

createSelectorQuery

• createSelectorQuery(): SelectorQuery

• Create a selector query for searching element inside the component

  Returns SelectorQuery

general

• general(): component.GeneralComponent

• Cast the component into a general-typed one

  Returns component.GeneralComponent

getRelationNodes

• getRelationNodes(relationKey): component.GeneralComponent[]

• Parameters

  • relationKey: string

  Returns component.GeneralComponent[]

groupSetData

• groupSetData(callback): void

• Group several data update calls

  This method is designed for hinting the backend that some updates should be handled together. However, this is done automatically now, so this method is just for backward compatibilities.

  Parameters

  • callback: (() => void)
    • • (): void

      • Returns void

  Returns void

groupUpdates

• groupUpdates<T>(callback): undefined | T

• Pending all data updates in the callback, and apply updates after callback returns

  This function helps grouping several replaceDataOnPath or spliceArrayDataOnPath calls, and then apply them at the end of the callback. setData and applyDataUpdates calls inside the callback still apply updates immediately.

  Type Parameters

  • T

  Parameters

  • callback: (() => T)
    • • (): T

      • Returns T

  Returns undefined | T

hasBehavior

• hasBehavior(behavior): boolean

• Check whether the other behavior is a dependent behavior or a implemented trait behavior

  Parameters

  • behavior: behavior.GeneralBehavior | behavior.TraitBehavior<any, any>

  Returns boolean

replaceDataOnPath

• replaceDataOnPath<T>(path, data): void

• Schedule a data update on a single specified path

  The data update will not be applied until next setData or applyDataUpdates call. All data observers will not be triggered immediately before applied. Reads of the data will get the unchanged value before applied.

  Type Parameters

  • T extends (string | number)[]

  Parameters

  • path: readonly [T]
  • data: GetFromDataPath<DataWithPropertyValues<TData, TProperty>, T>

  Returns void

selectAllComponents

• selectAllComponents(selector): component.GeneralComponent[]

• Query all elements inside the component

  If componentType is provided, this method will check the selected component type. If a component type does not match, it is not returned.

  Parameters

  • selector: string

  Returns component.GeneralComponent[]
• selectAllComponents<UData, UProperty, UMethod, UComponentExport>(selector, componentType): ExportType<UData, UProperty, UMethod, UComponentExport>[]

• Type Parameters

  • UData extends DataList
  • UProperty extends PropertyList
  • UMethod extends MethodList
  • UComponentExport

  Parameters

  • selector: string
  • componentType: ComponentType<UData, UProperty, UMethod, UComponentExport>

  Returns ExportType<UData, UProperty, UMethod, UComponentExport>[]

selectComponent

• selectComponent(selector): any

• Query an element inside the component

  If componentType is provided, this method will check the selected component type. If the component type does not match, null is returned.

  Parameters

  • selector: string

  Returns any
• selectComponent<UData, UProperty, UMethod, UComponentExport>(selector, componentType): null | ExportType<UData, UProperty, UMethod, UComponentExport>

• Type Parameters

  • UData extends DataList
  • UProperty extends PropertyList
  • UMethod extends MethodList
  • UComponentExport

  Parameters

  • selector: string
  • componentType: ComponentType<UData, UProperty, UMethod, UComponentExport>

  Returns null | ExportType<UData, UProperty, UMethod, UComponentExport>

selectOwnerComponent

• selectOwnerComponent(): any

• Get the owner component

  If componentType is provided, this method will check the selected component type. If a component type does not match, null is returned.

  Returns any
• selectOwnerComponent<UData, UProperty, UMethod, UComponentExport>(componentType): null | ExportType<UData, UProperty, UMethod, UComponentExport>

• Type Parameters

  • UData extends DataList
  • UProperty extends PropertyList
  • UMethod extends MethodList
  • UComponentExport

  Parameters

  • componentType: ComponentType<UData, UProperty, UMethod, UComponentExport>

  Returns null | ExportType<UData, UProperty, UMethod, UComponentExport>

setData

• setData(newData, callback?): void

• Do a classic data update

  The callback is called after the update applies in the backend. In most cases, you SHOULD NOT wait the backend update (that might be very slow), and most calls, including read calls such as selectComponent , simply works immediately. However, when called inside observers, the data update will not be applied to templates immediately (it is recommanded to use updateData instead in observers).

  Parameters

  • newData: Partial<IsAny<DataWithPropertyValues<TData, TProperty>> extends true
        ? Record<`${any}`, DataWithPropertyValues<TData, TProperty>>
        : UnionToIntersection<DataWithPropertyValues<TData, TProperty> extends any[]
            ? {
                [P in number]: (IsAny<((...) & (...) & (...))[P]> extends true
                    ? Record<SetDataStringPath<any, `${(...)}`>, ((...) & (...) & (...))[P]>
                    : UnionToIntersection<(...)[(...)] extends (...)[]
                        ? (...)[(...)]
                        : (...) extends (...)
                            ? (...)
                            : (...)>) & Record<`${P}`, ((...)[] & TData & PropertyValues<(...)>)[P]>
            }[(keyof any[] | keyof TProperty | keyof TData) & number]
            : DataWithPropertyValues<TData, TProperty> extends Record<string | number, any>
                ? {
                    [P in string | number]: (IsAny<(...)[(...)]> extends true
                        ? Record<SetDataStringPath<(...), (...)>, (...)[(...)]>
                        : UnionToIntersection<(...) extends (...)
                            ? (...)
                            : (...)>) & Record<`${P}`, DataWithPropertyValues<(...), (...)>[P]>
                }[(keyof TProperty | keyof TData) & (string | number)]
                : never>>
  • Optional callback: (() => void)
    • • (): void

      • Returns void

  Returns void

spliceArrayDataOnPath

• spliceArrayDataOnPath<T>(path, index, del, inserts): void

• Schedule an array update

  The behavior is like Array.prototype.slice . Break the array before the index-th item, delete del items, and insert some items here. If index is undefined, negative, or larger than the length of the array, no items will be deleted and new items will be appended to the end of the array. The data update will not be applied until next setData or applyDataUpdates call. All data observers will not be triggered immediately before applied. Reads of the data will get the unchanged value before applied.

  Type Parameters

  • T extends (string | number)[]

  Parameters

  • path: readonly [T]
  • index: GetFromDataPath<DataWithPropertyValues<TData, TProperty>, T> extends any[]
        ? undefined | number
        : never
  • del: GetFromDataPath<DataWithPropertyValues<TData, TProperty>, T> extends any[]
        ? undefined | number
        : never
  • inserts: GetFromDataPath<DataWithPropertyValues<TData, TProperty>, T> extends I[]
        ? I[]
        : never

  Returns void

traitBehavior

• traitBehavior<TOut>(traitBehavior): undefined | TOut

• Get the trait behavior implementation of the component

  Returns undefined if the specified trait behavior is not implemented.

  Type Parameters

  • TOut extends {
        [key: string]: any;
    }

  Parameters

  • traitBehavior: behavior.TraitBehavior<any, TOut>

  Returns undefined | TOut

triggerEvent

• triggerEvent(name, detail, options): void

• Trigger an event

  Parameters

  • name: string
  • detail: any
  • options: {
        bubbles?: boolean;
        capturePhase?: boolean;
        composed?: boolean;
    }

    • Optional bubbles?: boolean

    • Optional capturePhase?: boolean

    • Optional composed?: boolean

  Returns void

updateData

• updateData(newData): void

• Schedule a classic data updates

  The data update will not be applied until next setData or applyDataUpdates call. When called inside observers, the data update will be applied when observer ends. All data observers will not be triggered immediately before applied. Reads of the data will get the unchanged value before applied.

  Parameters

  • newData: Partial<SetDataSetter<DataWithPropertyValues<TData, TProperty>>>

  Returns void