From f1879cee73cc001a9987d0d2116cf1a1c389389d Mon Sep 17 00:00:00 2001
From: Maaz Syed Adeeb The The The NB: This feature isn't supported in Internet Explorer 10 NB: This feature isn't supported in Internet Explorer 10.
@@ -82,30 +82,20 @@ make sure they are performant enough to avoid performance bottlenecks.dataObject
is an object containing all the informations used by Popper.js
-this object get passed to modifiers and to the onCreate
and onUpdate
callbacks.dataObject
is an object containing all the information used by Popper.js.
+This object is passed to modifiers and to the onCreate
and onUpdate
callbacks.referenceObject
is an object that provides an interface compatible with Popper.js
@@ -18,7 +18,7 @@ and lets you use it as replacement of a real DOM node.
You can use this method to position a popper relatively to a set of coordinates
in case you don't have a DOM node to use as reference.new Popper(referenceObject, popperNode);
-
Object
- instance - The generated Popper.js instance
| Param | Type | Description |
| --- | --- | --- |
| reference | HTMLElement
\| [referenceObject
](#referenceObject) | The reference element used to position the popper |
-| popper | HTMLElement
| The HTML element used as popper. |
+| popper | HTMLElement
| The HTML element used as the popper |
| options | Object
| Your custom options to override the ones defined in [Defaults](#defaults) |
### Popper.Defaults : Object
-Default options provided to Popper.js constructor.Popper
](#Popper)
@@ -121,7 +111,7 @@ new Popper(ref, pop, {
#### Defaults.placement
-Popper's placement
+Popper's placement.
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -145,7 +135,7 @@ Set this to true if you want popper to position it self in 'fixed' mode
#### Defaults.eventsEnabled
-Whether events (resize, scroll) are initially enabled
+Whether events (resize, scroll) are initially enabled.
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -157,8 +147,7 @@ Whether events (resize, scroll) are initially enabled
#### Defaults.removeOnDestroy
-Set to true if you want to automatically remove the popper when
-you call the `destroy` method.
+Set to true if you want to automatically remove the popper when
you call the `destroy` method.
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -170,8 +159,7 @@ you call the `destroy` method.
#### Defaults.modifiers
-List of modifiers used to modify the offsets before they are applied to the popper.
-They provide most of the functionalities of Popper.js
+List of modifiers used to modify the offsets before they are applied to the popper.
They provide most of the functionalities of Popper.js.
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -183,9 +171,7 @@ They provide most of the functionalities of Popper.js
#### Defaults.onCreate()
-Callback called when the popper is created.Defaults
](#Popper.Defaults)
**Properties**
@@ -197,11 +183,7 @@ Access Popper.js instance with `data.instance`.
#### Defaults.onUpdate()
-Callback called when the popper is updated, this callback is not called
-on the initialization/creation of the popper, but only on subsequent
-updates.Defaults
](#Popper.Defaults)
**Properties**
@@ -213,71 +195,44 @@ Access Popper.js instance with `data.instance`.
### Popper.placements : enum
-List of accepted placements to use as values of the `placement` option.Popper
](#Popper)
**Read only**: true
### Popper.update()
-Updates the position of the popper, computing the new offsets and applying
-the new style.Popper
](#Popper)
### Popper.destroy()
-Destroy the popper
+Destroys the popper.
**Kind**: static method of [Popper
](#Popper)
### Popper.enableEventListeners()
-It will add resize/scroll events and start recalculating
-position of the popper element when they are triggered.
+It will add resize/scroll events and start recalculating
position of the popper element when they are triggered.
**Kind**: static method of [Popper
](#Popper)
### Popper.disableEventListeners()
-It will remove resize/scroll events and won't recalculate popper position
-when they are triggered. It also won't trigger onUpdate callback anymore,
-unless you call `update` method manually.
+It will remove resize/scroll events and won't recalculate popper position
when they are triggered. It also won't trigger `onUpdate` callback anymore,
unless you call `update` method manually.
**Kind**: static method of [Popper
](#Popper)
### Popper.scheduleUpdate()
-Schedule an update, it will run on the next UI update available
+Schedules an update. It will run on the next UI update available.
**Kind**: static method of [Popper
](#Popper)
## dataObject
-The `dataObject` is an object containing all the informations used by Popper.js
-this object get passed to modifiers and to the `onCreate` and `onUpdate` callbacks.
+The `dataObject` is an object containing all the information used by Popper.js.
This object is passed to modifiers and to the `onCreate` and `onUpdate` callbacks.
**Kind**: global variable
**Properties**
@@ -288,12 +243,12 @@ this object get passed to modifiers and to the `onCreate` and `onUpdate` callbac
| data.placement | String
| Placement applied to popper |
| data.originalPlacement | String
| Placement originally defined on init |
| data.flipped | Boolean
| True if popper has been flipped by flip modifier |
-| data.hide | Boolean
| True if the reference element is out of boundaries, useful to know when to hide the popper. |
+| data.hide | Boolean
| True if the reference element is out of boundaries, useful to know when to hide the popper |
| data.arrowElement | HTMLElement
| Node used as arrow by arrow modifier |
-| data.styles | Object
| Any CSS property defined here will be applied to the popper, it expects the JavaScript nomenclature (eg. `marginBottom`) |
-| data.arrowStyles | Object
| Any CSS property defined here will be applied to the popper arrow, it expects the JavaScript nomenclature (eg. `marginBottom`) |
+| data.styles | Object
| Any CSS property defined here will be applied to the popper. It expects the JavaScript nomenclature (eg. `marginBottom`) |
+| data.arrowStyles | Object
| Any CSS property defined here will be applied to the popper arrow. It expects the JavaScript nomenclature (eg. `marginBottom`) |
| data.boundaries | Object
| Offsets of the popper boundaries |
-| data.offsets | Object
| The measurements of popper, reference and arrow elements. |
+| data.offsets | Object
| The measurements of popper, reference and arrow elements |
| data.offsets.popper | Object
| `top`, `left`, `width`, `height` values |
| data.offsets.reference | Object
| `top`, `left`, `width`, `height` values |
| data.offsets.arrow | Object
| `top` and `left` offsets, only one of them will be different from 0 |
@@ -301,16 +256,7 @@ this object get passed to modifiers and to the `onCreate` and `onUpdate` callbac
## referenceObject
-The `referenceObject` is an object that provides an interface compatible with Popper.js
-and lets you use it as replacement of a real DOM node.object
-Modifiers are plugins used to alter the behavior of your poppers.modifiers
](#modifiers)
@@ -436,39 +374,7 @@ It can be one either `-end` or `-start`.
### modifiers~offset
-The `offset` modifier can shift your popper on both its axis.
-
-It accepts the following units:
-- `px` or unitless, interpreted as pixels
-- `%` or `%r`, percentage relative to the length of the reference element
-- `%p`, percentage relative to the length of the popper element
-- `vw`, CSS viewport width unit
-- `vh`, CSS viewport height unit
-
-For length is intended the main axis relative to the placement of the popper.modifiers
](#modifiers)
@@ -521,18 +427,7 @@ Valid examples are:
### modifiers~preventOverflow
-Modifier used to prevent the popper from being positioned outside the boundary.
-
-An scenario exists where the reference itself is not within the boundaries.modifiers
](#modifiers)
@@ -592,7 +487,7 @@ the boundaries in order to remain attached to the edge of the reference.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| padding | number
| 5
| Amount of pixel used to define a minimum distance between the boundaries and the popper this makes sure the popper has always a little padding between the edges of its container |
+| padding | number
| 5
| Amount of pixel used to define a minimum distance between the boundaries and the popper. This makes sure the popper always has a little padding between the edges of its container |
@@ -602,16 +497,12 @@ the boundaries in order to remain attached to the edge of the reference.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| boundariesElement | String
\| HTMLElement
| 'scrollParent'
| Boundaries used by the modifier, can be `scrollParent`, `window`, `viewport` or any DOM element. |
+| boundariesElement | String
\| HTMLElement
| 'scrollParent'
| Boundaries used by the modifier. Can be `scrollParent`, `window`, `viewport` or any DOM element. |
### modifiers~keepTogether
-Modifier used to make sure the reference and its popper stay near eachothers
-without leaving any gap between the two. Expecially useful when the arrow is
-enabled and you want to assure it to point to its reference element.
-It cares only about the first axis, you can still have poppers with margin
-between the popper and its reference element.
+Modifier used to make sure the reference and its popper stay near each other
without leaving any gap between the two. Especially useful when the arrow is
enabled and you want to ensure that it points to its reference element.
It cares only about the first axis. You can still have poppers with margin
between the popper and its reference element.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -653,12 +544,7 @@ between the popper and its reference element.
### modifiers~arrow
-This modifier is used to move the `arrowElement` of the popper to make
-sure it is positioned between the reference element and its popper element.
-It will read the outer size of the `arrowElement` node to detect how many
-pixels of conjuction are needed.
-
-It has no effect if no `arrowElement` is provided.
+This modifier is used to move the `arrowElement` of the popper to make
sure it is positioned between the reference element and its popper element.
It will read the outer size of the `arrowElement` node to detect how many
pixels of conjunction are needed.
It has no effect if no `arrowElement` is provided.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -711,13 +597,7 @@ It has no effect if no `arrowElement` is provided.
### modifiers~flip
-Modifier used to flip the popper's placement when it starts to overlap its
-reference element.
-
-Requires the `preventOverflow` modifier before it in order to work.
-
-**NOTE:** this modifier will interrupt the current update cycle and will
-restart it if it detects the need to flip the placement.
+Modifier used to flip the popper's placement when it starts to overlap its
reference element.
Requires the `preventOverflow` modifier before it in order to work.
**NOTE:** this modifier will interrupt the current update cycle and will
restart it if it detects the need to flip the placement.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -767,7 +647,7 @@ restart it if it detects the need to flip the placement.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| behavior | String
\| Array
| 'flip'
| The behavior used to change the popper's placement. It can be one of `flip`, `clockwise`, `counterclockwise` or an array with a list of valid placements (with optional variations). |
+| behavior | String
\| Array
| 'flip'
| The behavior used to change the popper's placement. It can be one of `flip`, `clockwise`, `counterclockwise` or an array with a list of valid placements (with optional variations) |
@@ -787,14 +667,12 @@ restart it if it detects the need to flip the placement.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| boundariesElement | String
\| HTMLElement
| 'viewport'
| The element which will define the boundaries of the popper position, the popper will never be placed outside of the defined boundaries (except if keepTogether is enabled) |
+| boundariesElement | String
\| HTMLElement
| 'viewport'
| The element which will define the boundaries of the popper position. The popper will never be placed outside of the defined boundaries (except if `keepTogether` is enabled) |
### modifiers~inner
-Modifier used to make the popper flow toward the inner of the reference element.
-By default, when this modifier is disabled, the popper will be placed outside
-the reference element.
+Modifier used to make the popper flow toward the inner of the reference element.
By default, when this modifier is disabled, the popper will be placed outside
the reference element.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -836,12 +714,7 @@ the reference element.
### modifiers~hide
-Modifier used to hide the popper when its reference element is outside of the
-popper boundaries. It will set a `x-out-of-boundaries` attribute which can
-be used to hide with a CSS selector the popper when its reference is
-out of boundaries.
-
-Requires the `preventOverflow` modifier before it in order to work.
+Modifier used to hide the popper when its reference element is outside of the
popper boundaries. It will set a `x-out-of-boundaries` attribute which can
be used to hide with a CSS selector the popper when its reference is
out of boundaries.
Requires the `preventOverflow` modifier before it in order to work.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -883,16 +756,7 @@ Requires the `preventOverflow` modifier before it in order to work.
### modifiers~computeStyle
-Computes the style that will be applied to the popper element to gets
-properly positioned.
-
-Note that this modifier will not touch the DOM, it just prepares the styles
-so that `applyStyle` modifier can apply it. This separation is useful
-in case you need to replace `applyStyle` with a custom implementation.
-
-This modifier has `850` as `order` value to maintain backward compatibility
-with previous versions of Popper.js. Expect the modifiers ordering method
-to change in future major versions of the library.
+Computes the style that will be applied to the popper element to gets
properly positioned.
Note that this modifier will not touch the DOM, it just prepares the styles
so that `applyStyle` modifier can apply it. This separation is useful
in case you need to replace `applyStyle` with a custom implementation.
This modifier has `850` as `order` value to maintain backward compatibility
with previous versions of Popper.js. Expect the modifiers ordering method
to change in future major versions of the library.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -942,7 +806,7 @@ to change in future major versions of the library.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3d transformation to position the popper. Otherwise, it will use the `top` and `left` properties. |
+| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3D transformation to position the popper. Otherwise, it will use the `top` and `left` properties |
@@ -967,16 +831,7 @@ to change in future major versions of the library.
### modifiers~applyStyle
-Applies the computed styles to the popper element.
-
-All the DOM manipulations are limited to this modifier. This is useful in case
-you want to integrate Popper.js inside a framework or view library and you
-want to delegate all the DOM manipulations to it.
-
-Note that if you disable this modifier, you must make sure the popper element
-has its position set to `absolute` before Popper.js can do its work!
-
-Just disable this modifier and define you own to achieve the desired effect.
+Applies the computed styles to the popper element.
All the DOM manipulations are limited to this modifier. This is useful in case
you want to integrate Popper.js inside a framework or view library and you
want to delegate all the DOM manipulations to it.
Note that if you disable this modifier, you must make sure the popper element
has its position set to `absolute` before Popper.js can do its work!
Just disable this modifier and define your own to achieve the desired effect.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -1037,7 +892,7 @@ Just disable this modifier and define you own to achieve the desired effect.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3d transformation to position the popper. Otherwise, it will use the `top` and `left` properties. |
+| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3D transformation to position the popper. Otherwise, it will use the `top` and `left` properties |
@@ -1053,10 +908,7 @@ Get the window associated with the element
## ModifierFn(data, options) ⇒ [dataObject
](#dataObject)
-Modifier function, each modifier can have a function of this type assigned
-to its `fn` property.dataObject
](#dataObject) - The data object, properly modified
diff --git a/packages/popper/src/index.js b/packages/popper/src/index.js
index 50d90c8e0a..8f054e28de 100644
--- a/packages/popper/src/index.js
+++ b/packages/popper/src/index.js
@@ -12,10 +12,10 @@ import placements from './methods/placements';
export default class Popper {
/**
- * Create a new Popper.js instance
+ * Creates a new Popper.js instance.
* @class Popper
* @param {HTMLElement|referenceObject} reference - The reference element used to position the popper
- * @param {HTMLElement} popper - The HTML element used as popper.
+ * @param {HTMLElement} popper - The HTML element used as the popper
* @param {Object} options - Your custom options to override the ones defined in [Defaults](#defaults)
* @return {Object} instance - The generated Popper.js instance
*/
@@ -104,7 +104,7 @@ export default class Popper {
}
/**
- * Schedule an update, it will run on the next UI update available
+ * Schedules an update. It will run on the next UI update available.
* @method scheduleUpdate
* @memberof Popper
*/
@@ -143,7 +143,7 @@ export default class Popper {
* new Popper(referenceObject, popperNode);
* ```
*
- * NB: This feature isn't supported in Internet Explorer 10
+ * NB: This feature isn't supported in Internet Explorer 10.
* @name referenceObject
* @property {Function} data.getBoundingClientRect
* A function that returns a set of coordinates compatible with the native `getBoundingClientRect` method.
diff --git a/packages/popper/src/methods/defaults.js b/packages/popper/src/methods/defaults.js
index 8ab4e9bab9..461f98106e 100644
--- a/packages/popper/src/methods/defaults.js
+++ b/packages/popper/src/methods/defaults.js
@@ -2,9 +2,9 @@ import modifiers from '../modifiers/index';
/**
* Default options provided to Popper.js constructor.The dataObject
is an object containing all the information used by Popper.js.
-This object is passed to modifiers and to the onCreate
and onUpdate
callbacks.
The dataObject
is an object containing all the informations used by Popper.js
+this object get passed to modifiers and to the onCreate
and onUpdate
callbacks.
The referenceObject
is an object that provides an interface compatible with Popper.js
@@ -18,7 +18,7 @@ and lets you use it as replacement of a real DOM node.
You can use this method to position a popper relatively to a set of coordinates
in case you don't have a DOM node to use as reference.
new Popper(referenceObject, popperNode);
-
NB: This feature isn't supported in Internet Explorer 10.
+NB: This feature isn't supported in Internet Explorer 10
Object
- instance - The generated Popper.js instance
| Param | Type | Description |
| --- | --- | --- |
| reference | HTMLElement
\| [referenceObject
](#referenceObject) | The reference element used to position the popper |
-| popper | HTMLElement
| The HTML element used as the popper |
+| popper | HTMLElement
| The HTML element used as popper. |
| options | Object
| Your custom options to override the ones defined in [Defaults](#defaults) |
### Popper.Defaults : Object
-Default options provided to Popper.js constructor.Popper
](#Popper)
@@ -111,7 +121,7 @@ Default options provided to Popper.js constructor.Defaults
](#Popper.Defaults)
**Properties**
@@ -135,7 +145,7 @@ Set this to true if you want popper to position it self in 'fixed' mode
#### Defaults.eventsEnabled
-Whether events (resize, scroll) are initially enabled.
+Whether events (resize, scroll) are initially enabled
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -147,7 +157,8 @@ Whether events (resize, scroll) are initially enabled.
#### Defaults.removeOnDestroy
-Set to true if you want to automatically remove the popper when
you call the `destroy` method.
+Set to true if you want to automatically remove the popper when
+you call the `destroy` method.
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -159,7 +170,8 @@ Set to true if you want to automatically remove the popper when
you call the `de
#### Defaults.modifiers
-List of modifiers used to modify the offsets before they are applied to the popper.
They provide most of the functionalities of Popper.js.
+List of modifiers used to modify the offsets before they are applied to the popper.
+They provide most of the functionalities of Popper.js
**Kind**: static property of [Defaults
](#Popper.Defaults)
**Properties**
@@ -171,7 +183,9 @@ List of modifiers used to modify the offsets before they are applied to the popp
#### Defaults.onCreate()
-Callback called when the popper is created.Defaults
](#Popper.Defaults)
**Properties**
@@ -183,7 +197,11 @@ Callback called when the popper is created.Defaults
](#Popper.Defaults)
**Properties**
@@ -195,44 +213,71 @@ Callback called when the popper is updated. This callback is not called
on the i
### Popper.placements : enum
-List of accepted placements to use as values of the `placement` option.Popper
](#Popper)
**Read only**: true
### Popper.update()
-Updates the position of the popper, computing the new offsets and applying
the new style.Popper
](#Popper)
### Popper.destroy()
-Destroys the popper.
+Destroy the popper
**Kind**: static method of [Popper
](#Popper)
### Popper.enableEventListeners()
-It will add resize/scroll events and start recalculating
position of the popper element when they are triggered.
+It will add resize/scroll events and start recalculating
+position of the popper element when they are triggered.
**Kind**: static method of [Popper
](#Popper)
### Popper.disableEventListeners()
-It will remove resize/scroll events and won't recalculate popper position
when they are triggered. It also won't trigger `onUpdate` callback anymore,
unless you call `update` method manually.
+It will remove resize/scroll events and won't recalculate popper position
+when they are triggered. It also won't trigger onUpdate callback anymore,
+unless you call `update` method manually.
**Kind**: static method of [Popper
](#Popper)
### Popper.scheduleUpdate()
-Schedules an update. It will run on the next UI update available.
+Schedule an update, it will run on the next UI update available
**Kind**: static method of [Popper
](#Popper)
## dataObject
-The `dataObject` is an object containing all the information used by Popper.js.
This object is passed to modifiers and to the `onCreate` and `onUpdate` callbacks.
+The `dataObject` is an object containing all the informations used by Popper.js
+this object get passed to modifiers and to the `onCreate` and `onUpdate` callbacks.
**Kind**: global variable
**Properties**
@@ -243,12 +288,12 @@ The `dataObject` is an object containing all the information used by Popper.js.
| data.placement | String
| Placement applied to popper |
| data.originalPlacement | String
| Placement originally defined on init |
| data.flipped | Boolean
| True if popper has been flipped by flip modifier |
-| data.hide | Boolean
| True if the reference element is out of boundaries, useful to know when to hide the popper |
+| data.hide | Boolean
| True if the reference element is out of boundaries, useful to know when to hide the popper. |
| data.arrowElement | HTMLElement
| Node used as arrow by arrow modifier |
-| data.styles | Object
| Any CSS property defined here will be applied to the popper. It expects the JavaScript nomenclature (eg. `marginBottom`) |
-| data.arrowStyles | Object
| Any CSS property defined here will be applied to the popper arrow. It expects the JavaScript nomenclature (eg. `marginBottom`) |
+| data.styles | Object
| Any CSS property defined here will be applied to the popper, it expects the JavaScript nomenclature (eg. `marginBottom`) |
+| data.arrowStyles | Object
| Any CSS property defined here will be applied to the popper arrow, it expects the JavaScript nomenclature (eg. `marginBottom`) |
| data.boundaries | Object
| Offsets of the popper boundaries |
-| data.offsets | Object
| The measurements of popper, reference and arrow elements |
+| data.offsets | Object
| The measurements of popper, reference and arrow elements. |
| data.offsets.popper | Object
| `top`, `left`, `width`, `height` values |
| data.offsets.reference | Object
| `top`, `left`, `width`, `height` values |
| data.offsets.arrow | Object
| `top` and `left` offsets, only one of them will be different from 0 |
@@ -256,7 +301,16 @@ The `dataObject` is an object containing all the information used by Popper.js.
## referenceObject
-The `referenceObject` is an object that provides an interface compatible with Popper.js
and lets you use it as replacement of a real DOM node.object
-Modifiers are plugins used to alter the behavior of your poppers.modifiers
](#modifiers)
@@ -374,7 +436,39 @@ Modifier used to shift the popper on the start or end of its reference
element.<
### modifiers~offset
-The `offset` modifier can shift your popper on both its axis.
It accepts the following units:
- `px` or unit-less, interpreted as pixels
- `%` or `%r`, percentage relative to the length of the reference element
- `%p`, percentage relative to the length of the popper element
- `vw`, CSS viewport width unit
- `vh`, CSS viewport height unit
For length is intended the main axis relative to the placement of the popper.modifiers
](#modifiers)
@@ -427,7 +521,18 @@ The `offset` modifier can shift your popper on both its axis.
It accepts the fo
### modifiers~preventOverflow
-Modifier used to prevent the popper from being positioned outside the boundary.
A scenario exists where the reference itself is not within the boundaries.modifiers
](#modifiers)
@@ -487,7 +592,7 @@ Modifier used to prevent the popper from being positioned outside the boundary.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| padding | number
| 5
| Amount of pixel used to define a minimum distance between the boundaries and the popper. This makes sure the popper always has a little padding between the edges of its container |
+| padding | number
| 5
| Amount of pixel used to define a minimum distance between the boundaries and the popper this makes sure the popper has always a little padding between the edges of its container |
@@ -497,12 +602,16 @@ Modifier used to prevent the popper from being positioned outside the boundary.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| boundariesElement | String
\| HTMLElement
| 'scrollParent'
| Boundaries used by the modifier. Can be `scrollParent`, `window`, `viewport` or any DOM element. |
+| boundariesElement | String
\| HTMLElement
| 'scrollParent'
| Boundaries used by the modifier, can be `scrollParent`, `window`, `viewport` or any DOM element. |
### modifiers~keepTogether
-Modifier used to make sure the reference and its popper stay near each other
without leaving any gap between the two. Especially useful when the arrow is
enabled and you want to ensure that it points to its reference element.
It cares only about the first axis. You can still have poppers with margin
between the popper and its reference element.
+Modifier used to make sure the reference and its popper stay near eachothers
+without leaving any gap between the two. Expecially useful when the arrow is
+enabled and you want to assure it to point to its reference element.
+It cares only about the first axis, you can still have poppers with margin
+between the popper and its reference element.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -544,7 +653,12 @@ Modifier used to make sure the reference and its popper stay near each other
wit
### modifiers~arrow
-This modifier is used to move the `arrowElement` of the popper to make
sure it is positioned between the reference element and its popper element.
It will read the outer size of the `arrowElement` node to detect how many
pixels of conjunction are needed.
It has no effect if no `arrowElement` is provided.
+This modifier is used to move the `arrowElement` of the popper to make
+sure it is positioned between the reference element and its popper element.
+It will read the outer size of the `arrowElement` node to detect how many
+pixels of conjuction are needed.
+
+It has no effect if no `arrowElement` is provided.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -597,7 +711,13 @@ This modifier is used to move the `arrowElement` of the popper to make
sure it i
### modifiers~flip
-Modifier used to flip the popper's placement when it starts to overlap its
reference element.
Requires the `preventOverflow` modifier before it in order to work.
**NOTE:** this modifier will interrupt the current update cycle and will
restart it if it detects the need to flip the placement.
+Modifier used to flip the popper's placement when it starts to overlap its
+reference element.
+
+Requires the `preventOverflow` modifier before it in order to work.
+
+**NOTE:** this modifier will interrupt the current update cycle and will
+restart it if it detects the need to flip the placement.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -647,7 +767,7 @@ Modifier used to flip the popper's placement when it starts to overlap its
refer
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| behavior | String
\| Array
| 'flip'
| The behavior used to change the popper's placement. It can be one of `flip`, `clockwise`, `counterclockwise` or an array with a list of valid placements (with optional variations) |
+| behavior | String
\| Array
| 'flip'
| The behavior used to change the popper's placement. It can be one of `flip`, `clockwise`, `counterclockwise` or an array with a list of valid placements (with optional variations). |
@@ -667,12 +787,14 @@ Modifier used to flip the popper's placement when it starts to overlap its
refer
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| boundariesElement | String
\| HTMLElement
| 'viewport'
| The element which will define the boundaries of the popper position. The popper will never be placed outside of the defined boundaries (except if `keepTogether` is enabled) |
+| boundariesElement | String
\| HTMLElement
| 'viewport'
| The element which will define the boundaries of the popper position, the popper will never be placed outside of the defined boundaries (except if keepTogether is enabled) |
### modifiers~inner
-Modifier used to make the popper flow toward the inner of the reference element.
By default, when this modifier is disabled, the popper will be placed outside
the reference element.
+Modifier used to make the popper flow toward the inner of the reference element.
+By default, when this modifier is disabled, the popper will be placed outside
+the reference element.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -714,7 +836,12 @@ Modifier used to make the popper flow toward the inner of the reference element.
### modifiers~hide
-Modifier used to hide the popper when its reference element is outside of the
popper boundaries. It will set a `x-out-of-boundaries` attribute which can
be used to hide with a CSS selector the popper when its reference is
out of boundaries.
Requires the `preventOverflow` modifier before it in order to work.
+Modifier used to hide the popper when its reference element is outside of the
+popper boundaries. It will set a `x-out-of-boundaries` attribute which can
+be used to hide with a CSS selector the popper when its reference is
+out of boundaries.
+
+Requires the `preventOverflow` modifier before it in order to work.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -756,7 +883,16 @@ Modifier used to hide the popper when its reference element is outside of the
po
### modifiers~computeStyle
-Computes the style that will be applied to the popper element to gets
properly positioned.
Note that this modifier will not touch the DOM, it just prepares the styles
so that `applyStyle` modifier can apply it. This separation is useful
in case you need to replace `applyStyle` with a custom implementation.
This modifier has `850` as `order` value to maintain backward compatibility
with previous versions of Popper.js. Expect the modifiers ordering method
to change in future major versions of the library.
+Computes the style that will be applied to the popper element to gets
+properly positioned.
+
+Note that this modifier will not touch the DOM, it just prepares the styles
+so that `applyStyle` modifier can apply it. This separation is useful
+in case you need to replace `applyStyle` with a custom implementation.
+
+This modifier has `850` as `order` value to maintain backward compatibility
+with previous versions of Popper.js. Expect the modifiers ordering method
+to change in future major versions of the library.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -806,7 +942,7 @@ Computes the style that will be applied to the popper element to gets
properly p
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3D transformation to position the popper. Otherwise, it will use the `top` and `left` properties |
+| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3d transformation to position the popper. Otherwise, it will use the `top` and `left` properties. |
@@ -831,7 +967,16 @@ Computes the style that will be applied to the popper element to gets
properly p
### modifiers~applyStyle
-Applies the computed styles to the popper element.
All the DOM manipulations are limited to this modifier. This is useful in case
you want to integrate Popper.js inside a framework or view library and you
want to delegate all the DOM manipulations to it.
Note that if you disable this modifier, you must make sure the popper element
has its position set to `absolute` before Popper.js can do its work!
Just disable this modifier and define your own to achieve the desired effect.
+Applies the computed styles to the popper element.
+
+All the DOM manipulations are limited to this modifier. This is useful in case
+you want to integrate Popper.js inside a framework or view library and you
+want to delegate all the DOM manipulations to it.
+
+Note that if you disable this modifier, you must make sure the popper element
+has its position set to `absolute` before Popper.js can do its work!
+
+Just disable this modifier and define you own to achieve the desired effect.
**Kind**: inner property of [modifiers
](#modifiers)
@@ -892,7 +1037,7 @@ Applies the computed styles to the popper element.
All the DOM manipulations ar
| Name | Type | Default | Description |
| --- | --- | --- | --- |
-| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3D transformation to position the popper. Otherwise, it will use the `top` and `left` properties |
+| gpuAcceleration | Boolean
| true
| If true, it uses the CSS 3d transformation to position the popper. Otherwise, it will use the `top` and `left` properties. |
@@ -908,7 +1053,10 @@ Get the window associated with the element
## ModifierFn(data, options) ⇒ [dataObject
](#dataObject)
-Modifier function, each modifier can have a function of this type assigned
to its `fn` property.dataObject
](#dataObject) - The data object, properly modified