Package Exports

dynamic-class-list

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dynamic-class-list) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dynamic-class-list

Simple, fast module for extracting strings of dynamic and optional class list.

Features:

Support for string arguments.
Support Object syntax.
Supports array of strings.
Zero-dependency.

Quickstart - CommonJS

npm install dynamic-class-list

Then require it in your module ...

const getClassNames = require('dynamic-class-list').getClassNames;

OR using ES6 imports

import { getClassNames } from 'dynamic-class-list';

API

Arguments as strings

// As Arguments
getClassNames('class1', 'class2');

// Output : "class1 class2"

Arguments as an array of strings

// As an Array
getClassNames(['class1', 'class2']);

// Output : "class1 class2"

Arguments as an object

Note that the key is used as the class if its value is truthy

// As an Object
getClassNames({class1: true, class2 : false});

// Output : "class1"

Note that the function should return a boolean

// Value as a function As an Object
getClassNames({ 
    class1: function() { return false; },
    class2 : function() { return true; }
});

// Output : "class2"

Hybrid Arguments

// using all type of data
getClassNames('class1', 'class2', ['class3', 'class4'], { 
    class5 : function() { return false; },
    class6 : function() { return true; }
});

// Output : "class1 class2 class3 class4 class6"

Markdown generated from README_js.md by