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.
- * These can be overriden using the `options` argument of Popper.js.
- * To override an option, simply pass as 3rd argument an object with the same
- * structure of this object, example:
+ * These can be overridden using the `options` argument of Popper.js.
+ * To override an option, simply pass an object with the same
+ * structure of the `options` object, as the 3rd argument. For example:
* ```
* new Popper(ref, pop, {
* modifiers: {
@@ -18,7 +18,7 @@ import modifiers from '../modifiers/index';
*/
export default {
/**
- * Popper's placement
+ * Popper's placement.
* @prop {Popper.placements} placement='bottom'
*/
placement: 'bottom',
@@ -30,7 +30,7 @@ export default {
positionFixed: false,
/**
- * Whether events (resize, scroll) are initially enabled
+ * Whether events (resize, scroll) are initially enabled.
* @prop {Boolean} eventsEnabled=true
*/
eventsEnabled: true,
@@ -44,17 +44,17 @@ export default {
/**
* Callback called when the popper is created.
- * By default, is set to no-op.
+ * By default, it is set to no-op.
* Access Popper.js instance with `data.instance`.
* @prop {onCreate}
*/
onCreate: () => {},
/**
- * Callback called when the popper is updated, this callback is not called
+ * Callback called when the popper is updated. This callback is not called
* on the initialization/creation of the popper, but only on subsequent
* updates.
- * By default, is set to no-op.
+ * By default, it is set to no-op.
* Access Popper.js instance with `data.instance`.
* @prop {onUpdate}
*/
@@ -62,7 +62,7 @@ export default {
/**
* List of modifiers used to modify the offsets before they are applied to the popper.
- * They provide most of the functionalities of Popper.js
+ * They provide most of the functionalities of Popper.js.
* @prop {modifiers}
*/
modifiers,
diff --git a/packages/popper/src/methods/destroy.js b/packages/popper/src/methods/destroy.js
index f427481cc1..df585e0bfb 100644
--- a/packages/popper/src/methods/destroy.js
+++ b/packages/popper/src/methods/destroy.js
@@ -2,7 +2,7 @@ import isModifierEnabled from '../utils/isModifierEnabled';
import getSupportedPropertyName from '../utils/getSupportedPropertyName';
/**
- * Destroy the popper
+ * Destroys the popper.
* @method
* @memberof Popper
*/
diff --git a/packages/popper/src/methods/disableEventListeners.js b/packages/popper/src/methods/disableEventListeners.js
index 87a8c0d995..4d2e0322b7 100644
--- a/packages/popper/src/methods/disableEventListeners.js
+++ b/packages/popper/src/methods/disableEventListeners.js
@@ -2,7 +2,7 @@ import removeEventListeners from '../utils/removeEventListeners';
/**
* It will remove resize/scroll events and won't recalculate popper position
- * when they are triggered. It also won't trigger onUpdate callback anymore,
+ * when they are triggered. It also won't trigger `onUpdate` callback anymore,
* unless you call `update` method manually.
* @method
* @memberof Popper
diff --git a/packages/popper/src/modifiers/arrow.js b/packages/popper/src/modifiers/arrow.js
index c14e9f16c1..94bab5ac42 100644
--- a/packages/popper/src/modifiers/arrow.js
+++ b/packages/popper/src/modifiers/arrow.js
@@ -50,7 +50,7 @@ export default function arrow(data, options) {
//
// extends keepTogether behavior making sure the popper and its
- // reference have enough pixels in conjuction
+ // reference have enough pixels in conjunction
//
// top/left side
diff --git a/packages/popper/src/modifiers/index.js b/packages/popper/src/modifiers/index.js
index a8ad57e91b..db8fd7d797 100644
--- a/packages/popper/src/modifiers/index.js
+++ b/packages/popper/src/modifiers/index.js
@@ -52,7 +52,7 @@ export default {
* The `offset` modifier can shift your popper on both its axis.
*
* It accepts the following units:
- * - `px` or unitless, interpreted as pixels
+ * - `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
@@ -60,7 +60,7 @@ export default {
*
* For length is intended the main axis relative to the placement of the popper.
* This means that if the placement is `top` or `bottom`, the length will be the
- * `width`. In case of `left` or `right`, it will be the height.
+ * `width`. In case of `left` or `right`, it will be the `height`.
*
* You can provide a single value (as `Number` or `String`), or a pair of values
* as `String` divided by a comma or one (or more) white spaces.
@@ -81,7 +81,7 @@ export default {
* ```
* > **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)
+ * > You can read more on this at this [issue](https://github.com/FezVrasta/popper.js/issues/373).
*
* @memberof modifiers
* @inner
@@ -102,7 +102,7 @@ export default {
/**
* Modifier used to prevent the popper from being positioned outside the boundary.
*
- * An scenario exists where the reference itself is not within the boundaries.
+ * A scenario exists where the reference itself is not within the boundaries.
* We can say it has "escaped the boundaries" — or just "escaped".
* In this case we need to decide whether the popper should either:
*
@@ -132,23 +132,23 @@ export default {
/**
* @prop {number} padding=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
+ * and the popper. This makes sure the popper always has a little padding
* between the edges of its container
*/
padding: 5,
/**
* @prop {String|HTMLElement} boundariesElement='scrollParent'
- * Boundaries used by the modifier, can be `scrollParent`, `window`,
+ * Boundaries used by the modifier. Can be `scrollParent`, `window`,
* `viewport` or any DOM element.
*/
boundariesElement: 'scrollParent',
},
/**
- * 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
+ * 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.
* @memberof modifiers
* @inner
@@ -166,7 +166,7 @@ export default {
* 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.
+ * pixels of conjunction are needed.
*
* It has no effect if no `arrowElement` is provided.
* @memberof modifiers
@@ -205,7 +205,7 @@ export default {
* @prop {String|Array} behavior='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).
+ * placements (with optional variations)
*/
behavior: 'flip',
/**
@@ -215,9 +215,9 @@ export default {
padding: 5,
/**
* @prop {String|HTMLElement} boundariesElement='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)
+ * 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: 'viewport',
},
@@ -281,8 +281,8 @@ export default {
fn: computeStyle,
/**
* @prop {Boolean} gpuAcceleration=true
- * If true, it uses the CSS 3d transformation to position the popper.
- * Otherwise, it will use the `top` and `left` properties.
+ * If true, it uses the CSS 3D transformation to position the popper.
+ * Otherwise, it will use the `top` and `left` properties
*/
gpuAcceleration: true,
/**
@@ -309,7 +309,7 @@ export default {
* 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.
+ * Just disable this modifier and define your own to achieve the desired effect.
*
* @memberof modifiers
* @inner
@@ -326,27 +326,27 @@ export default {
/**
* @deprecated since version 1.10.0, the property moved to `computeStyle` modifier
* @prop {Boolean} gpuAcceleration=true
- * If true, it uses the CSS 3d transformation to position the popper.
- * Otherwise, it will use the `top` and `left` properties.
+ * If true, it uses the CSS 3D transformation to position the popper.
+ * Otherwise, it will use the `top` and `left` properties
*/
gpuAcceleration: undefined,
},
};
/**
- * 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.
* @name dataObject
* @property {Object} data.instance The Popper.js instance
* @property {String} data.placement Placement applied to popper
* @property {String} data.originalPlacement Placement originally defined on init
* @property {Boolean} data.flipped True if popper has been flipped by flip modifier
- * @property {Boolean} data.hide True if the reference element is out of boundaries, useful to know when to hide the popper.
+ * @property {Boolean} data.hide True if the reference element is out of boundaries, useful to know when to hide the popper
* @property {HTMLElement} data.arrowElement Node used as arrow by arrow modifier
- * @property {Object} data.styles Any CSS property defined here will be applied to the popper, it expects the JavaScript nomenclature (eg. `marginBottom`)
- * @property {Object} data.arrowStyles Any CSS property defined here will be applied to the popper arrow, it expects the JavaScript nomenclature (eg. `marginBottom`)
+ * @property {Object} data.styles Any CSS property defined here will be applied to the popper. It expects the JavaScript nomenclature (eg. `marginBottom`)
+ * @property {Object} data.arrowStyles Any CSS property defined here will be applied to the popper arrow. It expects the JavaScript nomenclature (eg. `marginBottom`)
* @property {Object} data.boundaries Offsets of the popper boundaries
- * @property {Object} data.offsets The measurements of popper, reference and arrow elements.
+ * @property {Object} data.offsets The measurements of popper, reference and arrow elements
* @property {Object} data.offsets.popper `top`, `left`, `width`, `height` values
* @property {Object} data.offsets.reference `top`, `left`, `width`, `height` values
* @property {Object} data.offsets.arrow] `top` and `left` offsets, only one of them will be different from 0