https://github.com/atomita/clsnm
A utility function for generating a string for use as a DOM element's `className`.
https://github.com/atomita/clsnm
class classes classlist classname classnames
Last synced: about 1 year ago
JSON representation
A utility function for generating a string for use as a DOM element's `className`.
- Host: GitHub
- URL: https://github.com/atomita/clsnm
- Owner: atomita
- License: mit
- Created: 2019-06-22T15:52:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-02T12:43:50.000Z (almost 7 years ago)
- Last Synced: 2025-02-26T03:35:18.622Z (over 1 year ago)
- Topics: class, classes, classlist, classname, classnames
- Language: TypeScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clsnm
A utility function for generating a string for use as a DOM element's `className`.
## Install
```
$ npm install --save clsnm
```
## Usage
```js
import clsnm from 'clsnm'
clsnm({ foo: true, bar: false })
//=> foo
clsnm({ foo: { bar: false } })
//=> foo
clsnm({ foo: { bar: true, baz: true } })
//=> foobar foobaz
clsnm({ foo: true, bar: { _baz: true } })
//=> foo bar_baz
clsnm({ foo: { Bar: { Baz: true } } }, v => v.replace(/[A-Z]/g, v => v.toLowerCase()))
//=> foo-bar-baz
```
## License
clsnm is MIT licensed. See [LICENSE](LICENSE.md).