# obj-str

> A tiny library for serializing Object values to Strings.

Latest version **1.1.0** (published 2021-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install obj-str
pnpm add obj-str
yarn add obj-str
bun add obj-str
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-03-27 |
| First published | 2017-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 255 |
| Author | Luke Edwards |
| Maintainers | lukeed |
| Keywords | react, preact, classes, classname, classnames, object, object-keys, object-string, object-values, serialize |

## Links

- npm: https://www.npmjs.com/package/obj-str
- Repository: https://github.com/lukeed/obj-str
- Homepage: https://github.com/lukeed/obj-str#readme
- Issues: https://github.com/lukeed/obj-str/issues
- npm.io page: https://npm.io/package/obj-str

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-03-27
- 1.0.3 — 2019-01-11
- 1.0.2 — 2018-12-25
- 1.0.1 — 2018-08-27
- 1.0.0 — 2017-04-09

## README

# obj-str [![CI](https://github.com/lukeed/obj-str/workflows/CI/badge.svg)](https://github.com/lukeed/obj-str/actions) [![codecov](https://badgen.net/codecov/c/github/lukeed/obj-str)](https://codecov.io/gh/lukeed/obj-str)

> A tiny (96B) library for serializing Object values to Strings.

This module's intended use is for converting an Object with CSS class names (as keys) to a space-delimited `className` string. Other modules have similar goals (like [`classnames`](https://npm.im/classnames)), but `obj-str` only does one thing. This is why it's only 100 bytes gzipped!

_PS: I made this because [Preact 8.0 removed this built-in behavior](https://github.com/developit/preact/commit/b2c85e3f7fa89ebbf242b00f4cab7619641e3a52) and I wanted a quick, drop-in replacement._

## Install

```
$ npm install --save obj-str
```


## Usage

```js
import objstr from 'obj-str';

objstr({ foo:true, bar:false, baz:isTrue() });
//=> 'foo baz'
```

### React

With React (or any of the React-like libraries!), you can take advantage of any `props` or `state` values in order to express conditional classes as an object.

```js
import React from 'react';
import objstr from 'obj-str';

const TodoItem = ({ text, isDone, disabled }) => (
  <li className={ objstr({ item:true, completed:isDone, disabled }) }>
    <input type="checkbox" disabled={ disabled } checked={ isDone } />
    <label>{ text }</label>
  </li>
);
```

### Preact

For simple use, the [React](#react) example will work for Preact too. However, you may also define a custom vNode "polyfill" to automatically handle Objects when used inside `className`.

> **Note:** For users of Preact 7.1 and below, _you do not need this module_! Your version includes this behavior out of the box!

```js
import objstr from 'obj-str';
import { options } from 'preact';

const old = options.vnode;

options.vnode = vnode => {
  const props = vnode.attributes;
  if (props != null) {
    const k = 'class' in props ? 'class' : 'className';
    if (props[k] && typeof props[k]=='object') {
      props[k] = objstr(props[k]);
    }
  }
  old && old(vnode);
}
```


## API

### objstr(input)

#### input

Type: `Object`

A hashmap of keys & their truthy/falsey values. Booleans are preferred when speed is critically important.


## Related

- [babel-plugin-optimize-obj-str](./babel-plugin-optimize-obj-str) - Babel plugin to transform `obj-str` calls into optimized expressions.

- [clsx](https://github.com/lukeed/clsx) - Drop-in replacement for `obj-str` and `classnames` – handles all (and multiple) input types.


## License

MIT © [Luke Edwards](http://lukeed.com)

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