Tailwind clamp

Tailwind CSS plugin to use CSS clamp in your project. Enabling fluid interfaces using Tailwind syntax.

The plugin is based on the formula presented in this article

Features

• Clamp values between a min and max viewport width, making it grow / shrink with the viewport.
• Possibility to use small to large, large to small, negative to positive, positive to negative and negative to negative values. (Negative values only work on properties that allow them, e.g. margin)
• Supports px, rem and em units.
• Support text values with multiple properties (fontSize, lineHeight, letterSpacing).
• Supports using values defined in the Tailwind CSS configuration file, arbitrary values or a combination.
• Helper function to create clamped values directly in your config file.

Installation

Install the plugin from npm:

npm install nicolas-cusan/tailwind-clamp

Add the plugin in your Tailwind CSS configuration file:

// tailwind.config.js
import { tailwindClamp } from 'tailwind-clamp';

export default {
  theme: {
    // ...
  },
  plugins: [
    tailwindClamp,
    // ...
  ],
};

Configuration

The plugin allows two configuration options:

| Name | Type | Description | Default value | | ---------------------- | ------------------ | ------------------------------------- | ------------- | | minViewportWidth | {number\|string} | Viewport size where the clamp starts. | 375 | | maxViewportWidth | {number\|string} | Viewport size where the clamp end. | 1440 |

Value should be a css value (px, rem, em) or a number (unit will be px). The unit for both options need to match.

// tailwind.config.js
import { tailwindClamp } from 'tailwind-clamp';

export default {
  theme: {
    // ...
  },
  plugins: [
    tailwindClamp({
      minViewportWidth: 375,
      maxViewportWidth: 1440,
    }),
    // ...
  ],
};

Usage

The plugin relies on the arbitrary values syntax clamp-[...]. You need to pass at least three arguments separated by commas without whitespace, optionally you can also pass the minViewportWidth and the maxViewportWidth:

clamp-[<property>,<start>,<end>,[minViewportWidth,maxViewportWidth]]

Arguments

• property: Property that the value should be applied to. See a list of all supported properties below.
• start: Value at minViewportWidth viewport size. It can be a key from your Tailwind CSS config file, a css value (px, rem, em) or a number (unit will be px), the unit will need to match end.
• end: Value at maxViewportWidth viewport size. It can be a key from your Tailwind CSS config file, a css value (px, rem, em) or a number (unit will be px), the unit will need to match start.
• [minViewportWidth=375]: Viewport size, where the clamp starts, defaults to 375. Can be a key from screens a css value (px, rem, em) or a number (unit will be px), the unit will need to match maxViewportWidth. Value needs to be smaller than maxViewportWidth.
• [maxViewportWidth=1440]: Viewport size, where the clamp stops, defaults to 1440. Can be a key from screens a css value (px, rem, em) or a number (unit will be px), the unit will need to match minViewportWidth. Value needs to be larger than minViewportWidth.

Examples

<div class="clamp-[px,20,40] clamp-[py,10,18]">
  Add some fluid padding here.
</div>

Clamped values in config

The plugin includes a utility function to create clamped values directly in your config file.

// tailwind.config.js
import { tailwindClamp, clampValue } from 'tailwind-clamp';

export default {
  theme: {
    // ...
    padding: {
      'my-claped-value': clampValue(20, 40),
      'my-other-claped-value': clampValue(30, 60, {
        unit: 'px',
        maxViewportWidth: 1960,
      }),
    },
  },
  plugins: [
    tailwindClamp,
    // ...
  ],
};

Arguments

| Name | Type | Description | Default value | | -------------------------------- | --------------------- | ------------------------------------------ | ------------- | | start | {number} | Value at minViewportWidth viewport size. | | | end | {number} | Value at maxViewportWidth viewport size. | | | [options.minViewportWidth] | {number} | Viewport size, where the clamp starts. | 375 | | [options.maxViewportWidth] | {number} | Viewport size, where the clamp stops. | 1440 | | [options.unit] | {'px'\|'rem'\|'em'} | Unit that should be used in the css value. | rem |

All values are expected in pixels and will be converted to [options.unit].

Supported properties

• p including pt, pb, pl, pr, px, py.
• m including mt, mb, ml, mr, mx, my.
• inset
• top
• left
• right
• bottom
• text including font-size, line-height and letter-spacing if defined.
• gap including gap-x, gap-y.
• w
• h
• size
• min-w
• min-h
• max-w
• max-h
• rounded including rounded-t, rounded-r, rounded-b, rounded-l, rounded-tl, rounded-tr, rounded-bl, rounded-br.
• translate-x
• translate-y
• text-stroke
• stroke
• leading
• border including border-t, border-b, border-l, border-r, border-x, border-y.
• scroll-m

Roadmap

• Support directional properties e.g. ps
• Add showcase