https://github.com/csstools/postcss-short-text
Use a shorthand text property in CSS
https://github.com/csstools/postcss-short-text
Last synced: 11 months ago
JSON representation
Use a shorthand text property in CSS
- Host: GitHub
- URL: https://github.com/csstools/postcss-short-text
- Owner: csstools
- License: other
- Created: 2015-09-21T13:01:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-11-08T11:15:25.000Z (over 4 years ago)
- Last Synced: 2024-04-14T05:31:42.657Z (almost 2 years ago)
- Language: JavaScript
- Size: 129 KB
- Stars: 4
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Short Text [![Build Status][ci-img]][ci]
[Short Text] is a [PostCSS] plugin that lets you use a shorthand `text` property in CSS.
```css
/* before */
section {
text: bold center uppercase dimgrey 1.25em 1.5 .05em;
}
article {
text: 1.25em * .05em;
}
/* after */
section {
font-weight: bold;
text-align: center;
text-transform: uppercase;
color: dimgrey;
font-size: 1.25em;
line-height: 1.5;
letter-spacing: .05em;
}
article {
font-size: 1.25em;
letter-spacing: .05em;
}
```
Properties are matched into groups that may be written in any order. Once a property is matched to a group, other properties from that group must then be written before properties of another group. Asterisks indicate that an individual property in a group should be skipped. The groups include:
- `color`
- `font-style`, `font-variant`, `font-weight`, `font-stretch`
- `text-decoration`, `text-align`, `text-rendering`, `text-transform`
- `white-space`
- `font-size`, `line-height`, `letter-spacing`, `word-spacing`
## Usage
Follow these steps to use [Short Text].
Add [Short Text] to your build tool:
```bash
npm install postcss-short-text --save-dev
```
#### Node
```js
require('postcss-short-text')({ /* options */ }).process(YOUR_CSS);
```
#### PostCSS
Add [PostCSS] to your build tool:
```bash
npm install postcss --save-dev
```
Load [Short Text] as a PostCSS plugin:
```js
postcss([
require('postcss-short-text')({ /* options */ })
]);
```
#### Gulp
Add [Gulp PostCSS] to your build tool:
```bash
npm install gulp-postcss --save-dev
```
Enable [Short Text] within your Gulpfile:
```js
var postcss = require('gulp-postcss');
gulp.task('css', function () {
return gulp.src('./css/src/*.css').pipe(
postcss([
require('postcss-short-text')({ /* options */ })
])
).pipe(
gulp.dest('./css')
);
});
```
#### Grunt
Add [Grunt PostCSS] to your build tool:
```bash
npm install grunt-postcss --save-dev
```
Enable [Short Text] within your Gruntfile:
```js
grunt.loadNpmTasks('grunt-postcss');
grunt.initConfig({
postcss: {
options: {
processors: [
require('postcss-short-text')({ /* options */ })
]
},
dist: {
src: 'css/*.css'
}
}
});
```
## Options
#### `prefix`
Type: `String`
Default: `null`
Specifies a prefix to be surrounded by dashes before the declaration (e.g. `-x-text`).
[ci]: https://travis-ci.org/jonathantneal/postcss-short-text
[ci-img]: https://travis-ci.org/jonathantneal/postcss-short-text.svg
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[Short Text]: https://github.com/jonathantneal/postcss-short-text