# MPopper 弹出层 - [示例](#示例) - [基本用法](#基本用法) - [触发方式](#触发方式) - [弹出方位](#弹出方位) - [跟随鼠标](#跟随鼠标) - [右键菜单](#右键菜单) - [禁用状态](#禁用状态) - [API]() - [Props/Attrs](#propsattrs) - [Slots](#slots) - [Events](#events) - [Methods](#methods) 弹出层基类，可以直接使用它的弹出效果，或者以继承的方式扩展出常用的弹出组件。如弹出框、工具提示等。 ## 示例 ### 基本用法 将需要弹出的内容用``包裹起来，并插入到触发事件的元素中。 ``` html click popper ``` ### 触发方式 使用`trigger`属性设置触发方式。 #### 自动触发 ``` html click（默认） popper hover popper right-click popper double-click popper ``` #### 手动触发 也可以手动触发弹出层的弹出/关闭： ``` vue ``` #### 显隐延时 使用`hover-delay`属性和`hide-delay`属性控制显隐的延时。 ``` html hover popper ``` ### 弹出方位 使用`placement`属性控制弹出方位。 ``` html 上左 popper 上边 popper 上右 popper 左上 popper 左边 popper 左下 popper 右上 popper 右边 popper 右下 popper 下左 popper 下边 popper 下右 popper ``` ### 跟随鼠标 开启`follow-cursor`属性可以让弹出层跟随鼠标。也可以传一个数字或对象调整位置偏移。 ``` html 上左 popper 上边 popper 上右 popper 左上 popper 左边 popper 左下 popper 右上 popper 右边 popper 右下 popper 下左 popper 下边 popper 下右 popper 自定义 popper ``` ### 右键菜单 使用`trigger`和`follow-cursor`两个属性可以很容易的实现右键菜单功能。 ``` html 右键菜单 指南 概念 组件 ``` ### 禁用状态 给弹出层添加`disabled`属性可以禁止弹出效果，但需要手动设置外层元素的状态。 ``` html disabled popper ``` ## API ### Props/Attrs | Prop/Attr | Type | Options | Default | Description | | --------- | ---- | ------- | ------- | ----------- | | opened.sync | boolean | | `false` | 弹出/关闭状态 | | trigger | string | `[object Object]`
`[object Object]`
`[object Object]`
`[object Object]`
`[object Object]` | `'click'` | 触发方式。 | | placement | string | `'上'` ()
`'下'` ()
`'左'` ()
`'右'` ()
`'上左'` ()
`'上右'` ()
`'下左'` ()
`'下右'` ()
`'左上'` ()
`'左下'` ()
`'右上'` ()
`'右下'` () | `'bottom'` | 弹出方向。 | | reference | string \| HTMLElement \| Function | | `'parent'` | 参考元素。可选值：`'parent'`表示父元素，`'prev'`表示上一个元素，`'next'`表示下一个元素。也可以传一个 HTML 元素，或用于返回元素的方法。 | | hover-delay | number | | `0` | 当 trigger 为 `'hover'` 时的延迟时间。 | | hide-delay | number | | `200` | 当 trigger 为 `'hover'` 时的消失延迟时间，单位是 ms。 | | append-to | string | | `'body'` | 设置添加到哪个元素。可选值：`'body'`表示添加到 document.body，`'reference'`表示添加到参考元素中 | | boundaries-element | Element \| string | | `'window'` | 边际元素。用于定义弹出层的边际，默认为首个滚动的父级元素 | | escape-with-reference | boolean | | `true` | 当触发元素离开边际时，弹出层离开/保留在边际元素内 | | follow-cursor | boolean \| number \| object | | `false` | 是否跟随鼠标 | | offset | string | | `'0'` | 弹出层偏移，如：'10', '10px 10px', '10% 10%', 第一个值表示水平偏移，第二个值表示垂直位移, 默认单位是`px` | | options | object | | | 补充 popper.js 的选项 | | disabled | boolean | | `false` | 是否禁用 | ### Slots #### (default) 插入需要弹出的内容。 ### Events #### @before-open 弹出前触发。 | Param | Type | Description | | ----- | ---- | ----------- | | $event.preventDefault | Function | 阻止弹出流程 | | senderVM | MPopper | 发送事件实例 | #### @open 弹出时触发。 | Param | Type | Description | | ----- | ---- | ----------- | | $event | void | 空 | | senderVM | MPopper | 发送事件实例 | #### @before-close 隐藏前触发。 | Param | Type | Description | | ----- | ---- | ----------- | | $event.preventDefault | Function | 阻止隐藏流程 | | senderVM | MPopper | 发送事件实例 | #### @close 隐藏时触发。 | Param | Type | Description | | ----- | ---- | ----------- | | $event | void | 空 | | senderVM | MPopper | 发送事件实例 | Methods #### open() 弹出实例。 | Param | Type | Default | Description | | ----- | ---- | ------- | ----------- | #### close() 关闭实例。 | Param | Type | Default | Description | | ----- | ---- | ------- | ----------- | #### toggle(opened?) 切换弹出/关闭状态。 | Param | Type | Default | Description | | ----- | ---- | ------- | ----------- | | opened? | boolean | | 可选。弹出/关闭状态 | #### update() 更新 popper 实例。参考 [Popper.update()](https://popper.js.org/popper-documentation.html#Popper.update)。 | Param | Type | Default | Description | | ----- | ---- | ------- | ----------- | #### scheduleUpdate() 在下次 UI 渲染时一块更新 popper 实例，比`update()`性能要好。参考 [Popper.scheduleUpdate()](https://popper.js.org/popper-documentation.html#Popper.scheduleUpdate)。 | Param | Type | Default | Description | | ----- | ---- | ------- | ----------- |