Giter Club home page Giter Club logo

tailwindcss-container-query's Introduction

tailwindcss-container-query

A plugin that provides CSS Container Queries.

BEFORE STARTING

This plugin relies on container-query-polyfill. You must add it to make this plugin work. We have to rely on polyfills until all browsers have implemented them. see the support table

Installation

Install the plugin from npm:

# Using npm
npm install tailwindcss-container-query

# Using Yarn
yarn add tailwindcss-container-query

Then add the plugin to your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  theme: {
    // ...
  },
  plugins: [
    require('tailwindcss-container-query'),
    // ...
  ],
}

Usage

Container Queries up to 10 are generated by default:

Class Query
cq-w-4 @container (min-width: 64px)
cq-w-6 @container (min-width: 96px)
cq-w-9 @container (min-width: 144px)
cq-w-16 @container (min-width: 256px)
cq-w-22 @container (min-width: 352px)
cq-h-4 @container (min-height: 64px)
cq-h-6 @container (min-height: 96px)
cq-h-9 @container (min-height: 144px)
cq-h-16 @container (min-height: 256px)
cq-h-22 @container (min-height: 352px)

Utilities:

Class Property
container-type-size container-type: size
container-type-inline-size container-type: inline-size
container-type-block-size container-type: block-size
container-type-style container-type: style
container-type-state container-type: state

There are no any container-name utilities by default. You should define your own utilities in tailwind.config.js.

Example Usage

<div class="cq-w-6:bg-yellow-400"></div>

Output:

@container (min-width: 96px) {
  .cq-w-6\:bg-yellow-400 {
    --tw-bg-opacity: 1;
    background-color: rgb(96 165 250 / var(--tw-bg-opacity));
  }
}

You can use arbitrary variants too. (You should be using v3.1.0 or higher!)

<div class="cq-w-[238px]:bg-yellow-400"></div>

Output:

@container (min-width: 238px) {
  .cq-w-\[238px\]\:bg-yellow-400 {
    --tw-bg-opacity: 1;
    background-color: rgb(96 165 250 / var(--tw-bg-opacity));
  }
}

Using Container Names

<div class="cq-w-sb-6:bg-yellow-400"></div>
// tailwind.config.js
module.exports = {
  theme: {
    containerName: {
      sb: 'sidebar'
    },
    // ...
  }
}

Output:

@container sidebar (min-width: 96px) {
  .cq-w-sb-6\:bg-yellow-400 {
    --tw-bg-opacity: 1;
    background-color: rgb(96 165 250 / var(--tw-bg-opacity));
  }
}

Configuration

You can configure which values and variants are generated by this plugin under the containerQuery, containerType and containerName keys in your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  theme: {
    // P.S. Container Query thresholds can only be specified using pixels because of the polyfill I recommended.
    containerQuery: {
      xs: '120px',
      sm: '240px',
      md: '360px',
    },
    containerType: {
      size: 'size',
    }
  }
}

tailwindcss-container-query's People

Contributors

dgknca avatar kafkas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

tailwindcss-container-query's Issues

Query selecting the default "mobile-view" on react-route navigation.

I created a repo here where I reproduced the bug.
https://github.com/Enebz/tailwind-container-query-demo

When you are located in / press the "Go to list" button to see the problem.

On line 6 in pages/Demo.jsx, you can see the various container queries.
grid-cols-3 cq-w-sm:grid-cols-4 cq-w-md:grid-cols-5 cq-w-lg:grid-cols-6 cq-w-xl:grid-cols-7

When navigating (even on a wide screen) the grid appears with three columns, which is for the lowest screen width. When you resize the screen, it goes to the correct column-size and follows expected behaviour.

tailwindcss-container-query && Nextjs

Hi, the plugin is really cool and adopts the concept of tailwind, I really liked it
I have been trying for hours to add it to my project but I failed to do so
I encountered many errors installing Container Query Polyfill in the project
That's why the plugin didn't work for me
Is there a guide for the steps to add to a project next or react ?

Modifiers including `container-name` don't work

Hey @dgknca, Thanks for the plugin! It works fine but can't seem to get it to work with the container-name specific modifiers. I'm assuming the readme fix in #5 is correct. My setup looks like this:

<div class="... container-type-size container-name-lf">
  <div class="... cq-w-lf-xl:bg-blue-300" />
</div>
// tailwind.config.js
  theme: {
    containerName: {
      lf: 'layoutframe',
      // ...
    },
    containerQuery: {
      // ...
      lg: '480px',
      xl: '540px'
    },
  }

According to vscode intellisense, the raw CSS produced by the above setup is correct but the modifier doesn't seem to work. This one does work though: cq-w-xl:bg-blue-300. Any idea what might be the issue?

Arbitrary Values?

Looks like I was looking for Tailwind container queries just as this project was posted.

All seems to working well!

I'm wondering if it might be possible to implement arbitrary values. To be honest, I'm not even sure if Tailwind supports this for plugins or not.

Much thanks

Issues on Firefox with production builds

I created an issue with container-query-polyfill as well here. It seems when building a production version of a tailwind app, this does not work.

I created a stripped down version here:

https://github.com/dreamboyx1/container-query-polyfill-example

I'm that package on.

  • Mac Firefox 106.0.5 (64-bit)
  • MacOS 12.6.1

The main branch just uses container-query-polyfill. The version that uses this package is under branch tailwindcss-container-query.

clone the package then
git checkout tailwindcss-container-query
npm install
npm run prod

This builds a production version of the Create React App app. You can connect to it a http://locations:3000. Just using npm start works as advertised. Seems to me there is likely an optimization or tree shaking issue.

Anywho. Thought you might like to know.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.