瑞星 发表于 2025-3-26 04:22:07

鸿蒙5.0进阶开辟:UI开辟-不依靠UI组件的全局自界说弹出框 (openCustomDialog)(保举)

 往期鸿蒙全套实战文章必看:(文中附带鸿蒙全栈学习资料)



[*] 鸿蒙开辟核心知识点,看这篇文章就够了
[*] 最新版!鸿蒙HarmonyOS Next应用开辟实战学习门路
[*] 鸿蒙HarmonyOS NEXT开辟技能最全学习门路指南
[*] 鸿蒙应用开辟实战项目,看这一篇文章就够了(部分项目附源码)
不依靠UI组件的全局自界说弹出框 (openCustomDialog)(保举)

由于CustomDialogController在使用上存在诸多限定,不支持动态创建也不支持动态刷新,在相对较复杂的应用场景中保举使用UIContext中获取到的PromptAction对象提供的openCustomDialog接口来实现自界说弹出框。
   阐明
弹出框(openCustomDialog)存在两种入参方式创建自界说弹出框:


[*]openCustomDialog(传参为ComponentContent形式):通过ComponentContent封装内容可以与UI界面解耦,调用更加灵活,可以满足开辟者的封装诉求。拥有更强的灵活性,弹出框样式是完全自界说的,且在弹出框打开之后可以使用updateCustomDialog方法动态更新弹出框的一些参数。
[*]openCustomDialog(传builder的形式):相对于ComponentContent,builder必须要与上下文做绑定,与UI存在一定耦合。此方法有效默认的弹出框样式,适合于开辟者想要实现与体系弹窗默认风格一致的结果。
本文先容通过入参形式为ComponentContent创建自界说弹出框,传builder形式的弹出框使用方法可参考openCustomDialog。
弹出框(openCustomDialog)可以通过配置isModal来实现模态和非模态弹窗。isModal为true时,弹出框为模态弹窗。isModal为false时,弹出框为非模态弹窗。
生命周期

弹出框提供了生命周期函数用于关照用户该弹出框的生命周期。生命周期的触发时序依次为:onWillAppear -> onDidAppear -> onWillDisappear -> onDidDisappear。
名称类型阐明onDidAppear() => void弹出框弹出时的事件回调。onDidDisappear() => void弹出框消失时的事件回调。onWillAppear() => void弹出框显示动效前的事件回调。onWillDisappear() => void弹出框退出动效前的事件回调。 自界说弹出框的打开与关闭


[*] 创建ComponentContent。
ComponentContent用于界说自界说弹出框的内容。此中,wrapBuilder(buildText)封装自界说组件,new Params(this.message)是自界说组件的入参,可以缺省,也可以传入基础数据类型。
private contentNode: ComponentContent<Object> = new ComponentContent(this.ctx, wrapBuilder(buildText), new Params(this.message));
[*] 打开自界说弹出框。
通过调用openCustomDialog接口打开的弹出框默以为customStyle为true的弹出框,即弹出框的内容样式完全按照contentNode自界说样式显示。
this.ctx.getPromptAction().openCustomDialog(this.contentNode, this.options)
.then(() => {
    console.info('OpenCustomDialog complete.')
})
.catch((error: BusinessError) => {
    let message = (error as BusinessError).message;
    let code = (error as BusinessError).code;
    console.error(`OpenCustomDialog args error code is ${code}, message is ${message}`);
})
[*] 关闭自界说弹出框。
由于closeCustomDialog接口必要传入待关闭弹出框对应的ComponentContent。因此,如果必要在弹出框中设置关闭方法,则可参考完备示例封装静态方法来实现。
关闭弹出框之后若必要释放对应的ComponentContent,则必要调用ComponentContent的dispose方法。
this.ctx.getPromptAction().closeCustomDialog(this.contentNode)
.then(() => {
    console.info('CloseCustomDialog complete.')
})
.catch((error: BusinessError) => {
    let message = (error as BusinessError).message;
    let code = (error as BusinessError).code;
    console.error(`CloseCustomDialog args error code is ${code}, message is ${message}`);
})
更新自界说弹出框的内容

ComponentContent与BuilderNode有相同的使用限定,不支持自界说组件使用@Reusable、@Link、@Provide、@Consume等装饰器,来同步弹出框弹出的页面与ComponentContent中自界说组件的状态。因此,若必要更新弹出框中自界说组件的内容可以通过ComponentContent提供的update方法来实现。
this.contentNode.update(new Params('update')) 更新自界说弹出框的属性

通过updateCustomDialog可以动态更新弹出框的属性。目前支持的属性包括alignment、offset、autoCancel、maskColor。
必要注意的是,更新属性时,未设置的属性会规复为默认值。例如,初始设置{ alignment: DialogAlignment.Top, offset: { dx: 0, dy: 50 } },更新时设置{ alignment: DialogAlignment.Bottom },则初始设置的offset: { dx: 0, dy: 50 }不会保存,会规复为默认值。
this.ctx.getPromptAction().updateCustomDialog(this.contentNode, options)
.then(() => {
    console.info('UpdateCustomDialog complete.')
})
.catch((error: BusinessError) => {
    let message = (error as BusinessError).message;
    let code = (error as BusinessError).code;
    console.error(`UpdateCustomDialog args error code is ${code}, message is ${message}`);
}) 完备示例

// PromptActionClass.ts
import { BusinessError } from '@kit.BasicServicesKit';
import { ComponentContent, window } from '@kit.ArkUI';
import { UIContext } from '@ohos.arkui.UIContext';

export class PromptActionClass {
static ctx: UIContext;
static contentNode: ComponentContent<Object>;
static options: Object;

static setContext(context: UIContext) {
    this.ctx = context;
}

static setContentNode(node: ComponentContent<Object>) {
    this.contentNode = node;
}

static setOptions(options: Object) {
    this.options = options;
}

static openDialog() {
    if (this.contentNode !== null) {
      this.ctx.getPromptAction().openCustomDialog(this.contentNode, this.options)
      .then(() => {
          console.info('OpenCustomDialog complete.')
      })
      .catch((error: BusinessError) => {
          let message = (error as BusinessError).message;
          let code = (error as BusinessError).code;
          console.error(`OpenCustomDialog args error code is ${code}, message is ${message}`);
      })
    }
}

static closeDialog() {
    if (this.contentNode !== null) {
      this.ctx.getPromptAction().closeCustomDialog(this.contentNode)
      .then(() => {
          console.info('CloseCustomDialog complete.')
      })
      .catch((error: BusinessError) => {
          let message = (error as BusinessError).message;
          let code = (error as BusinessError).code;
          console.error(`CloseCustomDialog args error code is ${code}, message is ${message}`);
      })
    }
}

static updateDialog(options: Object) {
    if (this.contentNode !== null) {
      this.ctx.getPromptAction().updateCustomDialog(this.contentNode, options)
      .then(() => {
          console.info('UpdateCustomDialog complete.')
      })
      .catch((error: BusinessError) => {
          let message = (error as BusinessError).message;
          let code = (error as BusinessError).code;
          console.error(`UpdateCustomDialog args error code is ${code}, message is ${message}`);
      })
    }
}
} // Index.ets
import { ComponentContent } from '@kit.ArkUI';
import { PromptActionClass } from './PromptActionClass';

class Params {
text: string = ""

constructor(text: string) {
    this.text = text;
}
}

@Builder
function buildText(params: Params) {
Column() {
    Text(params.text)
      .fontSize(50)
      .fontWeight(FontWeight.Bold)
      .margin({ bottom: 36 })
    Button('Close')
      .onClick(() => {
      PromptActionClass.closeDialog()
      })
}.backgroundColor('#FFF0F0F0')
}

@Entry
@Component
struct Index {
@State message: string = "hello"
private ctx: UIContext = this.getUIContext();
private contentNode: ComponentContent<Object> =
    new ComponentContent(this.ctx, wrapBuilder(buildText), new Params(this.message));

aboutToAppear(): void {
    PromptActionClass.setContext(this.ctx);
    PromptActionClass.setContentNode(this.contentNode);
    PromptActionClass.setOptions({ alignment: DialogAlignment.Top, offset: { dx: 0, dy: 50 } });
}

build() {
    Row() {
      Column() {
      Button("open dialog and update options")
          .margin({ top: 50 })
          .onClick(() => {
            PromptActionClass.openDialog()

            setTimeout(() => {
            PromptActionClass.updateDialog({
                alignment: DialogAlignment.Bottom,
                offset: { dx: 0, dy: -50 }
            })
            }, 1500)
          })
      Button("open dialog and update content")
          .margin({ top: 50 })
          .onClick(() => {
            PromptActionClass.openDialog()

            setTimeout(() => {
            this.contentNode.update(new Params('update'))
            }, 1500)
          })
      }
      .width('100%')
      .height('100%')
    }
    .height('100%')
}
} https://i-blog.csdnimg.cn/direct/cab88284c800447a9022f86a44aefdd1.png

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
页: [1]
查看完整版本: 鸿蒙5.0进阶开辟:UI开辟-不依靠UI组件的全局自界说弹出框 (openCustomDialog)(保举)