# @neojp/tailwindcss-aspect-ratio-utilities

> Tailwind CSS aspect ratio utilities

Latest version **1.0.1** (published 2020-05-24) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install @neojp/tailwindcss-aspect-ratio-utilities
pnpm add @neojp/tailwindcss-aspect-ratio-utilities
yarn add @neojp/tailwindcss-aspect-ratio-utilities
bun add @neojp/tailwindcss-aspect-ratio-utilities
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-05-24 |
| First published | 2019-12-05 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Joan Piedra |
| Maintainers | neojp |
| Keywords | tailwindcss, tailwindcss-plugin, tailwindcss-utilities, tailwindcss-utility, tailwindcss-aspect-ratio, tailwindcss-aspect-ratio-utilities, aspect-ratio-utilities, aspect-ratio, 3:2, 2:3, 4:3, 5:6, 16:9, 21:9, 3x2, 2x3, 4x3, 5x6, 16x9, 21x9, 3/2, 2/3, 4/3, 5/6, 16/9, 21/9, css |

## Links

- npm: https://www.npmjs.com/package/@neojp/tailwindcss-aspect-ratio-utilities
- Repository: https://github.com/neojp/tailwindcss-aspect-ratio-utilities
- Homepage: https://github.com/neojp/tailwindcss-aspect-ratio-utilities#readme
- Issues: https://github.com/neojp/tailwindcss-aspect-ratio-utilities/issues
- npm.io page: https://npm.io/package/@neojp/tailwindcss-aspect-ratio-utilities

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K 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

## Recent versions

- 1.0.1 (latest) — 2020-05-24
- 1.0.0 — 2019-12-05

## README

<p align="center">
    <a href="https://tailwindcss.com/" target="_blank"><img width="200" src="https://tailwindcss.com/img/tailwind.svg"></a><br>
    A utility-first CSS framework for rapidly building custom user interfaces.
</p>

---

<br>

# Tailwind CSS aspect ratio utilities

This is a Tailwind CSS plugin that adds an utilities for restrict an element with a set [aspect ratio](https://css-tricks.com/aspect-ratio-boxes/) **based on the parent's element's width**.

Maintained by: [Joan Piedra](https://joanpiedra.com) → [@neojp](https://twitter.com/neojp)

## Installation

Install as a node module with either `npm` or `yarn` on your command line

```bash
# Install via npm
npm install --save-dev @neojp/tailwindcss-aspect-ratio-utilities

# Install via yarn
yarn add --dev @neojp/tailwindcss-aspect-ratio-utilities
```

Add this module as a plugin on your [Tailwind configuration file](https://tailwindcss.com/docs/configuration#plugins) (`tailwind.config.js`).

```js
module.exports = {
  plugins: [
      require('@neojp/tailwindcss-aspect-ratio-utilities')
  ]
};
```

### Variants

Note that this plugin allows the usage of variants through the key `aspectRatio` and will default to your global variant setting.

```js
module.exports = {
  variants: {
    aspectRatio: ['responsive']
  }
};
```


## Usage

Use the Tailwind utility classes provided by this plugin.

```html

<div class="aspect-ratio-square"></div>
<div class="aspect-ratio-3/2"></div>
<div class="aspect-ratio-2/3"></div>
<div class="aspect-ratio-4/3"></div>
<div class="aspect-ratio-5/6"></div>
<div class="aspect-ratio-16/9"></div>
<div class="aspect-ratio-21/9"></div>

```

### Examples

Draw a gray 256px square box:

```html
<div class="bg-gray-500 w-64">
  <div class="aspect-ratio-square"></div>
</div>
```

Restrict an image to a 4/3 aspect ratio:

```html
<div class="bg-gray-500 relative w-64">
  <div class="aspect-ratio-4/3"></div>
  <img class="absolute h-full left-0 object-cover top-0 w-full" src="https://images.unsplash.com/photo-1575470066032-42f6bce0c7fb?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=300&q=80" alt="Unsplash stock image by Josh Hild">
</div>
```

Embed a YouTube video and restrict it to an aspect ratio of 16/9:

```html
<div class="bg-gray-400 mx-auto relative w-1/2">
  <div class="aspect-ratio-16/9"></div>
  <iframe class="absolute h-full left-0 top-0 w-full" width="560" height="315" src="https://www.youtube.com/embed/21HuwjmuS7A" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
```

## Output

Tailwind will be outputed as follows.

```css
.aspect-ratio-square { padding-top: 100%; }
.aspect-ratio-3\/2   { padding-top: 66.66666666666667%; }
.aspect-ratio-2\/3   { padding-top: 150%; }
.aspect-ratio-4\/3   { padding-top: 75%; }
.aspect-ratio-5\/6   { padding-top: 120%; }
.aspect-ratio-16\/9  { padding-top: 56.25%; }
.aspect-ratio-21\/9  { padding-top: 42.86%; }
```

## Related plugins

Shout out to [tailwindcss-aspect-ratio](https://github.com/webdna/tailwindcss-aspect-ratio) another plugin that attemps to handle aspect ratios on Tailwind CSS.

## Contributing

Feel free to submit a PR request, and send me a message on Twitter ([@neojp](https://twitter.com/neojp)) about it.

## License
This project has been licensed under [the Hippocratic License](https://firstdonoharm.dev/).

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