harmony 鸿蒙半模态转场

2023-06-24
浏览 (1058)

半模态转场

通过bindSheet属性为组件绑定半模态页面，在组件插入时可通过设置自定义或默认的内置高度确定半模态大小。

说明：

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

不支持横竖屏切换。

不支持路由跳转。

属性

名称	参数	参数描述
bindSheet	isShow: boolean, builder: CustomBuilder, options?: SheetOptions	给组件绑定半模态页面，点击后显示模态页面。 isShow: 是否显示半模态页面。从API version 10开始，该参数支持$$双向绑定变量 builder: 配置半模态页面内容。 options: 配置半模态页面的可选属性。

说明：

在非双向绑定情况下，以拖拽方式关闭半模态页面不会改变isShow参数的值。

为了使isShow参数值与半模态界面的状态同步，建议使用$$双向绑定isShow参数。

SheetOptions

名称	类型	必填	描述
height	SheetSize \| Length	否	半模态高度，默认是LARGE。
dragBar	boolean	否	是否显示控制条，默认显示。
backgroundColor	ResourceColor	否	半模态页面的背板颜色。
maskColor	ResourceColor	否	半模态页面的背景蒙层颜色。
onAppear	() => void	否	半模态页面显示回调函数。
onDisappear	() => void	否	半模态页面回退回调函数。

SheetSize

名称	参数描述
MEDIUM	指定半模态高度为屏幕高度一半。
LARGE	指定半模态高度几乎为屏幕高度。

示例

// xxx.ets
import display from '@ohos.display';
@Entry
@Component
struct SheetTransitionExample {
  @State isShow:boolean = false
  @State isShow2:boolean = false
  @State sheetHeight:number = 300;
  @State showDragBar:boolean = true;
  @State screenHeight:number = 0;

  aboutToAppear() {
    let displayClass: display.Display|null = null;

    try {
      displayClass = display.getDefaultDisplaySync();
      console.info(`[screen info]: ${JSON.stringify(displayClass)}`)
      this.screenHeight = displayClass.height; // 获取屏幕高度
    } catch (exception) {
      console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
    }
  }

  @Builder myBuilder() {
    Column() {
      Button("change height")
        .margin(10)
        .fontSize(20)
        .onClick(()=>{
          this.sheetHeight = 500;
        })

      Button("Set Illegal height")
        .margin(10)
        .fontSize(20)
        .onClick(()=>{
          this.sheetHeight = this.screenHeight;
        })

      Button("close dragBar")
        .margin(10)
        .fontSize(20)
        .onClick(()=>{
          this.showDragBar = false;
        })

      Button("close modal 1")
        .margin(10)
        .fontSize(20)
        .onClick(()=>{
          this.isShow = false;
        })
    }
    .width('100%')
    .height('100%')
  }

  build() {
    Column() {
      Button("transition modal 1")
        .onClick(() => {
          this.isShow = true
        })
        .fontSize(20)
        .margin(10)
        .bindSheet($$this.isShow, this.myBuilder(), {height: this.sheetHeight, dragBar: this.showDragBar, backgroundColor: Color.Green, onAppear: () => {console.log("BindSheet onAppear.")}, onDisappear: () => {console.log("BindSheet onDisappear.")}})
    }
    .justifyContent(FlexAlign.Center)
    .width('100%')
    .height('100%')
  }
}

zh-cn_sheet