Package Exports
- detect-element-overflow
- detect-element-overflow/dist/cjs/index.js
- detect-element-overflow/dist/esm/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (detect-element-overflow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Detect-Element-Overflow
A function that tells you whether a given element is overflowing its container or not. Useful for creating dropdowns and tooltips.
tl;dr
- Install by executing
npm install detect-element-overfloworyarn add detect-element-overflow. - Import by adding
import detectElementOverflow from 'detect-element-overflow'. - Do stuff with it!
const collisions = detectElementOverflow(child, parent);
User guide
Detect-Element-Overflow returns an object with getter functions described below.
| Attribute name | Description | Example values |
|---|---|---|
| collidedTop | Whether or not the child element collided with the top parent's border. | true |
| collidedBottom | Whether or not the child element collided with the bottom parent's border. | true |
| collidedLeft | Whether or not the child element collided with the left parent's border. | true |
| collidedRight | Whether or not the child element collided with the right parent's border. | true |
| overflowTop | How many pixels of the child have crossed the top parent's border. Negative values specify how many pixels are between the child and the top parent's border. | 20, -15 |
| overflowBottom | How many pixels of the child have crossed the bottom parent's border. Negative values specify how many pixels are between the child and the bottom parent's border. | 20, -15 |
| overflowLeft | How many pixels of the child have crossed the left parent's border. Negative values specify how many pixels are between the child and the left parent's border. | 20, -15 |
| overflowRight | How many pixels of the child have crossed the right parent's border. Negative values specify how many pixels are between the child and the right parent's border. | 20, -15 |
License
The MIT License.
Author
|
Wojciech Maj kontakt@wojtekmaj.pl https://wojtekmaj.pl |