|
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586 |
- # clsx [](https://travis-ci.org/lukeed/clsx)
-
- > A tiny (229B) utility for constructing `className` strings conditionally.<Br>Also serves as a [faster](/bench) & smaller drop-in replacement for the `classnames` module.
-
- This module is available in three formats:
-
- * **ES Module**: `dist/clsx.m.js`
- * **CommonJS**: `dist/clsx.js`
- * **UMD**: `dist/clsx.min.js`
-
-
- ## Install
-
- ```
- $ npm install --save clsx
- ```
-
-
- ## Usage
-
- ```js
- import clsx from 'clsx';
-
- // Strings (variadic)
- clsx('foo', true && 'bar', 'baz');
- //=> 'foo bar baz'
-
- // Objects
- clsx({ foo:true, bar:false, baz:isTrue() });
- //=> 'foo baz'
-
- // Objects (variadic)
- clsx({ foo:true }, { bar:false }, null, { '--foobar':'hello' });
- //=> 'foo --foobar'
-
- // Arrays
- clsx(['foo', 0, false, 'bar']);
- //=> 'foo bar'
-
- // Arrays (variadic)
- clsx(['foo'], ['', 0, false, 'bar'], [['baz', [['hello'], 'there']]]);
- //=> 'foo bar baz hello there'
-
- // Kitchen sink (with nesting)
- clsx('foo', [1 && 'bar', { baz:false, bat:null }, ['hello', ['world']]], 'cya');
- //=> 'foo bar hello world cya'
- ```
-
-
- ## API
-
- ### clsx(...input)
- Returns: `String`
-
- #### input
- Type: `Mixed`
-
- The `clsx` function can take ***any*** number of arguments, each of which can be an Object, Array, Boolean, or String.
-
- > **Important:** _Any_ falsey values are discarded!<br>Standalone Boolean values are discarded as well.
-
- ```js
- clsx(true, false, '', null, undefined, 0, NaN);
- //=> ''
- ```
-
- ## Benchmarks
-
- For snapshots of cross-browser results, check out the [`bench`](/bench) directory~!
-
- ## Support
-
- All versions of Node.js are supported.
-
- All browsers that support [`Array.isArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray#Browser_compatibility) are supported (IE9+).
-
- >**Note:** For IE8 support and older, please install `clsx@1.0.x` and beware of [#17](https://github.com/lukeed/clsx/issues/17).
-
-
- ## Related
-
- - [obj-str](https://github.com/lukeed/obj-str) - Similar utility that is faster and smaller (96B) but only works with Objects.
-
- ## License
-
- MIT © [Luke Edwards](https://lukeed.com)
|