Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.28 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.28 KB

@zestia/position-utils

Utils for determining the position of an element within another element, and positioning elements near other elements. Note that 'auto' positioning is intentionally not part of this library.

Installation

npm install --save-dev @zestia/position-utils

Add the following to ~/.npmrc to pull @zestia scoped packages from Github instead of NPM.

@zestia:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<YOUR_GH_TOKEN>

getPosition

Returns where element is considered to be positioned inside container, based on a bounding box created by splitting the container into columns and rows.

Examples

// Get position of element inside container, could be in 1 of 9 possible positions
getPosition(element, container, 3, 3);
// As above, but with edge positions less likely to be considered
getPosition(element, container, 5, 5);

getCoords

Returns the coordinates required to place element at position, on the outside edge of reference.

Example

// Get coords to position element at the bottom left of reference
getCoords('bottom left', element, reference);