tailwindcss-breakpoint-indicator
v0.0.2
Published
A minimal Tailwind CSS plugin that displays the current breakpoint during development
Maintainers
Readme
Tailwind Breakpoint Indicator
A minimal Tailwind CSS plugin that displays the current breakpoint during development.
Demo
https://github.com/user-attachments/assets/b7b4e1d7-fc25-4d01-aef8-9fbc710b52c5
Installation
npm install tailwindcss-breakpoint-indicator
# or
yarn add tailwindcss-breakpoint-indicator
# or
pnpm add tailwindcss-breakpoint-indicatorUsage
Add the plugin to your tailwind.config.js:
module.exports = {
plugins: [
require("tailwindcss-breakpoint-indicator")({
// options are optional
indicatorPosition: "bottom-right",
indicatorBackground: "rgba(59, 130, 246, 1)",
indicatorColor: "white",
showInProduction: false,
}),
],
};Add the indicator element to your HTML:
<div class="breakpoint-indicator"></div>Options
| Option | Type | Default | Description |
| --------------------- | -------------------------------------------------------------------- | ---------------------- | ------------------------------------------- |
| indicatorPosition | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'bottom-right' | Position of the breakpoint indicator |
| indicatorBackground | string | 'rgba(0, 0, 0, 0.8)' | Background color of the indicator |
| indicatorColor | string | 'white' | Text color of the indicator |
| showInProduction | boolean | false | Whether to show the indicator in production |
Default Breakpoints
The plugin uses Tailwind's default breakpoints:
sm: 640pxmd: 768pxlg: 1024pxxl: 1280px2xl: 1536px
License
MIT
