2020-08-13 15:18:26 +08:00
## Popover
### Basic usage
Similar to Tooltip, Popover is also built with `Vue-popper` . So for some duplicated attributes, please refer to the documentation of Tooltip.
2020-11-29 18:50:46 +08:00
:::demo The `trigger` attribute is used to define how popover is triggered: `hover` , `click` , `focus` or `manual` . As for the triggering element, you can write it in two different ways: use the `#reference` named slot, or use the `v-popover` directive and set it to Popover's `ref` .
2020-08-13 15:18:26 +08:00
```html
< template >
< el-popover
placement="top-start"
title="Title"
2020-11-04 15:01:37 +08:00
:width="200"
2020-08-13 15:18:26 +08:00
trigger="hover"
2020-11-04 15:01:37 +08:00
content="this is content, this is content, this is content"
>
< template #reference >
2020-10-19 13:44:50 +08:00
< el-button > Hover to activate< / el-button >
< / template >
2020-08-13 15:18:26 +08:00
< / el-popover >
< el-popover
placement="bottom"
title="Title"
2020-11-04 15:01:37 +08:00
:width="200"
2020-08-13 15:18:26 +08:00
trigger="click"
2020-11-04 15:01:37 +08:00
content="this is content, this is content, this is content"
>
2020-10-19 13:44:50 +08:00
< template #reference >
< el-button > Click to activate< / el-button >
< / template >
2020-08-13 15:18:26 +08:00
< / el-popover >
< el-popover
ref="popover"
placement="right"
title="Title"
2020-11-04 15:01:37 +08:00
:width="200"
2020-08-13 15:18:26 +08:00
trigger="focus"
2020-11-04 15:01:37 +08:00
content="this is content, this is content, this is content"
>
< template #reference >
< el-button > Focus to activate< / el-button >
< / template >
2020-08-13 15:18:26 +08:00
< / el-popover >
< el-popover
placement="bottom"
title="Title"
2020-11-04 15:01:37 +08:00
:width="200"
2020-08-13 15:18:26 +08:00
trigger="manual"
content="this is content, this is content, this is content"
2020-11-04 15:01:37 +08:00
v-model:visible="visible"
>
2020-10-19 13:44:50 +08:00
< template #reference >
< el-button @click =" visible = !visible" > Manual to activate</ el-button >
< / template >
2020-08-13 15:18:26 +08:00
< / el-popover >
< / template >
< script >
export default {
data() {
return {
2021-09-04 19:29:28 +08:00
visible: false,
}
},
}
2020-08-13 15:18:26 +08:00
< / script >
2021-06-25 16:09:42 +08:00
<!--
< setup >
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
return {
visible: ref(false),
};
},
});
< / setup >
-->
2020-08-13 15:18:26 +08:00
```
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
### Nested information
Other components can be nested in popover. Following is an example of nested table.
:::demo replace the `content` attribute with a default `slot` .
```html
2021-09-04 19:29:28 +08:00
< el-popover placement = "right" :width = "400" trigger = "click" >
2020-10-19 13:44:50 +08:00
< template #reference >
< el-button > Click to activate< / el-button >
< / template >
2020-11-04 15:01:37 +08:00
< el-table :data = "gridData" >
< el-table-column width = "150" property = "date" label = "date" > < / el-table-column >
< el-table-column width = "100" property = "name" label = "name" > < / el-table-column >
2021-09-04 19:29:28 +08:00
< el-table-column
width="300"
property="address"
label="address"
>< / el-table-column >
2020-11-04 15:01:37 +08:00
< / el-table >
2020-08-13 15:18:26 +08:00
< / el-popover >
< script >
export default {
data() {
return {
2021-09-04 19:29:28 +08:00
gridData: [
{
date: '2016-05-02',
name: 'Jack',
address: 'New York City',
},
{
date: '2016-05-04',
name: 'Jack',
address: 'New York City',
},
{
date: '2016-05-01',
name: 'Jack',
address: 'New York City',
},
{
date: '2016-05-03',
name: 'Jack',
address: 'New York City',
},
],
}
},
}
2020-08-13 15:18:26 +08:00
< / script >
2021-06-25 16:09:42 +08:00
<!--
< setup >
import { defineComponent, reactive, toRefs } from 'vue';
export default defineComponent({
setup() {
const state = reactive({
gridData: [
{
date: '2016-05-02',
name: 'Jack',
address: 'New York City',
},
{
date: '2016-05-04',
name: 'Jack',
address: 'New York City',
},
{
date: '2016-05-01',
name: 'Jack',
address: 'New York City',
},
{
date: '2016-05-03',
name: 'Jack',
address: 'New York City',
},
],
});
return {
...toRefs(state),
};
},
});
< / setup >
-->
2020-08-13 15:18:26 +08:00
```
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
### Nested operation
Of course, you can nest other operations. It's more light-weight than using a dialog.
:::demo
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
```html
2021-09-04 19:29:28 +08:00
< el-popover placement = "top" :width = "160" v-model:visible = "visible" >
2020-08-13 15:18:26 +08:00
< p > Are you sure to delete this?< / p >
< div style = "text-align: right; margin: 0" >
2021-09-04 19:29:28 +08:00
< el-button size = "mini" type = "text" @click =" visible = false"
>cancel< /el-button
>
< el-button type = "primary" size = "mini" @click =" visible = false"
>confirm< /el-button
>
2020-08-13 15:18:26 +08:00
< / div >
2020-10-19 13:44:50 +08:00
< template #reference >
2020-11-04 15:01:37 +08:00
< el-button @click =" visible = true" > Delete</ el-button >
2020-10-19 13:44:50 +08:00
< / template >
2020-08-13 15:18:26 +08:00
< / el-popover >
< script >
export default {
data() {
return {
2021-09-04 19:29:28 +08:00
visible: false,
}
},
}
2020-08-13 15:18:26 +08:00
< / script >
2021-06-25 16:09:42 +08:00
<!--
< setup >
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
return {
visible: ref(false),
};
},
});
< / setup >
-->
2020-08-13 15:18:26 +08:00
```
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
### Attributes
2021-09-04 19:29:28 +08:00
| Attribute | Description | Type | Accepted Values | Default |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| trigger | how the popover is triggered | string | click/focus/hover/manual | click |
| title | popover title | string | — | — |
| content | popover content, can be replaced with a default `slot` | string | — | — |
| width | popover width | string / number | — | Min width 150px |
| placement | popover placement | string | top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end | bottom |
| disabled | whether Popover is disabled | boolean | — | false |
| visible / v-model:visible | whether popover is visible | Boolean | — | false |
| offset | popover offset | number | — | 0 |
| transition | popover transition animation | string | — | el-fade-in-linear |
| show-arrow | whether a tooltip arrow is displayed or not. For more info, please refer to [Vue-popper ](https://github.com/element-component/vue-popper ) | boolean | — | true |
| popper-options | parameters for [popper.js ](https://popper.js.org/documentation.html ) | object | please refer to [popper.js ](https://popper.js.org/documentation.html ) | `{ boundariesElement: 'body', gpuAcceleration: false }` |
| popper-class | custom class name for popover | string | — | — |
| show-after | delay of appearance, in millisecond | number | — | 0 |
| hide-after | delay of disappear, in millisecond | number | — | 0 |
| auto-close | timeout in milliseconds to hide tooltip | number | — | 0 |
| tabindex | [tabindex ](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex ) of Popover | number | — | — |
2020-08-13 15:18:26 +08:00
2021-04-06 11:41:02 +08:00
### Slots
2021-09-04 19:29:28 +08:00
| Name | Description |
| --------- | ---------------------------------- |
| — | text content of popover |
2020-08-13 15:18:26 +08:00
| reference | HTML element that triggers popover |
### Events
2021-09-04 19:29:28 +08:00
| Event Name | Description | Parameters |
| ----------- | ------------------------------------------ | ---------- |
| show | triggers when popover shows | — |
| after-enter | triggers when the entering transition ends | — |
| hide | triggers when popover hides | — |
| after-leave | triggers when the leaving transition ends | — |