https://github.com/cssobj/cssobj-plugin-default-unit
Add default unit to css numeric-like values, which have to specify an unit.
https://github.com/cssobj/cssobj-plugin-default-unit
Last synced: 2 months ago
JSON representation
Add default unit to css numeric-like values, which have to specify an unit.
- Host: GitHub
- URL: https://github.com/cssobj/cssobj-plugin-default-unit
- Owner: cssobj
- Created: 2016-07-14T21:41:43.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-07-26T01:35:57.000Z (almost 9 years ago)
- Last Synced: 2025-10-05T05:25:40.193Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cssobj-plugin-default-unit
[](https://gitter.im/css-in-js/cssobj) [](https://travis-ci.org/cssobj/cssobj-plugin-default-unit)
Add default unit to css numeric-like values, which have to specify an unit.
## Install
``` javascript
npm install cssobj/cssobj-plugin-default-unit
```
## Usage
``` javascript
var cssobj_core = require('cssobj-core')
var defaultUnit = require('cssobj-plugin-default-unit')
var cssobj = cssobj_core({plugins: [ defaultUnit('px') ]})
var obj = { p: { fontSize: 12 } }
var result = cssobj(obj)
// the css: p {font-size: 12px;}
```
## API
### `var plugin = defaultUnit(unit)`
Get plugin function to apply, pass unit.
### *PARAMS*
### `unit`
- Type: string
- Default: 'px'
The unit as default unit to add to numeric-like values, accordingly to [Unitless List](https://github.com/cssobj/cssobj-plugin-default-unit/blob/master/src/cssobj-plugin-default-unit.js#L5)
### *RETURN*
A function can be as cssobj plugin.
## Example
``` javascript
defaultUnit() // default unit is 'px'
defaultUnit('em') // default unit is 'em'
```
## Caveat
`line-height` will **NOT** add unit, since below:
``` javascript
p { lineHeight: 1.5 }
p { lineHeight: '22px' }
```
It's both valid with or w/o unit, so this plugin don't touch it.