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

Z
zengyawen 已提交
3

E
esterzhou 已提交
4
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
E
ester.zhou 已提交
5
>
Z
zengyawen 已提交
6
> This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
Z
zengyawen 已提交
7

Z
zengyawen 已提交
8 9 10 11 12

The **<Panel>** component is a slidable panel that presents lightweight content with flexible sizes. It is a pop-up component.


## Required Permissions
Z
zengyawen 已提交
13 14 15

None

Z
zengyawen 已提交
16 17

## Child Components
Z
zengyawen 已提交
18 19 20

This component can contain child components.

Z
zengyawen 已提交
21 22 23 24 25

## APIs

Panel(value:{show:boolean})

E
ester.zhou 已提交
26 27
- Parameters
    | Name | Type | Mandatory | Default Value | Description |
Z
zengyawen 已提交
28
  | -------- | -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
29
  | show | boolean | Yes | - | Whether the panel is shown or hidden. |
Z
zengyawen 已提交
30 31 32 33


## Attributes

E
ester.zhou 已提交
34
| Name | Type | Default Value | Description |
Z
zengyawen 已提交
35
| -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
36 37 38 39 40 41
| type | PanelType | PanelType.Foldable | Type of the panel. |
| mode | PanelMode | - | Initial status of the panel. |
| dragBar | boolean | true | Whether to enable a drag bar. The value **true** means that the drag bar will be displayed, and **false** means the opposite. |
| fullHeight | Length | - | Panel height in the **PanelMode.Full** mode. |
| halfHeight | Length | - | Panel height in the **PanelMode.Half** mode. The default value is half of the screen height. |
| miniHeight | Length | - | Panel height in the **PanelMode.Mini** mode. |
Z
zengyawen 已提交
42 43

- PanelType enums
E
ester.zhou 已提交
44
    | Name | Description |
Z
zengyawen 已提交
45
  | -------- | -------- |
E
ester.zhou 已提交
46 47 48
  | Minibar | A minibar panel displays content in the minibar area or a large (fullscreen-like) area. |
  | Foldable | A foldable panel displays permanent content in a large (fullscreen-like), medium-sized (halfscreen-like), or small area. |
  | Temporary | A temporary panel displays content in a large (fullscreen-like) or medium-sized (halfscreen-like) area. |
Z
zengyawen 已提交
49 50

- PanelMode enums
E
ester.zhou 已提交
51
    | Name | Description |
Z
zengyawen 已提交
52
  | -------- | -------- |
E
ester.zhou 已提交
53 54 55
  | Mini | Displays a **minibar** or **foldable** panel in its minimum size. This attribute does not take effect for **temporary** panels. |
  | Half | Displays a **foldable** or **temporary** panel in a medium-sized (halfscreen-like) area. This attribute does not take effect for **minibar** panels. |
  | Full | Displays a panel in a large (fullscreen-like) area. |
Z
zengyawen 已提交
56 57 58 59


## Events

E
ester.zhou 已提交
60
| Name | Description |
Z
zengyawen 已提交
61
| -------- | -------- |
62
| onChange(callback: (width: number, height: number, mode: PanelMode) => void) | Triggered when the status of the panel changes. The returned height value is the height of the content area. When the value of **dragbar** is **true**, the height of the panel is the drag bar height plus the height of the content area. |
Z
zengyawen 已提交
63 64 65 66


## Example

Z
zengyawen 已提交
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

```
@Entry
@Component
struct PanelExample {
  @State show: boolean = false

  build() {
    Column() {
      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) { // Display the agenda.
        Column() {
          Text('Today Calendar')
          Divider()
          Text('1. afternoon 4:00 The project meeting')
        }
      }
      .type(PanelType.Foldable).mode(PanelMode.Half)
90 91
      .dragBar(true) // The drag bar is enabled by default.
      .halfHeight(500) // The default value is half of the screen height.
E
ester.zhou 已提交
92 93
      .onChange((width: number, height: number, mode: PanelMode) => {
        console.info(`width:${width},height:${height},mode:${mode}`)
Z
zengyawen 已提交
94 95 96 97 98 99
      })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })
  }
}
```

Z
zengyawen 已提交
100
![en-us_image_0000001256978381](figures/en-us_image_0000001256978381.gif)