# @zcorky/classnames

> Conditionally joining classNames together.

Latest version **1.0.0** (published 2018-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zcorky/classnames
pnpm add @zcorky/classnames
yarn add @zcorky/classnames
bun add @zcorky/classnames
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-09-28 |
| First published | 2018-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Zero |
| Maintainers | uniquecolesmith |

## Links

- npm: https://www.npmjs.com/package/@zcorky/classnames
- Repository: https://github.com/zcorky/classnames
- Homepage: https://github.com/zcorky/classnames#readme
- Issues: https://github.com/zcorky/classnames/issues
- npm.io page: https://npm.io/package/@zcorky/classnames

## Dependencies (1)

- [@zcorky/is](https://npm.io/package/@zcorky/is.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2018-09-28

## README

# classnames

[![NPM version](https://img.shields.io/npm/v/@zcorky/classnames.svg?style=flat)](https://www.npmjs.com/package/@zcorky/classnames)
[![Coverage Status](https://img.shields.io/coveralls/zcorky/classnames.svg?style=flat)](https://coveralls.io/r/zcorky/classnames)
[![Dependencies](https://david-dm.org/@zcorky/classnames/status.svg)](https://david-dm.org/@zcorky/classnames)
[![Build Status](https://travis-ci.com/zcorky/classnames.svg?branch=master)](https://travis-ci.com/zcorky/classnames)
![license](https://img.shields.io/github/license/zcorky/classnames.svg)
[![issues](https://img.shields.io/github/issues/zcorky/classnames.svg)](https://github.com/zcorky/classnames/issues)

> Conditionally joining classNames together.

### Install

```
$ npm install @zcorky/classnames
```

### Usage

```javascript
classNames('unicorn', 'rainbow');
//=> 'unicorn rainbow'

classNames({awesome: true, foo: false}, 'unicorn', {rainbow: false});
//=> 'awesome unicorn'

classNames('unicorn', null, undefined, 0, 1, {foo: null});
//=> 'unicorn'

const buttonType = 'main';
classNames({[`button-${buttonType}`]: true});
//=> 'button-main'
```

```js
const Button = props => {
	console.log(props);
	/*
	{
		type: 'success',
		small: true
	}
	*/

	const buttonClass = classNames(
		'button',
		{
			[`button-${props.type}`]: props.type,
			'button-block': props.block,
			'button-small': props.small
		}
	);

	console.log(buttonClass);
	//=> 'button button-success button-small'

	return <button className={buttonClass}>…</button>;
};
```

### Relatived
* [classnames](https://github.com/JedWatson/classnames)
* [class-names](https://github.com/sindresorhus/class-names)

---
_Source: https://npm.io/package/@zcorky/classnames · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._