Skip to content

wevu / index / MiniProgramComponentOptions

接口: MiniProgramComponentOptions

定义于: packages/wevu/src/runtime/types.ts:166

继承于

属性

attached()?

optional attached: () => void

定义于: packages/wevu/src/runtime/types.ts:233

返回

void

已被弃用

旧式的定义方式,基础库 2.2.3 起请在 lifetimes 中定义

在组件实例进入页面节点树时执行

最低基础库版本:1.6.3


behaviors?

optional behaviors: MiniProgramBehaviorIdentifier[]

定义于: packages/wevu/src/runtime/types.ts:170

类似于 mixins/traits 的组件间代码复用机制(behaviors)。


created()?

optional created: () => void

定义于: packages/wevu/src/runtime/types.ts:232

旧式生命周期(基础库 2.2.3 起推荐使用 lifetimes 字段)。 保留以增强类型提示与兼容性。

返回

void

已被弃用

旧式的定义方式,基础库 2.2.3 起请在 lifetimes 中定义

在组件实例刚刚被创建时执行

最低基础库版本:1.6.3


definitionFilter?

optional definitionFilter: DefinitionFilter

定义于: packages/wevu/src/runtime/types.ts:209

定义段过滤器,用于自定义组件扩展。


detached()?

optional detached: () => void

定义于: packages/wevu/src/runtime/types.ts:236

返回

void

已被弃用

旧式的定义方式,基础库 2.2.3 起请在 lifetimes 中定义

在组件实例被从页面节点树移除时执行

最低基础库版本:1.6.3


error()?

optional error: (err) => void

定义于: packages/wevu/src/runtime/types.ts:237

参数

err

Error

返回

void

已被弃用

旧式的定义方式,基础库 2.2.3 起请在 lifetimes 中定义

每当组件方法抛出错误时执行

最低基础库版本:2.4.1


export()?

optional export: () => IAnyObject

定义于: packages/wevu/src/runtime/types.ts:218

组件自定义导出:当使用 behavior: wx://component-export 时, 可用于指定组件被 selectComponent 调用时的返回值。

wevu 默认会将 setup() 中通过 expose() 写入的内容作为 export() 返回值, 因此大多数情况下无需手动编写 export();若同时提供 export(),则会与 expose() 结果浅合并。

返回

IAnyObject


externalClasses?

optional externalClasses: string[]

定义于: packages/wevu/src/runtime/types.ts:175

组件接受的外部样式类。


lifetimes?

optional lifetimes: Partial<{ attached: void; created: void; detached: void; error: void; moved: void; ready: void; }>

定义于: packages/wevu/src/runtime/types.ts:194

组件生命周期声明对象: created/attached/ready/moved/detached/error

注意:wevu 会在 attached/ready/detached/moved/error 阶段做桥接与包装, 但 created 发生在 setup() 之前。


moved()?

optional moved: () => void

定义于: packages/wevu/src/runtime/types.ts:235

返回

void

已被弃用

旧式的定义方式,基础库 2.2.3 起请在 lifetimes 中定义

在组件实例被移动到节点树另一个位置时执行

最低基础库版本:1.6.3


observers?

optional observers: Record<string, (...args) => any>

定义于: packages/wevu/src/runtime/types.ts:185

组件数据字段监听器,用于监听 properties 和 data 的变化。


options?

optional options: ComponentOptions

定义于: packages/wevu/src/runtime/types.ts:204

组件选项(multipleSlots/styleIsolation/pureDataPattern/virtualHost 等)。


pageLifetimes?

optional pageLifetimes: Partial<PageLifetimes>

定义于: packages/wevu/src/runtime/types.ts:199

组件所在页面的生命周期声明对象:show/hide/resize/routeDone


properties?

optional properties: IAnyObject

定义于: packages/wevu/src/runtime/types.ts:226

原生 properties(与 wevu 的 props 不同)。

  • 推荐:使用 wevu 的 props 选项,让运行时规范化为小程序 properties
  • 兼容:也可以直接传入小程序 properties

ready()?

optional ready: () => void

定义于: packages/wevu/src/runtime/types.ts:234

返回

void

已被弃用

旧式的定义方式,基础库 2.2.3 起请在 lifetimes 中定义

在组件在视图层布局完成后执行

最低基础库版本:1.6.3


relations?

optional relations: object

定义于: packages/wevu/src/runtime/types.ts:180

组件间关系定义。

索引签名

[componentName: string]: RelationOption

Released under the MIT License.