# react-dump

> A visual debugging component for React

Latest version **0.3.3** (published 2020-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-dump
pnpm add react-dump
yarn add react-dump
bun add react-dump
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.3 |
| Published | 2020-08-23 |
| First published | 2016-12-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 26.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mitchell M. Rose |
| Maintainers | mrose |
| Keywords | debug, react, react-component, dump, variable, log, cfdump, nodedump |

## Links

- npm: https://www.npmjs.com/package/react-dump
- Repository: https://github.com/mrose/react-dump
- Homepage: https://github.com/mrose/react-dump#readme
- Issues: https://github.com/mrose/react-dump/issues
- npm.io page: https://npm.io/package/react-dump

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^16.13.1
- [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.15
- [react-dom](https://npm.io/package/react-dom.md) ^16.13.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.3.3 (latest) — 2020-08-23
- 0.3.2 — 2020-08-23
- 0.3.1 — 2020-07-23
- 0.3.0 — 2017-05-17
- 0.2.0 — 2017-02-13
- 0.1.11 — 2017-01-30
- 0.1.10 — 2017-01-26
- 0.1.9 — 2017-01-25
- 0.1.8 — 2017-01-25
- 0.1.7 — 2017-01-20
- 0.1.5 — 2016-12-09
- 0.1.4 — 2016-12-09
- 0.1.3 — 2016-12-09
- 0.1.2 — 2016-12-09
- 0.1.0 — 2016-12-09

## README

# react-dump

[![NPM](https://nodei.co/npm/react-dump.png?downloads=true)](https://nodei.co/npm/react-dump/)

A visual debugging component for React.
Outputs any variable in an easy to read format based on ColdFusion's CFDUMP tag.

Better than `console.log` (recurses fully).
Less complex than React Developer Tools.
Sometimes visualizing a complex object makes it easier to think about.
For example, ```<ReactDump obj={user} />``` might yield:

![Reactdump example](https://raw.github.com/ragamufin/nodedump/master/images_for_readme/nodedump-user.png "Reactdump of variable 'user'")

Inspired in part by Andrew Hewitt's [nodedump](https://github.com/ragamufin/nodedump)

Install
-------
[sudo] npm install react-dump --save-dev

Usage
-----
Import to your component:

```import {Dump} from 'react-dump';```

Include within your component's render() method, passing the object and optional arguments

```<Dump obj={user} />```

License
-------
MIT

Contributing
------------
Pull requests welcome with accompanying tests

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