@notonthehighstreet/toolkit

A toolkit for development of front end apps at NOTHS

Stats

StarsIssuesVersionUpdatedCreatedSize
@notonthehighstreet/toolkit
0.0.154 years ago4 years agoMinified + gzip package size for @notonthehighstreet/toolkit in KB

Readme

npm version

Noths Toolkit

Installation

npm install @notonthehighstreet/toolkit --save

Usage

Import

There are two ways to import the function you need.

Import specific function

You can import just the specific function you need which means you won't require the whole toolkit module.

import colour from '@notonthehighstreet/toolkit/utils/colour';

colour('colour name')

Import whole toolkit

You can import the whole toolkit and use the functions from the toolkit object.

import toolkit from '@notonthehighstreet/toolkit';

toolkit.colour('colour name')

Utils

You can import multiple utils by deconstructing:

import { colour, fontSize } from '@notonthehighstreet/toolkit/utils'

colour(colourName)

import colour from '@notonthehighstreet/toolkit/utils/colour';

colour('venice-blue') // => #056582

List of availiable colours

fontSize(size)

import fontSize from '@notonthehighstreet/toolkit/utils/fontSize';

fontSize('m') // => 16px

List of available font sizes

breakpoint(deviceType)

import breakpoint from '@notonthehighstreet/toolkit/utils/breakpoint';

breakpoint('mobile') // => 480

List of available breakpoints

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.