GoScrobble/web/node_modules/postcss-place/README.md

103 lines
2.7 KiB
Markdown
Raw Normal View History

2022-04-25 02:47:15 +00:00
# PostCSS Place Properties [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][postcss]
[![NPM Version][npm-img]][npm-url]
[![CSS Standard Status][css-img]][css-url]
[![Build Status][cli-img]][cli-url]
[![Support Chat][git-img]][git-url]
[PostCSS Place Properties] lets you use `place-*` properties as shorthands for `align-*`
and `justify-*`, following the [CSS Box Alignment] specification.
```pcss
.example {
place-self: center;
place-content: space-between center;
}
/* becomes */
.example {
align-self: center;
justify-self: center;
place-self: center;
align-content: space-between;
justify-content: center;
place-content: space-between center;
}
```
## Usage
Add [PostCSS Place Properties] to your project:
```bash
npm install postcss-place --save-dev
```
Use [PostCSS Place Properties] to process your CSS:
```js
import postcssPlace from 'postcss-place';
postcssPlace.process(YOUR_CSS /*, processOptions, pluginOptions */);
```
Or use it as a [PostCSS] plugin:
```js
import postcss from 'postcss';
import postcssPlace from 'postcss-place';
postcss([
postcssPlace(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
[PostCSS Place Properties] runs in all Node environments, with special instructions for:
| [Node](INSTALL.md#node) | [Webpack](INSTALL.md#webpack) | [Create React App](INSTALL.md#create-react-app) | [Gulp](INSTALL.md#gulp) | [Grunt](INSTALL.md#grunt) |
| --- | --- | --- | --- | --- |
## Options
### preserve
The `preserve` option determines whether the original place declaration is
preserved. By default, it is preserved.
```js
postcssPlace({ preserve: false })
```
```pcss
.example {
place-self: center;
place-content: space-between center;
}
/* becomes */
.example {
align-self: center;
justify-self: center;
align-content: space-between;
justify-content: center;
}
```
[cli-img]: https://img.shields.io/travis/jonathantneal/postcss-place.svg
[cli-url]: https://travis-ci.org/jonathantneal/postcss-place
[css-img]: https://cssdb.org/badge/place-properties.svg
[css-url]: https://cssdb.org/#place-properties
[git-img]: https://img.shields.io/badge/support-chat-blue.svg
[git-url]: https://gitter.im/postcss/postcss
[npm-img]: https://img.shields.io/npm/v/postcss-place.svg
[npm-url]: https://www.npmjs.com/package/postcss-place
[CSS Box Alignment]: https://www.w3.org/TR/css-align-3/#place-content
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Loader]: https://github.com/postcss/postcss-loader
[PostCSS Place Properties]: https://github.com/jonathantneal/postcss-place