Class Component<TData, TProperty, TMethod>

constructor

• new Component<TData, TProperty, TMethod>(): glassEasel.Component<TData, TProperty, TMethod>

• Type Parameters

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

  Returns glassEasel.Component<TData, TProperty, TMethod>

[COMPONENT_SYMBOL]

shadowRoot

tagName

Static isComponent

$

• get $(): {
      [id: string]: glassEasel.Element;
  } | {
      [id: string]: GeneralBackendElement;
  }

• Returns {
      [id: string]: glassEasel.Element;
  } | {
      [id: string]: GeneralBackendElement;
  }

data

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

• Returns Merge<DataWithPropertyValues<TData, TProperty>>

• set data(newData): void

• Parameters

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

  Returns void

is

• get is(): string

• Returns string

properties

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

• Returns Merge<DataWithPropertyValues<TData, TProperty>>

addLifetimeListener

• addLifetimeListener<N>(name, func): void

• Add a lifetime event listener on the component

  Type Parameters

  • N extends keyof Lifetimes

  Parameters

  • name: N
  • func: Lifetimes[N]

  Returns void

addPageLifetimeListener

• addPageLifetimeListener(name, func): void

• Add a page lifetime event listener on the component

  Parameters

  • name: string
  • func: ((...args) => void)
    • • (...args): void

      • Parameters

        • Rest ...args: unknown[]

        Returns void

  Returns void

applyDataUpdates

• applyDataUpdates(): void

• Apply all scheduled updates immediately

  Inside observers, it is generally not .

  Returns void

applyExternalClassChanges

• applyExternalClassChanges(): void

• Update multiple external class values

  Returns void

applyTemplateUpdates

• applyTemplateUpdates(): void

• Apply the template updates to this component instance

  This method throws error if the template engine does not support template update.

  Returns void

asInstanceOf

• asInstanceOf<UData, UProperty, UMethod>(componentDefinition): null | ComponentInstance<UData, UProperty, UMethod, Empty>

• Cast a general component node to the instance of the specified component

  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

  Parameters

  • componentDefinition: glassEasel.ComponentDefinition<UData, UProperty, UMethod>

  Returns null | ComponentInstance<UData, UProperty, UMethod, Empty>

callMethod

• callMethod<T>(methodName, ...args): any

• Call a method

  If useMethodCallerListeners option is set for this component, this method will use the corresponding fields in the methodCaller . Returns undefined if there is no such method.

  Type Parameters

  • T extends string

  Parameters

  • methodName: T
  • Rest ...args: any[]

  Returns any

dynamicAddObserver

• dynamicAddObserver(func, dataPaths): void

• Add an observer on the runtime

  Parameters

  • func: DataObserver
  • dataPaths: string | readonly string[]

  Returns void

  Note

  This method is for debug or inspect use only, do not use it in production.

general

• general(): glassEasel.GeneralComponent

• Returns glassEasel.GeneralComponent

getComponentDefinition

• getComponentDefinition(): glassEasel.ComponentDefinition<TData, TProperty, TMethod>

• Get the corresponding component definition

  Returns glassEasel.ComponentDefinition<TData, TProperty, TMethod>

getComponentOptions

• getComponentOptions(): NormalizedComponentOptions

• Get the options of the component

  Returns NormalizedComponentOptions

getEventObject

• getEventObject(e): ShadowedEvent<any>

• Get the final event object

  Parameters

  • e: ShadowedEvent<unknown>

  Returns ShadowedEvent<any>

getExternalClasses

• getExternalClasses(): {
      [name: string]: string[] | undefined;
  }

• Get all external classes

  Returns {
      [name: string]: string[] | undefined;
  }

  • [name: string]: string[] | undefined

getMethodCaller

• getMethodCaller(): ComponentInstance<TData, TProperty, TMethod, Empty>

• Get the current caller set by setMethodCaller

  Returns ComponentInstance<TData, TProperty, TMethod, Empty>

getOwnerSpace

• getOwnerSpace(): ComponentSpace

• Returns the owner component space of this component

  Returns ComponentSpace

getRelationNodes

• getRelationNodes(relationKey): glassEasel.GeneralComponent[]

• Get the target elements of a relation

  Parameters

  • relationKey: string

  Returns glassEasel.GeneralComponent[]

getRootBehavior

• getRootBehavior(): glassEasel.Behavior<TData, TProperty, TMethod, any, Empty>

• Get the root behavior of the component

  Returns glassEasel.Behavior<TData, TProperty, TMethod, any, Empty>

getShadowRoot

• getShadowRoot(): null | ShadowRoot

• Returns the shadow root element

  Returns null for external components.

  Returns null | ShadowRoot

groupUpdates

• groupUpdates<T>(callback): 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 T

hasBehavior

• hasBehavior(other): boolean

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

  Parameters

  • other: string | glassEasel.GeneralBehavior | glassEasel.TraitBehavior<any, any>

  Returns boolean

hasExternalClass

• hasExternalClass(name): boolean

• Check the existence of an external class

  Parameters

  • name: string

  Returns boolean

hasPendingChanges

• hasPendingChanges(): boolean

• Check whether there are pending changes or not

  Returns boolean

isExternal

• isExternal(): boolean

• Get whether the component is external or not

  Returns boolean

isInnerDataExcluded

• isInnerDataExcluded(fieldName): boolean

• Check a field is excluded by pureDataPattern or not

  Parameters

  • fieldName: string

  Returns boolean

removeLifetimeListener

• removeLifetimeListener<N>(name, func): void

• remove a lifetime event listener on the component

  Type Parameters

  • N extends keyof Lifetimes

  Parameters

  • name: N
  • func: Lifetimes[N]

  Returns void

removePageLifetimeListener

• removePageLifetimeListener(name, func): void

• remove a page lifetime event listener on the component

  Parameters

  • name: string
  • func: ((...args) => void)
    • • (...args): void

      • Parameters

        • Rest ...args: unknown[]

        Returns void

  Returns void

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 DataPath

  Parameters

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

  Returns void

scheduleExternalClassChange

• scheduleExternalClassChange(name, target): void

• Schedule an update for an external class value

  Parameters

  • name: string
  • target: string | string[]

  Returns void

setData

• setData(newData?): void

• Do a classic data updates

  This method apply updates immediately, so there is no async callback. When called inside observers, the data update will not be applied to templates. Inside observers, it is recommended to use updateData instead.

  Parameters

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

  Returns void

setExternalClass

• setExternalClass(name, target): void

• Update an external class value

  Parameters

  • name: string
  • target: string | string[]

  Returns void

setMethodCaller

• setMethodCaller(caller): void

• Set the caller (a.k.a. this ) of event callbacks and life-time callbacks

  By default, the caller is the component instance itself. Use this method to override this behavior.

  Parameters

  • caller: ComponentInstance<TData, TProperty, TMethod, Empty>

  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 DataPath

  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 {
        [x: string]: any;
    }

  Parameters

  • traitBehavior: glassEasel.TraitBehavior<any, TOut>

  Returns undefined | TOut

triggerLifetime

• triggerLifetime(name, args): void

• Triggers a life-time callback on an element

  Normally external life-times should only be triggered by template engine. Most cases should take a common method instead.

  Parameters

  • name: string
  • args: any[]

  Returns void

triggerPageLifetime

• triggerPageLifetime(name, args): void

• Triggers a page-life-time callback on an element

  Parameters

  • name: string
  • args: any[]

  Returns void

triggerWorkletChangeLifetime

• triggerWorkletChangeLifetime(name, value): void

• Triggers a worklet change lifetime

  Parameters

  • name: string
  • value: unknown

  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

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

  Returns void

Static _$advancedCreate

• _$advancedCreate<TData, TProperty, TMethod>(tagName, def, owner, backendContext, genericImpls, placeholderHandlerRemover, initPropValues?): ComponentInstance<TData, TProperty, TMethod, Empty>

• Type Parameters

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

  Parameters

  • tagName: string
  • def: glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • owner: null | ShadowRoot
  • backendContext: null | GeneralBackendContext
  • genericImpls: null | {
        [name: string]: ComponentDefinitionWithPlaceholder;
    }
  • placeholderHandlerRemover: undefined | (() => void)
  • Optional initPropValues: ((comp) => void)
    • • (comp): void

      • Parameters

        • comp: ComponentInstance<TData, TProperty, TMethod, Empty>

        Returns void

  Returns ComponentInstance<TData, TProperty, TMethod, Empty>

Static create

• create<TData, TProperty, TMethod>(tagName, componentDefinition, initPropValues?): ComponentInstance<TData, TProperty, TMethod, Empty>

• Type Parameters

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

  Parameters

  • tagName: string | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • componentDefinition: null | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • Optional initPropValues: ((comp) => void)
    • • (comp): void

      • Parameters

        • comp: ComponentInstance<TData, TProperty, TMethod, Empty>

        Returns void

  Returns ComponentInstance<TData, TProperty, TMethod, Empty>

Static createWithContext

• createWithContext<TData, TProperty, TMethod>(tagName, componentDefinition, backendContext, initPropValues?): ComponentInstance<TData, TProperty, TMethod, Empty>

• Type Parameters

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

  Parameters

  • tagName: string | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • componentDefinition: null | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • backendContext: null | GeneralBackendContext
  • Optional initPropValues: ((comp) => void)
    • • (comp): void

      • Parameters

        • comp: ComponentInstance<TData, TProperty, TMethod, Empty>

        Returns void

  Returns ComponentInstance<TData, TProperty, TMethod, Empty>

Static createWithGenerics

• createWithGenerics<TData, TProperty, TMethod>(tagName, componentDefinition, genericImpls, initPropValues?): ComponentInstance<TData, TProperty, TMethod, Empty>

• Type Parameters

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

  Parameters

  • tagName: string | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • componentDefinition: null | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • genericImpls: null | {
        [name: string]: glassEasel.GeneralComponentDefinition;
    }
  • Optional initPropValues: ((comp) => void)
    • • (comp): void

      • Parameters

        • comp: ComponentInstance<TData, TProperty, TMethod, Empty>

        Returns void

  Returns ComponentInstance<TData, TProperty, TMethod, Empty>

Static createWithGenericsAndContext

• createWithGenericsAndContext<TData, TProperty, TMethod>(tagName, componentDefinition, genericTargets, backendContext, initPropValues?): ComponentInstance<TData, TProperty, TMethod, Empty>

• Type Parameters

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

  Parameters

  • tagName: string | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • componentDefinition: null | glassEasel.ComponentDefinition<TData, TProperty, TMethod>
  • genericTargets: null | {
        [name: string]: glassEasel.GeneralComponentDefinition;
    }
  • backendContext: null | GeneralBackendContext
  • Optional initPropValues: ((comp) => void)
    • • (comp): void

      • Parameters

        • comp: ComponentInstance<TData, TProperty, TMethod, Empty>

        Returns void

  Returns ComponentInstance<TData, TProperty, TMethod, Empty>

Static getDataProxy

• getDataProxy<TData, TProperty, TMethod>(comp): DataGroup<TData, TProperty, TMethod>

• Type Parameters

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

  Parameters

  • comp: glassEasel.Component<TData, TProperty, TMethod>

  Returns DataGroup<TData, TProperty, TMethod>

Static getInnerData

• getInnerData<TData, TProperty, TMethod>(comp): null | {
      [key: string]: DataValue;
  }

• Type Parameters

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

  Parameters

  • comp: glassEasel.Component<TData, TProperty, TMethod>

  Returns null | {
      [key: string]: DataValue;
  }

Static getMethod

• getMethod<TData, TProperty, TMethod>(comp, methodName): undefined | GeneralFuncType

• Get a method

  If useMethodCallerListeners option is set for this component, this method will use the corresponding fields in the methodCaller .

  Type Parameters

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

  Parameters

  • comp: glassEasel.Component<TData, TProperty, TMethod>
  • methodName: string

  Returns undefined | GeneralFuncType

Static getMethodsFromDef

• getMethodsFromDef<TData, TProperty, TMethod>(compDef): {
      [name: string]: GeneralFuncType;
  }

• List methods by the component definition (backward compatibility)

  Type Parameters

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

  Parameters

  • compDef: glassEasel.ComponentDefinition<TData, TProperty, TMethod>

  Returns {
      [name: string]: GeneralFuncType;
  }

  • [name: string]: GeneralFuncType