dd19cae2bc
* refactor(components): popper composables - Refactor popper composables * updates * updates for tooltip * Updates for popper. TODO: fix controlled tooltip animation * Fix controlled mode popper animation issue * Add new feature for customizing tooltip theme * Fix popover and popconfirm error * - Add Collection component for wrapping a collection of component - Add FocusTrap component for trap focus for popups - Add RovingFocus component for roving focus component type - Adjust dropdown component based on these newly added components - Add popper-trigger component for placing the trigger - TODO: Finish current dropdown component, and all component's tests plus documents * Refactor popper * Complete organizing popper * Almost finish dropdown * Update popper tests * update only-child test * Finish focus trap component test * Finish tooltip content test * Finish tooltip trigger tests * Finish tooltip tests * finish tests for Collection and RovingFocusGroup * Fix test cases for timeselect & select & popover * Fix popover, popconfirm, menu bug and test cases * Fix select-v2 test error caused by updating popper * Fix date-picker test issue for updating popper * fix test cases * Fix eslint * Rebase dev & fix tests * Remove unused code
9.0 KiB
| title | lang |
|---|---|
| Popover | en-US |
Popover
Basic usage
Similar to Tooltip, Popover is also built with ElPopper. So for some duplicated attributes, please refer to the documentation of Tooltip.
:::demo The trigger attribute is used to define how popover is triggered: hover, click, focus or manual.
popover/basic-usage
:::
Virtual triggering
Like Tooltip, Popover can be triggered by virtual elements, if your use case includes separate the trigging element and the content element, you should definitely use the mechanism, normally we use #reference to place our triggering element, with triggering-element API you can set your triggering element anywhere you like, but notice that the triggering element should be an element that accepts mouse and keyboard event.
:::warning
v-popover is about to be deprecated, please use virtual-ref as alternative.
:::
:::demo
popover/virtual-triggering
:::
Rich content
Other components/elements can be nested in popover. Following is an example of nested table.
:::demo replace the content attribute with a default slot.
popover/nested-information
:::
Nested operation
Of course, you can nest other operations. It's more light-weight than using a dialog.
:::demo
popover/nested-operation
:::
Directive
You can still using popover in directive way but this is not recommended anymore since this makes your application complicated, you may refer to the virtual triggering for more information.
:::demo
popover/directive-usage
:::
Attributes
| 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 ElPopper | boolean | — | true |
| popper-options | parameters for popper.js | object | please refer to popper.js | { 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 | — | 200 |
| auto-close | timeout in milliseconds to hide tooltip | number | — | 0 |
| tabindex | tabindex of Popover | number | — | — |
Slots
| Name | Description |
|---|---|
| — | text content of popover |
| reference | HTML element that triggers popover |
Events
| 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 | — |