1.3.2 • Published 2 years ago
tailwindcss-grid-system v1.3.2
tailwindcss-grid-system
Bootstrap v5 flexbox grid system as a Tailwind CSS plugin.
Installation
npm i -D tailwindcss-grid-systemIn tailwind.config.js file:
/** @type {import("tailwindcss").Config} */
module.exports = {
plugins: [
require('tailwindcss-grid-system'),
],
};or tailwind.config.ts with typescript:
import { Config } from 'tailwindcss';
export default {
plugins: [
require('tailwindcss-grid-system'),
],
} satisfies ConfigAnd don't forget to include components and utilities in your tailwind base
css file:
@tailwind base;
@tailwind components;
@tailwind utilities;This will generate Bootstrap v5 flexbox grid.
* NOTE: When using the .container class from this plugin you will need to
disable the core
container plugin as both plugins
expose a .container class.
Features & Tailwind CSS options support
- ✅ custom screens
- ✅ custom separator
- ✅ custom prefix
- ✅ important
- ✅ rtl support
Options
Original Bootstrap grid's options:
gridColumns(default -12) - grid sizegridGutterWidth(default -"1.5rem") - container and rows gutter widthgridGutters(default -theme.spacing(default tailwind spacings)) - gutter variable class steps (--twg-gutter-x,--twg-gutter-y)containerMaxWidths(default -{}) - themax-widthcontainer value for each breakpoint
Extra options:
generateContainer(default -true) - whether to generate.containerand.container-fluidclassesrtl(default -false) - rtl support (.offset-xclasses will start responding to[dir=ltr]/[dir=rtl])respectImportant(default -true) - whether it should respect theimportantroot config optionprefix(default -twg) - css variables prefix