apex-utilities v1.0.1

Apex Utilities

General Utilities for quick and easy access

Installation

Install from npm

$ npm install apex-utilities

Usage

Import the functions of apex-utilities you want to use.

import { 
    chunkArray, 
    getParents,
    getSiblings,
    getSiblingsPrevNext,
    getUrlVars,
    mapKeys,
    offset,
    recalculateViewportHeight,
    removeClass,
    scrollToY, 
    show, 
    hide 
} from 'apex-utilities';

Included Utilities

Check each individual utility for usage.

chunkArray

// Expects an array and integer
// Returns the array in chunks.
chunkArray(array, size)

getParents

// Expects an element and selector
// Returns the parent that matches both.
getParents(elem, selector)

getSiblings

// Expects an element 
// Returns all the siblings elements.
getSiblings(elem)

getSiblingsPrevNext

// Expects an element and select type (prev of next) 
// Returns the sibling next or prev of the element.
getSiblingsPrevNext(element, type)

getUrlVars

// Returns the url parameters as an object
getUrlVars()

mapKeys

// Adds a variable keys with tab, enter, esc, space, left, up, right, down
keys = {
    tab: 9,
    enter: 13,
    esc: 27,
    space: 32,
    left: 37,
    up: 38,
    right: 39,
    down: 40,
}

recalculateViewportHeight

// Sets and recalculates the JS variable 'vh' and CSS variable '--vh' when window resizes
recalculateViewportHeight()

offset

// Expects an element
// Returns the offset of element to top and left of window
offset(el)

removeClass

// Expects elements and an array of classes or single class
// Removes the class(es) of element(s)
removeClass(elements, classes)

scrollToY

// @param {number} scrollTargetY the target scrollY property of the window
// @param {number} speed time in pixels per second
// @param {string} easing easing equation to use
scrollToY(scrollTargetY, speed, easing)

show / hide

// Shows the element with easing and adds class show
show(element)
// Hides the element with easing and removes class show
hide(element)

License

This project is available under the MIT license.