文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
API参考应用框架ArkUI(方舟UI框架)ArkTS组件通用事件组件变化事件挂载卸载事件

挂载卸载事件

挂载卸载事件指组件从组件树上挂载、卸载时触发的事件。

说明

从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

onAttach12+

PhonePC/2in1TabletTVWearable

onAttach(callback: Callback<void>): T

组件挂载到组件树时触发此回调。由于以下说明中的限制,建议使用onAppear替代此接口。

说明
  • 回调在组件布局渲染前调用。

  • 不允许在回调中对组件树进行变更,例如启动动画或使用if-else变更组件树结构。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
callback Callback<void> onAttach事件的回调函数,表示组件已经挂载至组件树。

返回值:

展开
类型 说明
T 返回当前组件。

onDetach12+

PhonePC/2in1TabletTVWearable

onDetach(callback: Callback<void>): T

组件从组件树卸载时触发此回调。建议使用onDisAppear替代此接口。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
callback Callback<void> onDetach事件的回调函数,表示组件已经从组件树卸载。

返回值:

展开
类型 说明
T 返回当前组件。

onAppear

PhonePC/2in1TabletTVWearable

onAppear(event: () => void): T

组件挂载后触发此回调。

说明

回调的调用时机有可能发生在组件布局渲染后。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
event () => void onAppear事件的回调函数,表示组件已挂载显示。

返回值:

展开
类型 说明
T 返回当前组件。

onDisAppear

PhonePC/2in1TabletTVWearable

onDisAppear(event: () => void): T

组件从组件树卸载时触发此回调。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
event () => void onDisAppear事件的回调函数,表示组件已卸载消失。

返回值:

展开
类型 说明
T 返回当前组件。

示例

PhonePC/2in1TabletTVWearable

该示例通过按钮控制组件的挂载和卸载,触发onAttach和onDetach事件。

收起
自动换行
深色代码主题
复制
  1. // xxx.ets
  2. import { promptAction } from '@kit.ArkUI';
  3. @Entry
  4. @Component
  5. struct AppearExample {
  6. @State isShow: boolean = true;
  7. @State changeAppear: string = '点我卸载挂载组件';
  8. private myText: string = 'Text for onAppear';
  9. build() {
  10. Column() {
  11. Button(this.changeAppear)
  12. .onClick(() => {
  13. this.isShow = !this.isShow
  14. }).margin(15)
  15. if (this.isShow) {
  16. Text(this.myText).fontSize(26).fontWeight(FontWeight.Bold)
  17. .onAttach(() => {
  18. this.getUIContext().getPromptAction().showToast({
  19. message: 'The text is shown',
  20. duration: 2000,
  21. bottom: 500
  22. })
  23. })
  24. .onDetach(() => {
  25. this.getUIContext().getPromptAction().showToast({
  26. message: 'The text is hidden',
  27. duration: 2000,
  28. bottom: 500
  29. })
  30. })
  31. }
  32. }.padding(30).width('100%')
  33. }
  34. }

在 API参考 中进行搜索
请输入您想要搜索的关键词