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**
Z
zengyawen 已提交
5
> This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
Z
zengyawen 已提交
6

Z
zengyawen 已提交
7 8 9 10 11

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


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

None

Z
zengyawen 已提交
15 16

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

This component can contain child components.

Z
zengyawen 已提交
20 21 22 23 24 25

## APIs

Panel(value:{show:boolean})

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


## Attributes

E
esterzhou 已提交
33
  | Name | Type | Default Value | Description | 
Z
zengyawen 已提交
34
| -------- | -------- | -------- | -------- |
E
esterzhou 已提交
35 36 37 38 39 40
| 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 已提交
41 42 43 44

- PanelType enums
    | Name | Description | 
  | -------- | -------- |
E
esterzhou 已提交
45 46 47
  | 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 已提交
48 49 50 51

- PanelMode enums
    | Name | Description | 
  | -------- | -------- |
E
esterzhou 已提交
52 53 54
  | 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 已提交
55 56 57 58 59 60


## Events

  | Name | Description | 
| -------- | -------- |
E
esterzhou 已提交
61
| 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 dragbar height plus the height of the content area. | 
Z
zengyawen 已提交
62 63 64 65


## Example

Z
zengyawen 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

```
@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)
      .dragBar(true) // The dragbar is enabled by default.
      .halfHeight(500) // Half of the height by default
      .onChange((value: any) => {
        console.info(`width:${value.width},height:${value.height},mode:${value.mode}`)
      })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })
  }
}
```

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