pp

postcss-percentage

PostCSS plugin to transform percentage() function

Showing:

Popularity

Downloads/wk

129

GitHub Stars

3

Maintenance

Last Commit

5yrs ago

Contributors

1

Package

Dependencies

3

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

PostCSS Percentage Build Status

PostCSS plugin to support percentage() function.

This plugin will transform all percentage(expression) functions to correct percentage. It's almost the same as sass function percentage, except for the support for the unit (percentage(50px / 50px)).

Installation

npm i --save postcss-percentage

Usage

postcss([ require('postcss-percentage')(opts) ])

If the input is

.box {
    width: percentage(1 / 24);
    margin: percentage(- 1 / 24) percentage(0.01 * 5);
}

Then you will get

.box {
    width: 4.166667%;
    margin: -4.166667% 5%;
}

See PostCSS docs for examples for your environment.

Options

require('postcss-percentage')({
    precision: 9,
    trimTrailingZero: true,
    floor: true
})

precision (default: 6)

Allow you to definine the precision for decimal numbers.

Note: allowed value for precision is between [0, 20].

trimTrailingZero (default: true)

Allow you to trim trailing zeroes.

When computed value is 1.234000%, we will get 1.234% instead.

floor (default: false)

Allow you to ensure the percentage will not greater than the original value. It will be quite useful to ensure the total value won't be greater than 100% (sum of some percentages).

For example, when floor is true and precision is 3, the percentage(1/24) will get 4.166% rather than 4.167%.

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial