tailwindcss-containment v0.2.0

tailwindcss-containment

A tailwindcss plugin for css containment properties including contain, content-visibility and contain-intrinsic-size.

Installation

npm i tailwindcss-containment

Or

pnpm add tailwindcss-containment

yarn add tailwindcss-containment

Then add the plugin to tailwind.config.js:

// tailwind.config.js
/** @type {import('tailwindcss').Config} */
module.exports = {
    plugins: [
        require('tailwindcss-containment'),
        // ...
    ]
}

Usage

contain

There are 7 classes for contain property. Each of them stands for one keyword value.

If you need multiple keywords value, you can use arbitrary value. For example, contain-[layout_style] for contain: layout style;. (Note that underscore _ stands for a space in tailwindcss convention)

content-visibility

There are 3 classes for content-visibility property: content-auto, content-visible, content-hidden.

if you need to use arbitrary value, you should use content-visibility-[...] instead of content-[...] (for example, content-visibility-[initial]). Since there is already a content utility class for pseudo-elements in tailwindcss.

contain-intrinsic-size

There are 5 properties to control the intrinsic size of an element in css containment.

The possible values are the same expect for the contain-intrinsic-size property. Take contain-intrinsic-width as an example, we use intrinsic-w-{number} or intrinsic-w-px for a fixed length. Besides, we use intrinsic-w-auto-{number} or intrinsic-w-auto-px for auto <length> (for example, intrinsic-w-auto-1 for contain-intrinsic-width: auto 0.25rem;). Plus, There is a keyword value none, which is used by intrinsic-w-none

Arbitrary values are supported as well. For example, intrinsic-w-[120px] for contain-intrinsic-width: 120px;. (Note that you should use intrinsic-h-[auto_120px] instead of intrinsic-h-auto-[120px] for auto <lenght>.)

As for the contain-intrinsic-size property, it is a shorthand for contain-intrinsic-width and contain-intrinsic-height. It takes single <length> (intrinsic-) and auto <length> (intrinsic-auto-) similar to other properties, adjusting both width and length at the same time. If you want to adjust width and length respectively, you should use arbitrary values. For example, intrinsic-[1000px_300px], intrinsic-[auto_1000px_auto_300px], etc.

The full list of length number is similar to tailwindcss width. (Use intrinsic-w- for example.)

Compatibility

CSS containment brings progressive performance improvements for websites, which means it won't affect the website even if the browser does not support css containment. Nevertheless, there could be problems in some browsers only have partial support for css containment. contain property is supported by all modern browsers, but content-visibility and contain-intrinsic-size are not. This plugin does not provide polyfills for them (css containment is hard to polyfill in fact). Therefore, developer should handle those properties carefully.

Acknowledgment

If you found it useful somehow, I would be grateful if you could leave a star in the project's GitHub repository.

Thank you.