ts-container-panel.md 4.7 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

可以包含子组件。

Y
yamila 已提交
14 15
>  **说明:**
>
H
HelloCrease 已提交
16
>  子组件类型:系统组件和自定义组件,支持渲染控制类型([if/else](../../quick-start/arkts-rendering-control-ifelse.md)、[ForEach](../../quick-start/arkts-rendering-control-foreach.md)和[LazyForEach](../../quick-start/arkts-rendering-control-lazyforeach.md))。
Y
yamila 已提交
17

Z
zengyawen 已提交
18 19 20

## 接口

L
fix doc  
luoying_ace_admin 已提交
21
Panel(show: boolean)
Z
zengyawen 已提交
22

T
third  
tianyu 已提交
23 24 25 26
**参数:**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
Y
yamila 已提交
27
| show | boolean | 是 | 控制Panel显示或隐藏。<br/>**说明:** <br/>如果设置为false时,则不占位隐藏。[Visible.None](ts-universal-attributes-visibility.md)或者show之间有一个生效时,都会生效不占位隐藏。 |
Z
zengyawen 已提交
28 29 30

## 属性

Y
yamila 已提交
31 32
除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:

T
third  
tianyu 已提交
33 34
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
S
sienna1128 已提交
35
| type | [PanelType](#paneltype枚举说明) | 设置可滑动面板的类型。<br/>默认值:PanelType.Foldable |
36
| mode | [PanelMode](#panelmode枚举说明) | 设置可滑动面板的初始状态。<br/>Minibar类型默认值:PanelMode.Mini;其余类型默认值:PanelMode.Half |
T
third  
tianyu 已提交
37
| dragBar | boolean | 设置是否存在dragbar,true表示存在,false表示不存在。<br/>默认值:true |
Y
yamila 已提交
38 39 40
| fullHeight | string&nbsp;\|&nbsp;number | 指定PanelMode.Full状态下的高度。<br/>默认值:当前组件主轴大小减去8vp空白区<br/>**说明:** <br/>不支持设置百分比。 |
| halfHeight | string&nbsp;\|&nbsp;number | 指定PanelMode.Half状态下的高度。<br/>默认值:当前组件主轴大小的一半。<br/>**说明:** <br/>不支持设置百分比。 |
| miniHeight | string&nbsp;\|&nbsp;number | 指定PanelMode.Mini状态下的高度。<br/>默认值:48<br/>单位:vp<br/>**说明:** <br/>不支持设置百分比。 |
T
third  
tianyu 已提交
41
| show | boolean | 当滑动面板弹出时调用。 |
L
luoying_ace_admin 已提交
42
| backgroundMask<sup>9+</sup>|[ResourceColor](ts-types.md#resourcecolor)|指定Panel的背景蒙层。|
T
third  
tianyu 已提交
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

## PanelType枚举说明

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

## PanelMode枚举说明

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

## 事件

Y
yamila 已提交
62 63
除支持[通用事件](ts-universal-events-click.md)外,还支持以下事件:

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

## 示例
Z
zengyawen 已提交
70

H
geshi  
HelloCrease 已提交
71 72
```ts
// xxx.ets
Z
zengyawen 已提交
73 74 75 76 77 78
@Entry
@Component
struct PanelExample {
  @State show: boolean = false

  build() {
Z
zhouchaobo 已提交
79
    Column() {
Z
zengyawen 已提交
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
      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 已提交
96 97
      .onChange((width: number, height: number, mode: PanelMode) => {
        console.info(`width:${width},height:${height},mode:${mode}`)
Z
zengyawen 已提交
98 99 100 101 102 103
      })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })
  }
}
```

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