Class ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>

A direct way to create a component

Type Parameters

TPrevData extends DataList = Empty
TData extends DataList = Empty
TProperty extends PropertyList = Empty
TMethod extends MethodList = Empty
TChainingFilter extends ChainingFilterType = never
TPendingChainingFilter extends ChainingFilterType = never
TComponentExport = never
TExtraThisFields extends DataList = Empty

Hierarchy

BaseBehaviorBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>
- ComponentBuilder

Index

Constructors

constructor

Methods

behavior data definition export externalClasses extraThisFieldsType implement init lifetime methods observer options pageDefinition pageLifetime property register relation staticData

Constructors

constructor

new ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>(): ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>
Type Parameters
- TPrevData extends DataList = Empty
- TData extends DataList = Empty
- TProperty extends PropertyList = Empty
- TMethod extends MethodList = Empty
- TChainingFilter extends ChainingFilterType = never
- TPendingChainingFilter extends ChainingFilterType = never
- TComponentExport = never
- TExtraThisFields extends DataList = Empty
Returns ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>
Inherited from BaseBehaviorBuilder< TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields >.constructor

Methods

behavior

behavior<UData, UProperty, UMethod, UChainingFilter, UComponentExport, UExtraThisFields>(behavior): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & UData, TProperty & UProperty, TMethod & UMethod, UChainingFilter, TPendingChainingFilter, UComponentExport, TExtraThisFields & UExtraThisFields>, UChainingFilter>
Use another behavior
Type Parameters
- UData extends DataList
- UProperty extends PropertyList
- UMethod extends MethodList
- UChainingFilter extends ChainingFilterType
- UComponentExport
- UExtraThisFields extends DataList
Parameters
- behavior: behavior.Behavior<UData, UProperty, UMethod, UChainingFilter, UComponentExport, UExtraThisFields>
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & UData, TProperty & UProperty, TMethod & UMethod, UChainingFilter, TPendingChainingFilter, UComponentExport, TExtraThisFields & UExtraThisFields>, UChainingFilter>
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:92

data

data<T>(gen): ResolveBehaviorBuilder<ComponentBuilder<T, TData & T, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add some template data fields

It does not support raw data, but a gen function which returns the new data fields. The gen function executes once during component instance creation.
Type Parameters
- T extends DataList
Parameters
- gen: (() => NewFieldList<AllData<TData, TProperty>, T>)
  - - (): NewFieldList<AllData<TData, TProperty>, T>
    - Returns NewFieldList<AllData<TData, TProperty>, T>
Returns ResolveBehaviorBuilder<ComponentBuilder<T, TData & T, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.data
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:161

definition

definition<TNewData, TNewProperty, TNewMethod, TNewComponentExport>(def): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & TNewData, TProperty & TNewProperty, TMethod & TNewMethod, TChainingFilter, TPendingChainingFilter, TNewComponentExport, TExtraThisFields>, TChainingFilter>
Apply a classic definition object
Type Parameters
- TNewData extends DataList = Empty
- TNewProperty extends PropertyList = Empty
- TNewMethod extends MethodList = Empty
- TNewComponentExport = never
Parameters
- def: {
  options?: ComponentDefinitionOptions;
  } & BehaviorDefinition<TNewData, TNewProperty, TNewMethod, TNewComponentExport> & ThisType<component.Component<TData & TNewData, TProperty & TNewProperty, TMethod & TNewMethod, TNewComponentExport, TExtraThisFields>>
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & TNewData, TProperty & TNewProperty, TMethod & TNewMethod, TChainingFilter, TPendingChainingFilter, TNewComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.definition
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:287

export

export<TNewComponentExport>(f): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TNewComponentExport, TExtraThisFields>, TChainingFilter>
Set the export value when the component is being selected
Type Parameters
- TNewComponentExport
Parameters
- f: ((this, source) => TNewComponentExport)
  - - (this, source): TNewComponentExport
    - Parameters
      this: component.GeneralComponent
      source: null | component.GeneralComponent
      Returns TNewComponentExport
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TNewComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.export
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:135

externalClasses

externalClasses(list): this
Add external classes
Parameters
- list: string[]
Returns this
Inherited from BaseBehaviorBuilder.externalClasses
- Defined in glass-easel-miniprogram-adapter/src/builder/base_behavior_builder.ts:61

extraThisFieldsType

extraThisFieldsType<T>(): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields & T>, TChainingFilter>
Add extra this fields type
Type Parameters
- T extends DataList
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields & T>, TChainingFilter>
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:408

implement

implement<TIn>(traitBehavior, impl): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Implement a trait behavior
Type Parameters
- TIn extends {
  [key: string]: any;
  }
Parameters
- traitBehavior: behavior.TraitBehavior<TIn, any>
- impl: TIn
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Inherited from BaseBehaviorBuilder.implement
- Defined in glass-easel-miniprogram-adapter/src/builder/base_behavior_builder.ts:52

init

init<TExport>(func): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod & (TExport extends void
    ? Empty
    : {
        [K in string | number | symbol]: UnTag<TExport[K], typeof METHOD_TAG, GetTagsWithout<TExport[K], typeof METHOD_TAG, GetTags<TExport[K]>>>
    }), TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Execute a function while component instance creation

A BuilderContext is provided to tweak the component creation progress. The return value is used as the "export" value of the behavior.
Type Parameters
- TExport extends void | Record<string, ((...args) => any) & {
  [TaggedSymbol]: [typeof METHOD_TAG];
  }>
Parameters
- func: ((this, builderContext) => TExport)
  - - (this, builderContext): TExport
    - Parameters
      this: component.Component<TData, TProperty, TMethod, TComponentExport, TExtraThisFields>
      builderContext: builder.BuilderContext<TPrevData, TProperty, component.Component<TData, TProperty, TMethod, TComponentExport, TExtraThisFields>>
      Returns TExport
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod & (TExport extends void
    ? Empty
    : {
        [K in string | number | symbol]: UnTag<TExport[K], typeof METHOD_TAG, GetTagsWithout<TExport[K], typeof METHOD_TAG, GetTags<TExport[K]>>>
    }), TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.init
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:255

lifetime

lifetime<L>(name, func, once?): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add a lifetime callback
Type Parameters
- L extends keyof Lifetimes
Parameters
- name: L
- func: ((this, ...args) => ReturnType<Lifetimes[L]>)
  - - (this, ...args): ReturnType<Lifetimes[L]>
    - Parameters
      this: component.Component<TData, TProperty, TMethod, any, TExtraThisFields>
      Rest ...args: Parameters<Lifetimes[L]>
      Returns ReturnType<Lifetimes[L]>
- once: boolean = false
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Inherited from BaseBehaviorBuilder.lifetime
- Defined in glass-easel-miniprogram-adapter/src/builder/base_behavior_builder.ts:217

methods

methods<T>(funcs): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod & T, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add some public methods

The public method can be used as an event handler, and can be visited in component instance.
Type Parameters
- T extends MethodList
Parameters
- funcs: T & ThisType<component.Component<TData, TProperty, TMethod & T, any, TExtraThisFields>>
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod & T, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.methods
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:231

observer

observer<P, V>(paths, func, once?): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add a data observer
Type Parameters
- P
- V = GetFromObserverPathString<DataWithPropertyValues<TPrevData, TProperty>, P>
Parameters
- paths: P
- func: ((this, newValue) => void)
  - - (this, newValue): void
    - Parameters
      this: component.Component<TData, TProperty, TMethod, any, TExtraThisFields>
      newValue: V
      Returns void
- Optional once: boolean
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Inherited from BaseBehaviorBuilder.observer
- Defined in glass-easel-miniprogram-adapter/src/builder/base_behavior_builder.ts:171
observer<P, V>(paths, func, once?): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Type Parameters
- P extends ObserverDataPathStrings<DataWithPropertyValues<TPrevData, TProperty>>[]
- V = {
  [K in string | number | symbol]: GetFromObserverPathString<DataWithPropertyValues<TPrevData, TProperty>, P[K<K>]>
  }
Parameters
- paths: readonly [P]
- func: ((this, ...newValues) => void)
  - - (this, ...newValues): void
    - Parameters
      this: component.Component<TData, TProperty, TMethod, any, TExtraThisFields>
      Rest ...newValues: V extends any[]
      ? V<V>
      : never
      Returns void
- Optional once: boolean
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Inherited from BaseBehaviorBuilder.observer
- Defined in glass-easel-miniprogram-adapter/src/builder/base_behavior_builder.ts:184

property

property<N, T, V>(name, def): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty & Record<N, unknown extends V
? T
: PropertyOption<T, V>>, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add a single property

The property name should be different from other properties.
Type Parameters
- N extends string
- T extends PropertyType
- V extends any
Parameters
- name: N
- def: N extends keyof TProperty | keyof TData
  ? never
  : PropertyListItem<T, V>
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty & Record<N, unknown extends V
? T
: PropertyOption<T, V>>, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.property
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:207

register

register(): ComponentType<TData, TProperty, TMethod, TComponentExport>
Finish the component definition process

Returns ComponentType<TData, TProperty, TMethod, TComponentExport>
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:379

relation

relation(name, rel): ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add a relation
Parameters
- name: string
- rel: RelationParams & ThisType<component.Component<TData, TProperty, TMethod, TComponentExport, TExtraThisFields>>
Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Inherited from BaseBehaviorBuilder.relation
- Defined in glass-easel-miniprogram-adapter/src/builder/base_behavior_builder.ts:247

staticData

staticData<T>(data): ResolveBehaviorBuilder<ComponentBuilder<T, TData & T, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Add some template data fields

The data should be JSON-compatible, and will be cloned during component creation.
Type Parameters
- T extends DataList
Parameters
- data: NewFieldList<AllData<TData, TProperty>, T>
Returns ResolveBehaviorBuilder<ComponentBuilder<T, TData & T, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>
Overrides BaseBehaviorBuilder.staticData
- Defined in glass-easel-miniprogram-adapter/src/builder/component_builder.ts:184

Class ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>

Methods

behavior

Type Parameters

Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & UData, TProperty & UProperty, TMethod & UMethod, UChainingFilter, TPendingChainingFilter, UComponentExport, TExtraThisFields & UExtraThisFields>, UChainingFilter>

data

Type Parameters

Parameters

Returns NewFieldList<AllData<TData, TProperty>, T>

Returns ResolveBehaviorBuilder<ComponentBuilder<T, TData & T, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

definition

Type Parameters

Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & TNewData, TProperty & TNewProperty, TMethod & TNewMethod, TChainingFilter, TPendingChainingFilter, TNewComponentExport, TExtraThisFields>, TChainingFilter>

export

Type Parameters

Parameters

Parameters

Returns TNewComponentExport

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TNewComponentExport, TExtraThisFields>, TChainingFilter>

externalClasses

Parameters

Returns this

extraThisFieldsType

Type Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields & T>, TChainingFilter>

implement

Type Parameters

Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

init

Type Parameters

Parameters

Parameters

Returns TExport

lifetime

Type Parameters

Parameters

Parameters

Returns ReturnType<Lifetimes[L]>

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

methods

Type Parameters

Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod & T, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

observer

Type Parameters

Parameters

Parameters

Returns void

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

Type Parameters

Parameters

Parameters

Returns void

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

options

Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

pageDefinition

Type Parameters

Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData & TNewData, TProperty, TMethod & TNewExtraFields, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

pageLifetime

Parameters

Parameters

Returns any

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>

property

Type Parameters

Returns ResolveBehaviorBuilder<ComponentBuilder<TPrevData, TData, TProperty & Record<N, unknown extends V
? T
: PropertyOption<T, V>>, TMethod, TChainingFilter, TPendingChainingFilter, TComponentExport, TExtraThisFields>, TChainingFilter>