Tailwind clamp 🗜️

Leverage the the CSS clamp function in your Tailwind CSS project.

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.
• Supports text values with multiple properties (fontSize, lineHeight, letterSpacing). If lineHeight is definded as a unitless number or a calc() function, the resulting value is calculated and converted to the fontSize unit.
• Supports using Tailwind CSS theme values, arbitrary values or a combination.
• Supports container queries.

Requirements

The current version of the plugin is designed to be used with Tailwind version 4. To use it with version 3 use version 3.x.

Installation

Install the plugin from npm:

npm i tailwind-clamp

Add the plugin in your main CSS file:

@import "tailwindcss";
@plugin "tailwind-clamp";

Configuration

The plugin allows two configuration options:

| Name | Type | Description | Default value | | ------------- | ---------- | ------------------------------------- | ------------- | | minSize | {string} | Viewport size where the clamp starts. | 23.4375rem | | maxSize | {string} | Viewport size where the clamp end. | 90rem |

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

@import "tailwindcss";
@plugin "tailwind-clamp" {
  minSize: 25rem;
  maxSize: 80rem;
}

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 minSize and the maxSize:

clamp-[<property>,<start>,<end>,[minSize,maxSize]]

Arguments

• property Property that the value should be applied to. See a list of all supported properties below.
• start Value at minSize viewport size. It can be a key from your Tailwind CSS config file or a a css length (px, rem, em), the unit will need to match end.
• end Value at maxSize viewport size. It can be a key from your Tailwind CSS config file or a css length (px, rem, em), the unit will need to match start.
• [minSize=23.4375rem] Viewport or container size, where the clamp starts, defaults to 23.4375rem (375px). It can be a breakpoint or container size name from your theme or a css length (px, rem, em). Container size names and values are prefixed with @. The unit will need to match maxSize and be smaller than maxSize.
• [maxSize=90rem] Viewport or container size, where the clamp stops, defaults to 90rem (1440px). It can be a breakpoint or container size name from your theme or a css length (px, rem, em). Container size names and values are prefixed with @. The unit will need to match minSize and be be larger than minSize.

Examples

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

<div class="@container">
  <div class="clamp-[text,lg,3xl,@sm,@5xl] clamp-[py,2,4,@29.5rem,@82rem]">
    Add some fluid typography and padding to the content of the container.
  </div>
</div>

Note on spacing and sizing properties

All spacing and sizing properties (p, m, w, etc.) accept unitless numbers and .5 floating numbers that will get multiplied by the --spacing variable, analog to how Tailwind CSS handles spacing values.

<div class="clamp-[p,1,2]">
  This will generate a `padding` value of `1rem` at `minSize` and `2rem` at `maxSize`.
</div>

Supported properties

• p including pt, pb, pl, pr, px, py, ps, pe.
• m including mt, mb, ml, mr, mx, my, ms, me.
• inset including inset-x, inset-y.
• top
• left and start.
• right and end.
• bottom
• text including font-size, line-height and letter-spacing if defined.
• gap including gap-x, gap-y.
• w
• h
• size
• min-w and min-h
• max-w and max-h
• rounded including rounded-s, rounded-ss, rounded-se, rounded-e, rounded-ee, rounded-es, rounded-t, rounded-r, rounded-b, rounded-l, rounded-tl, rounded-tr, rounded-bl, rounded-br.
• translate-x and translate-y
• text-stroke
• stroke
• leading
• tracking
• border including border-t, border-b, border-l, border-r, border-x, border-y.
• scroll-m including scroll-mx, scroll-my, scroll-ms, scroll-me, scroll-mt, scroll-mb, scroll-ml, scroll-mr
• scroll-p including scroll-px, scroll-py, scroll-ps, scroll-pe, scroll-pt, scroll-pb, scroll-pl, scroll-pr
• decoration
• underline-offset

Credits & mentions

The plugin is based on the formula presented in this article.

See also fluid.tw by Max Barvian.

License

MIT