epiphany/node_modules/postcss-gap-properties/README.md
2023-12-09 22:48:07 -08:00

2.6 KiB

PostCSS Gap Properties PostCSS Logo

npm version CSS Standard Status Build Status Discord

PostCSS Gap Properties lets you use the gap, column-gap, and row-gap shorthand properties in CSS, following the CSS Grid Layout specification.

.standard-grid {
	display: grid;
	gap: 20px;
}

.spaced-grid {
	display: grid;
	column-gap: 40px;
	row-gap: 20px;
}

/* becomes */

.standard-grid {
	display: grid;
	grid-gap: 20px;
	gap: 20px;
}

.spaced-grid {
	display: grid;
	grid-column-gap: 40px;
	column-gap: 40px;
	grid-row-gap: 20px;
	row-gap: 20px;
}

Usage

Add PostCSS Gap Properties to your project:

npm install postcss postcss-gap-properties --save-dev

Use it as a PostCSS plugin:

const postcss = require('postcss');
const postcssGapProperties = require('postcss-gap-properties');

postcss([
	postcssGapProperties(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);

PostCSS Gap Properties runs in all Node environments, with special instructions for:

Options

preserve

The preserve option determines whether the original notation is preserved. By default, it is preserved.

postcssGapProperties({ preserve: false })
.standard-grid {
	display: grid;
	gap: 20px;
}

.spaced-grid {
	display: grid;
	column-gap: 40px;
	row-gap: 20px;
}

/* becomes */

.standard-grid {
	display: grid;
	grid-gap: 20px;
}

.spaced-grid {
	display: grid;
	grid-column-gap: 40px;
	grid-row-gap: 20px;
}