reakit-warning

reakit-warning

This is experimental and may have breaking changes in minor versions.

Installation

npm:

npm i reakit-warning

Yarn:

yarn add reakit-warning

Reducing bundle size

Literal strings aren't minified. Keeping them in your production bundle may increase the bundle size significantly.

To prevent that, you should:

1. Put reakit-warning/babel-plugin into your babel config.

   This will make sure your warning and useWarning calls are wrapped within a condition that checks if process.env.NODE_ENV !== 'production'.

2. Use UglifyJS, Terser or any other JavaScript parser that performs dead code elimination. This is usually used in conjunction with JavaScript bundlers, such as webpack.

   When parsing the code in production mode, the warning call will be removed altogether.

API

Table of Contents

• useWarning
• warning

useWarning

Logs messages to the console using console.warn based on a condition. This should be used inside components.

Parameters

• condition boolean
• messages ...Array<any>

warning

Logs messages to the console using console.warn based on a condition.

Parameters

• condition boolean
• messages ...Array<any>

Examples

import { warning } from "reakit-warning";

warning(true, "a", "b"); // console.warn("a", "\n", "b")
warning(false, "a", "b"); // does nothing

License

MIT © Diego Haz