Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 1.31 KB

README.md

File metadata and controls

72 lines (56 loc) · 1.31 KB

tailwindcss-square

A plugin that provides utilities for visually rendering square containers.

Installation

Install the plugin from npm:

# Using npm
npm install tailwindcss-square

# Using Yarn
yarn add tailwindcss-square

Then add the plugin to your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  theme: {
    // ...
  },
  plugins: [
    require('tailwindcss-square'),
    // ...
  ],
}

Usage

Use the square-{n} utilities to specify the size of the square

<div class="square-15"></div>
<button class="square-30"></button>
<i class="square-45"></i>

Utilities for 3 square containers are generated by default:

Class CSS
square-15 width: 15px;
height: 15px;
min-width: 15px;
square-30 width: 30px;
height: 30px;
min-width: 30px;
square-45 width: 30px;
height: 30px;
min-width: 30px;

Configuration

You can configure which values and variants are generated by this plugin under the square key in your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  theme: {
    extend: {
      square: {
        5: '5px',
        10: '10px',
        20: '20px',
        25: '25px',
      }
    }
  },
  variants: {
    square: ['responsive', 'hover']
  }
}