2.0.2 • Published 4 months ago
brandeur-plugin-debug v2.0.2
brandeur-plugin-debug
Adds deubg styles to elements for simple layout debugging. Uses styles-debugger under the hood.
Installation
# npm
npm i --save brandeur-plugin-debug
# yarn
yarn add brandeur-plugin-debug
# pnpm
pnpm add brandeur-plugin-debug
Usage
import debug from 'brandeur-plugin-debug'
const plugin = debug()
Configuration
Parameter | Type | Default | Description |
---|---|---|---|
autoActive | boolean | true | Whether debug styles are active globally |
config | Config | Custom styles-debugger configuration |
When autoActive
is disabled, one can opt-in by passing debug: true
in a style object.
import debug from 'brandeur-plugin-debug'
const plugin = debug(false, {
debugWith: 'background',
})
License
Brandeur is licensed under the MIT License. Documentation is licensed under Creative Commons License. Created with ♥ by @robinweser.