You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59 lines
2.2 KiB
59 lines
2.2 KiB
10 years ago
|
Classnames
|
||
|
|
===========
|
||
|
|
|
||
|
|
A simple javascript utility for conditionally joining classNames together.
|
||
|
|
|
||
|
|
Install with npm, or download the [UMD version](http://wzrd.in/standalone/classnames@1) (provides window.classnames, or defines the AMD modules 'classnames').
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install classnames
|
||
|
|
```
|
||
|
|
|
||
|
|
The `classNames` function takes any number of arguments which can be a string or object.
|
||
|
|
The argument `'foo'` is short for `{foo: true}`. If the value of the key is falsy, it won't be included in the output.
|
||
|
|
|
||
|
|
```js
|
||
|
|
classNames('foo', 'bar'); // => 'foo bar'
|
||
|
|
classNames('foo', { bar: true }); // => 'foo bar'
|
||
|
|
classNames({ foo: true }, { bar: true }); // => 'foo bar'
|
||
|
|
classNames({ foo: true, bar: true }); // => 'foo bar'
|
||
|
|
|
||
|
|
// lots of arguments of various types
|
||
|
|
classNames('foo', { bar: true, duck: false }, 'baz', { quux: true }) // => 'foo bar baz quux'
|
||
|
|
|
||
|
|
// other falsy values are just ignored
|
||
|
|
classNames(null, false, 'bar', undefined, 0, 1, { baz: null }, ''); // => 'bar 1'
|
||
|
|
```
|
||
|
|
|
||
|
|
Arrays will be recursively flattened as per the rules above:
|
||
|
|
|
||
|
|
```js
|
||
|
|
var arr = ['b', { c: true, d: false }];
|
||
|
|
classNames('a', arr); // => 'a b c'
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
(The MIT License)
|
||
|
|
|
||
|
|
Copyright (c) 2015 Jed Watson
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
||
|
|
a copy of this software and associated documentation files (the
|
||
|
|
'Software'), to deal in the Software without restriction, including
|
||
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
||
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||
|
|
permit persons to whom the Software is furnished to do so, subject to
|
||
|
|
the following conditions:
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be
|
||
|
|
included in all copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||
|
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|