tailwindcss-fl weekly downloads statistics

tailwindcss-fl

TailwindCSS plugin to generate fluid utility classes by leveraging existing config.

Motivation

• Increase productivity by writing less markup • Increase readability with more concise class lists • Increase consistency by using ratios to scale down • Enable smooth scaling between sizes rather than sizes jumping between breakpoints

Media query classes

Fluid classes

Installation

Add to tailwind.config.js

Utilities

Out the box, the following classes are generated.

Key | Classes

fontSize | fl:text-{ keys } margin | fl:{ m, mt, mr, mb, ml, mx, my, -m, -mt, -mr, -mb, -ml, -mx, -my }-{ keys } padding | fl:{ p, pt, pr, pb, pl, px, py }-{ keys } space | fl:{ space-x, space-y }-{ keys } gap | fl:gap-{ keys } width | fl:w-{ keys } maxWidth | fl:max-w-{ keys } height | fl:h-{ keys } top/right/bottom/left/inset | fl:{top, right, bottom, left, inset, -top, -right, -bottom, -left, -inset}-{ keys } borderWidth | fl:border-{t, r, b, l}-{ keys } borderRadius | fl:rounded-{ keys }

Custom classes defined in tailwind.config.js under theme: {} will be used to generate the fluid utility classes.

List of generated classes using the default provided by tailwind

Config

Below is the full default config.

Option | Type | Description

prefix | String | Class name prefix for fluid classes. separator | String | Class name sepator for fluid classes. defaultRatio | Number | Scale down using golden ratio 1.618. screenMin | Array | Screen size to scale from. screens.{key} or custom rem/px value. screenMax | Array | Screen size to scale to. screens.{key} or custom rem/px value. rootRem | Number | 1rem is equal to 16px. Default should work for most cases. clamp | Boolean | Enable the use of clamp() to avoid using media queries. extend | Boolean or Array | Extend existing class values, or provide an array of keys to extend, ['margin', 'padding']. variants | Array | Tailwind variants, not recommended. theme | Object | Detailed in depth below.

Theme

theme: { } allows for more fine-tuned control of fluid classes.

Using defaultRatio only

Define a defaultRatio to be applied to all classes under a specific key.

The default ratios are applied to classes fl:max-w-{ keys } and fl:{ p, pt, pr, pb, pl, px, py }-{ keys }

List of generated classes with properties and ratios

Using defaultRatio and/or a custom config

For more control, a config object can be used to target specific utility classes, the same way tailwind does.

This is especially useful for fontSize because smaller font sizes should not scale down much.

Class names can be grouped for the same ratio.

The custom ratios are applied to classes fl:text-{ keys }

List of generated classes with properties and ratios

Passing an array to custom config

The power of the plugin is extending existing utilities using ratios.

However, an array of [min, max, screenMin, screenMax] can also be passed, either to overwrite an existing class, or to create a new custom class.

Parameters are based on postcss-range-value.

Param | Type | Description

min(required) | String or Number | rem/px value or a scale down ratio max(required) | String or Number | rem/px value or a scale up ratio screenMin | String | screens.{key} or rem/px value screenMax | String | screens.{key} or rem/px value

Some examples below

The custom values are added to classes fl:max-w-{ keys }

List of generated classes with properties and ratios

Fin

Feature requests, questions, hatemail? @ the person who has already spent too much time building this.

Description from the npm listing.