Noncommital Premarital Mischief
    Have ideas to improve npm?Join in the discussion! »

    preferable

    1.0.1 • Public • Published

    preferable

    preferable lets you manage preferences for your website with an easy to use API.

    NPM version Known Vulnerabilities npm NPM downloads issues license Gitter

    Table of contents

    Install

    To install preferable, you can use:

    $ npm install preferable

    Usage

    preferable is an ES6 module so to use it, you have to first import it and then create a new instance of it like so:

    // Webpack
    import preferable from 'preferable';
     
    // Browser
    import preferable from './path/to/preferable.js';
     
    const preferable = new preferable('myapp');

    If you're using webpack, you can just require it like any other module:

    require('preferable');

    Initialization

    preferable takes one parameter when being initialized, and that's the namespace that should be used for the localStorage key it will save preferences under.

    By default, preferable will use the 'preferable' namespace but if you are concerned about collisions with other localStorage data you may have, you can choose a custom namespace on initialization.

    // Default settings on initialization, use namespace 'preferable'
    const preferable = new preferable();
    // Use a custom namespace of 'myapp'
    const preferable = new preferable('myapp');

    Properties

    namespace

    Returns the name of the namespace set for this instance of preferable.

    const preferable = new preferable('myapp');
     
    console.log(preferable.namespace); // myapp

    API

    Currently preferable just has methods to create and toggle a toggleable preference but more ways to manage user preferences are coming soon.

    setToggle

    Sets a toggle preference that can be toggled on/off by toggle.

    Param Type Description Default
    name string Sets a preference that can toggle one or more classes on an element.
    element string The identifier to use to query for the element.
    classes string or Array One or more classes to toggle for the element defined above.
    const preferable = new preferable('myapp');
     
    preferable.setToggle('dark-mode', '#body', 'theme--dark');

    toggle

    Sets off a toggle preference by name.

    Param Type Description Default
    name string The name of the preference to toggle.
    const preferable = new preferable('myapp');
     
    preferable.setToggle('dark-mode', '#body', 'theme--dark');
     
    preferable.toggle('dark-mode');

    clear

    Clears all preferences set.

    preferable.clear();

    Tests

    To run the available tests for preferable, you can use:

    $ npm run test

    License

    MIT

    Install

    npm i preferable

    DownloadsWeekly Downloads

    6

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    44.6 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar