popper.js dep

This commit is contained in:
Nabeel Shahzad
2017-08-16 17:27:59 -05:00
parent f4365053a0
commit 09502153ed
24 changed files with 68 additions and 47 deletions
@@ -48,10 +48,10 @@ make sure they are performant enough to avoid performance bottlenecks.</p>
## Typedefs
<dl>
<dt><a href="#onCreate">onCreate</a> : <code>function</code></dt>
<dd></dd>
<dt><a href="#onUpdate">onUpdate</a> : <code>function</code></dt>
<dd></dd>
<dt><a href="#onCreate">onCreate</a> : <code>function</code></dt>
<dd></dd>
</dl>
<a name="Popper"></a>
@@ -274,6 +274,7 @@ this object get passed to modifiers and to the `onCreate` and `onUpdate` callbac
| data.hide | <code>Boolean</code> | True if the reference element is out of boundaries, useful to know when to hide the popper. |
| data.arrowElement | <code>HTMLElement</code> | Node used as arrow by arrow modifier |
| data.styles | <code>Object</code> | Any CSS property defined here will be applied to the popper, it expects the JavaScript nomenclature (eg. `marginBottom`) |
| data.arrowStyles | <code>Object</code> | Any CSS property defined here will be applied to the popper arrow, it expects the JavaScript nomenclature (eg. `marginBottom`) |
| data.boundaries | <code>Object</code> | Offsets of the popper boundaries |
| data.offsets | <code>Object</code> | The measurements of popper, reference and arrow elements. |
| data.offsets.popper | <code>Object</code> | `top`, `left`, `width`, `height` values |
@@ -448,6 +449,9 @@ Valid examples are:
'10 - 5vh + 3%'
'-10px + 5vh, 5px - 6%'
```
> **NB**: If you desire to apply offsets to your poppers in a way that may make them overlap
> with their reference element, unfortunately, you will have to disable the `flip` modifier.
> More on this [reading this issue](https://github.com/FezVrasta/popper.js/issues/373)
**Kind**: inner property of [<code>modifiers</code>](#modifiers)
@@ -1034,15 +1038,6 @@ make sure they are performant enough to avoid performance bottlenecks.
| data | [<code>dataObject</code>](#dataObject) | The data object generated by `update` method |
| options | <code>Object</code> | Modifiers configuration and options |
<a name="onCreate"></a>
## onCreate : <code>function</code>
**Kind**: global typedef
| Param | Type |
| --- | --- |
| data | [<code>dataObject</code>](#dataObject) |
<a name="onUpdate"></a>
## onUpdate : <code>function</code>
@@ -1052,3 +1047,12 @@ make sure they are performant enough to avoid performance bottlenecks.
| --- | --- |
| data | [<code>dataObject</code>](#dataObject) |
<a name="onCreate"></a>
## onCreate : <code>function</code>
**Kind**: global typedef
| Param | Type |
| --- | --- |
| data | [<code>dataObject</code>](#dataObject) |