FolderStack

The <FolderStack> component extends the <Stack> component by adding the hover feature for foldable devices. With the upperItems parameter set, it can automatically avoid the crease region of the foldable device and move the content to the upper half screen.

NOTE

This component is supported since API version 11. Updates will be marked with a superscript to indicate their earliest API version.

Child Components

Multiple child components are supported.

APIs

FolderStack(value?: { upperItems?: Array<string>})

Since API version 11, this API is supported in ArkTS widgets.

Parameters

Name	Type	Mandatory	Description
upperItems	Array<string>	No	IDs of the child components that will be moved to the upper half screen in the hover state. Other components are stacked in the lower half screen.

Attributes

In addition to the universal attributes, the following attributes are supported.

Name	Type	Description
alignContent	Alignment	Alignment of child components in the container. Default value: Alignment.Center NOTE When both this attribute and the universal attribute align are set, whichever is set last takes effect.
enableAnimation	boolean	Whether to enable the default animation. Default value: true
autoHalfFold	boolean	Whether to enable auto rotation. This attribute is effective only when auto rotation is disabled in device system settings. Default value: true

NOTE

Setting the offset and margin attributes may cause the upper and lower half screens to block the crease region. Therefore, avoid setting these attributes with this component.

Events

In addition to the universal events, the following events are supported.

Name	Description
onFolderStateChange (callback: (event: { foldStatus: FoldStatus }) => void)	Called when the folding state changes. This API takes effect only in landscape mode. - foldStatus: folding status of the device.

Example

@Entry
@Component
struct Index {
  @State len_wid: number = 480
  @State w: string = "40%"
  build() {
    Column() {
      // Set upperItems to IDs of the child components to be moved to the upper half screen in the hover state. Other components are stacked in the lower half screen.
      FolderStack({ upperItems: ["upperitemsId"] }) {
        // This column is automatically moved up to the upper half screen.
        Column() {
          Text("vedio zone").height("100%").width("100%").textAlign(TextAlign.Center).fontSize(25)
        }.backgroundColor(Color.Pink).width("100%").height("100%").id("upperitemsId")

        // The following two columns are stacked in the lower half screen.
        Column() {
          Text("vedio title")
            .width("100%")
            .height(50)
            .textAlign(TextAlign.Center)
            .backgroundColor(Color.Red)
            .fontSize(25)
        }.width("100%").height("100%").justifyContent(FlexAlign.Start)

        Column() {
          Text("vedie bar ")
            .width("100%")
            .height(50)
            .textAlign(TextAlign.Center)
            .backgroundColor(Color.Red)
            .fontSize(25)
        }.width("100%").height("100%").justifyContent(FlexAlign.End)
      }
      .backgroundColor(Color.Yellow)
      // Set whether to enable animation.
      .enableAnimation(true)
      // Set whether to enable auto-rotate.
      .autoHalfFold(true)
      // Called when the folding status changes.
      .onFolderStateChange((msg) => {
        if (msg.foldStatus === FoldStatus.FOLD_STATUS_EXPANDED) {
          console.info("The device is currently in the expanded state")
        } else if (msg.foldStatus === FoldStatus.FOLD_STATUS_HALF_FOLDED) {
          console.info("The device is currently in the half folded state")
        } else {
          // .............
        }
      })
      // If the <folderStack> component does not occupy the full screen, it is used as a common stack.
      .alignContent(Alignment.Bottom)
      .height("100%")
      .width("100%")
      .borderWidth(1)
      .backgroundColor(Color.Yellow)

    }
    .height("100%")
    .width("100%")
    .borderWidth(1)
    .backgroundColor(Color.Pink)
    .expandSafeArea([SafeAreaType.SYSTEM], [SafeAreaEdge.BOTTOM])

  }
}