Class CodeSpace

A component space with mini-program code manager

Index

Methods

addCompiledTemplate addComponentStaticConfig addStyleSheet behavior component componentEnv getCompiledTemplate getComponentSpace getComponentStaticConfig getStyleScopeName getStyleSheet globalComponentEnv importCodeSpace isMainSpace setOverallBehavior traitBehavior

Methods

addCompiledTemplate

addCompiledTemplate(path, content): void
Add a compiled template

The content is the execution result of the generated string of the template compiler. The path should not contain the .wxml suffix.
Parameters
- path: string
- content: ComponentTemplate
Returns void
- Defined in glass-easel-miniprogram-adapter/src/space.ts:195

addComponentStaticConfig

addComponentStaticConfig(path, content): void
Add a static JSON config

The path should not contain the .json suffix.
Parameters
- path: string
- content: ComponentStaticConfig
Returns void
- Defined in glass-easel-miniprogram-adapter/src/space.ts:214

addStyleSheet

addStyleSheet(path, styleSheetUrl?, styleScopeName?): void
Add a style sheet URL with style scope name

The URL should be recognized by the target backend. The path should not contain the .wxss suffix.
Parameters
- path: string
- Optional styleSheetUrl: string
- Optional styleScopeName: string
Returns void
- Defined in glass-easel-miniprogram-adapter/src/space.ts:171

behavior

behavior(): builder.BehaviorBuilder<Empty, Empty, Empty, Empty, never, never, never, Empty>
Build a behavior outside of a definition environment

The method do not need a definition environment, so the global object pollution is avoided.

Returns builder.BehaviorBuilder<Empty, Empty, Empty, Empty, never, never, never, Empty>
- Defined in glass-easel-miniprogram-adapter/src/space.ts:397

component

component(path): ComponentBuilder<Empty, Empty, Empty, Empty, never, never, never, Empty>
Build a component outside of a definition environment

The method do not need a definition environment, so the global object pollution is avoided. path should be the component path (without ".js" extension).
Parameters
- path: string
Returns ComponentBuilder<Empty, Empty, Empty, Empty, never, never, never, Empty>
- Defined in glass-easel-miniprogram-adapter/src/space.ts:388

componentEnv

componentEnv<T>(path, cb): T
Create a component definition environment

Like globalComponentEnv , but the global variables are given as callback arguments.
Type Parameters
- T
Parameters
- path: string
- cb: ((env) => T)
  - - (env): T
    - Parameters
      env: ComponentEnv
      Returns T
Returns T
- Defined in glass-easel-miniprogram-adapter/src/space.ts:316

getCompiledTemplate

getCompiledTemplate(path): undefined | ComponentTemplate
Get a compiled template

The content is the execution result of the generated string of the template compiler. The path should not contain the .wxml suffix.
Parameters
- path: string
Returns undefined | ComponentTemplate
- Defined in glass-easel-miniprogram-adapter/src/space.ts:205

getComponentSpace

getComponentSpace(): ComponentSpace
Get the underlying component space

Returns ComponentSpace
- Defined in glass-easel-miniprogram-adapter/src/space.ts:135

getComponentStaticConfig

getComponentStaticConfig(path): undefined | ComponentStaticConfig
Get a static JSON config

The path should not contain the .json suffix.
Parameters
- path: string
Returns undefined | ComponentStaticConfig
- Defined in glass-easel-miniprogram-adapter/src/space.ts:223

getStyleScopeName

getStyleScopeName(path): undefined | string
Parameters
- path: string
Returns undefined | string
- Defined in glass-easel-miniprogram-adapter/src/space.ts:185

getStyleSheet

getStyleSheet(path): undefined | string
Get a style sheet URL

The URL should be recognized by the target backend. The path should not contain the .wxss suffix.
Parameters
- path: string
Returns undefined | string
- Defined in glass-easel-miniprogram-adapter/src/space.ts:181

globalComponentEnv

globalComponentEnv<T>(globalObject, path, cb): T
Create a component definition environment

During the sync execution of cb , Component and Behavior global vars will be available. globalObject should be the JavaScript global object, a.k.a. window in DOM. Some global variables, a.k.a Component Behavior Page , will be written into globalObject . path should be the component path (without ".js" extension).
Type Parameters
- T
Parameters
- globalObject: any
- path: string
- cb: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in glass-easel-miniprogram-adapter/src/space.ts:291

importCodeSpace

importCodeSpace(id, domainAlias?, privateImport?): void
Import another component space as a plugin (must be in the same environment)

Components from the imported codeSpace can be used with URLs. If domainAlias is provided, the URL format is plugin://DOMAIN_ALIAS/COMPONENT_SPACE_EXPORT_ALIAS . If privateImport is enabled, another URL format is plugin-private://DOMAIN/COMPONENT_IS .
Parameters
- id: string
- Optional domainAlias: string
- privateImport: boolean = false
Returns void
- Defined in glass-easel-miniprogram-adapter/src/space.ts:156

isMainSpace

isMainSpace(): boolean
Returns boolean
- Defined in glass-easel-miniprogram-adapter/src/space.ts:128

setOverallBehavior

setOverallBehavior(behavior): void
Add a behavior for all components

Must be called before any component registration so that the component will use this behavior. Set to null to disable this behavior.
Parameters
- behavior: glassEasel.GeneralBehavior
Returns void
- Defined in glass-easel-miniprogram-adapter/src/space.ts:145

traitBehavior

traitBehavior<TIn>(): behavior.TraitBehavior<TIn, TIn>
Define a trait behavior
Type Parameters
- TIn extends {
  [key: string]: any;
  }
Returns behavior.TraitBehavior<TIn, TIn>
- Defined in glass-easel-miniprogram-adapter/src/space.ts:404
traitBehavior<TIn, TOut>(trans): behavior.TraitBehavior<TIn, TOut>
Type Parameters
- TIn extends {
  [key: string]: any;
  }
- TOut extends {
  [key: string]: any;
  }
Parameters
- trans: ((impl) => TOut)
  - - (impl): TOut
    - Parameters
      impl: TIn
      Returns TOut
Returns behavior.TraitBehavior<TIn, TOut>
- Defined in glass-easel-miniprogram-adapter/src/space.ts:405

Class CodeSpace

Index

Methods

Methods

addCompiledTemplate

Parameters

Returns void

addComponentStaticConfig

Parameters

Returns void

addStyleSheet

Parameters

Returns void

behavior

Returns builder.BehaviorBuilder<Empty, Empty, Empty, Empty, never, never, never, Empty>

component

Parameters

Returns ComponentBuilder<Empty, Empty, Empty, Empty, never, never, never, Empty>

componentEnv

Type Parameters

Parameters

Parameters

Returns T

Returns T

getCompiledTemplate

Parameters

Returns undefined | ComponentTemplate

getComponentSpace

Returns ComponentSpace

getComponentStaticConfig

Parameters

Returns undefined | ComponentStaticConfig

getStyleScopeName

Parameters

Returns undefined | string

getStyleSheet

Parameters

Returns undefined | string

globalComponentEnv

Type Parameters

Parameters

Returns T

Returns T

importCodeSpace

Parameters

Returns void

isMainSpace

Returns boolean

setOverallBehavior

Parameters

Returns void

traitBehavior

Type Parameters

Returns behavior.TraitBehavior<TIn, TIn>

Type Parameters

Parameters

Parameters

Returns TOut

Returns behavior.TraitBehavior<TIn, TOut>

Settings

Member Visibility

Theme

On This Page