Neutrino Packing Machine

    class-list-builder

    1.1.0 • Public • Published

    Class List Builder

    npm npm bundle size (minified) npm

    🏗 A simpler class list builder

    Use

    classListBuilder('Build', 'class lists', true && 'without', 'fear')
    // -> 'Build class lists without fear'

    Why

    Jed Watson's classnames library is pretty much the industry standard for building a list of class names. Definitely check that out if you haven't already.

    This library serves as an alternative with a simpler API for conditional classes. Instead of building dynamic keys on passed objects, you can use a simple && binary to pass the class if the condition is true.

    Install

    npm install class-list-builder
    # or 
    yarn add class-list-builder

    API

    Import or require the default function exported from class-list-builder, then call and pass the desired class names as arguments:

    classListBuilder('one', 2, 'three', 4)
    // -> 'one 2 three 4'

    Arguments at evaluate to false are removed from the output:

    classListBuilder(0, 'one', undefined, 'three')
    // -> 'one three'

    This means you can use conditions in the passed arguments to selectively add classes:

    let time = 1
     
    classListBuilder('book', time < 1 && '--due')
    // -> 'book'
     
    time = 0
     
    classListBuilder('book', time < 1 && '--due')
    // -> 'book --due'

    Examples

    React

    import React from 'react'
    import classListBuilder from 'class-list-builder'
     
    export default function ToggleButton(props) {
        const [isOn, toggle] = useToggle() // A basic custom hook
        return (
            <button
                className={classListBuilder('ToggleButton', isOn && 'ToggleButton--on')}
                onClick={toggle}
                {...props}
            >
                ToggleButton
            </button>
        )
    }

    LICENSE

    MIT

    Install

    npm i class-list-builder

    DownloadsWeekly Downloads

    2

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    4.42 kB

    Total Files

    4

    Last publish

    Collaborators

    • seanmcp