# tailwindcss-square

> A plugin that provides utilities for visually rendering square containers.

Latest version **0.0.2** (published 2021-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install tailwindcss-square
pnpm add tailwindcss-square
yarn add tailwindcss-square
bun add tailwindcss-square
```

## 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.0.2 |
| Published | 2021-06-11 |
| First published | 2021-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Anders Nielsen |
| Maintainers | andersnielsen |
| Keywords | tailwind, tailwindcss, plugin, tailwindcss-plugin |

## Links

- npm: https://www.npmjs.com/package/tailwindcss-square
- Repository: https://github.com/AndersNielsen85/tailwindcss-square
- Homepage: https://github.com/AndersNielsen85/tailwindcss-square#readme
- Issues: https://github.com/AndersNielsen85/tailwindcss-square/issues
- npm.io page: https://npm.io/package/tailwindcss-square

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads
- [@modern-js/plugin-swc](https://npm.io/package/@modern-js/plugin-swc.md) — 3.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2021-06-11
- 0.0.1 — 2021-06-11

## README

# tailwindcss-square

A plugin that provides utilities for visually rendering square containers.


## Installation

Install the plugin from npm:

```sh
# Using npm
npm install tailwindcss-square

# Using Yarn
yarn add tailwindcss-square
```

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

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

## Usage

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

```html
<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;`<br>`height: 15px;`<br>`min-width: 15px;` |
| `square-30` |  `width: 30px;`<br>`height: 30px;`<br>`min-width: 30px;` |
| `square-45` |  `width: 30px;`<br>`height: 30px;`<br>`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:

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

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