ts-container-panel.md 3.6 KB
Newer Older
Z
zengyawen 已提交
1 2
# Panel

X
xiexiyun 已提交
3
可滑动面板,提供一种轻量的内容展示窗口,方便在不同尺寸中切换。
Z
zengyawen 已提交
4

T
third  
tianyu 已提交
5 6 7
>  **说明:**
>
>  该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
Z
zengyawen 已提交
8

Z
zengyawen 已提交
9 10

## 子组件
Z
zengyawen 已提交
11 12 13

可以包含子组件。

Z
zengyawen 已提交
14 15 16

## 接口

T
third  
tianyu 已提交
17
Panel(show:boolean)
Z
zengyawen 已提交
18

T
third  
tianyu 已提交
19 20 21 22 23
**参数:**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| show | boolean | 是 | 控制Panel显示或隐藏。 |
Z
zengyawen 已提交
24 25 26 27


## 属性

T
third  
tianyu 已提交
28 29 30 31 32 33 34 35 36
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| type | PanelType | 设置可滑动面板的类型。<br/>默认值:PanelType.Foldable |
| mode | PanelMode | 设置可滑动面板的初始状态。 |
| dragBar | boolean | 设置是否存在dragbar,true表示存在,false表示不存在。<br/>默认值:true |
| fullHeight | string&nbsp;\|&nbsp;number | 指定PanelMode.Full状态下的高度。 |
| halfHeight | string&nbsp;\|&nbsp;number | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 |
| miniHeight | string&nbsp;\|&nbsp;number | 指定PanelMode.Mini状态下的高度。 |
| show | boolean | 当滑动面板弹出时调用。 |
H
HelloCrease 已提交
37
| backgroundMask<sup>9+</sup>|[ResourceColor](ts-types.md#resourcecolor8)|指定Panel的背景蒙层。|
T
third  
tianyu 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

## PanelType枚举说明

| 名称 | 描述 |
| -------- | -------- |
| Minibar | 提供minibar和类全屏展示切换效果。 |
| Foldable | 内容永久展示类,提供大(类全屏)、中(类半屏)、小三种尺寸展示切换效果。 |
| Temporary | 内容临时展示区,提供大(类全屏)、中(类半屏)两种尺寸展示切换效果。 |

## PanelMode枚举说明

| 名称 | 描述 |
| -------- | -------- |
| Mini | 类型为minibar和foldable时,为最小状态;类型为temporary,则不生效。 |
| Half | 类型为foldable和temporary时,为类半屏状态;类型为minibar,则不生效。 |
| Full | 类全屏状态。 |
Z
zengyawen 已提交
54 55 56 57


## 事件

T
third  
tianyu 已提交
58
| 名称 | 功能描述 |
59
| -------- | -------- |
T
third  
tianyu 已提交
60 61
| onChange(event:&nbsp;(width:&nbsp;number,&nbsp;height:&nbsp;number,&nbsp;mode:&nbsp;PanelMode)&nbsp;=&gt;&nbsp;void) | 当可滑动面板发生状态变化时触发,&nbsp;返回的height值为内容区高度值,当dragbar属性为true时,panel本身的高度值为dragbar高度加上内容区高度。 |
| onHeightChange(callback: (value: number) => void)<sup>9+</sup> |当可滑动面板发生高度变化时触发,返回的height值为内容区高度值,当dragbar属性为true时,panel本身的高度值为dragbar高度加上内容区高度。因用户体验设计原因,panel最高只能滑到 fullHeight-8vp。 |
Z
zengyawen 已提交
62 63

## 示例
Z
zengyawen 已提交
64

H
geshi  
HelloCrease 已提交
65 66
```ts
// xxx.ets
Z
zengyawen 已提交
67 68 69 70 71 72
@Entry
@Component
struct PanelExample {
  @State show: boolean = false

  build() {
X
xiexiyun 已提交
73
    Stack() {
Z
zengyawen 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
      Text('2021-09-30    Today Calendar: 1.afternoon......Click for details')
        .width('90%').height(50).borderRadius(10)
        .backgroundColor(0xFFFFFF).padding({ left: 20 })
        .onClick(() => {
          this.show = !this.show
        })
      Panel(this.show) { // 展示日程
        Column() {
          Text('Today Calendar')
          Divider()
          Text('1. afternoon 4:00 The project meeting')
        }
      }
      .type(PanelType.Foldable).mode(PanelMode.Half)
      .dragBar(true) // 默认开启
      .halfHeight(500) // 默认一半
X
xiexiyun 已提交
90 91
      .onChange((width: number, height: number, mode: PanelMode) => {
        console.info(`width:${width},height:${height},mode:${mode}`)
Z
zengyawen 已提交
92 93 94 95 96 97
      })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })
  }
}
```

Z
zengyawen 已提交
98
![zh-cn_image_0000001174422896](figures/zh-cn_image_0000001174422896.gif)