js-style
v2.0.0
Published
JavaScript methods based CSS preprocessor
Downloads
8
Maintainers
Readme
js-style
js-style is an easy JavaScript based CSS preprocessor.
Using
The first step is to clone the repo:
git clone https://github.com/stuniel/js-style.git
or if you use npm:
npm install js-style
To use js-style you have to import the module
const js_style = require("js-style")
Now you are ready to use all the methods that the library provides.
After you write your code in a JavaScript file you can run
node file.js
in your terminal to compile it to a CSS file.
Methods
js-style uses JavaScript methods to create CSS styles. These are the main methods used in js-style:
.use()
- allows you to use the element in the future
.render()
- renders the output of the element
.write()
- converts and writes the output of elements
.selector(value)
- defines a seletor
.add(prop, value)
- defines props
.camelCaseCSSName(value)
- defines props
.extend(element)
- extends previously defined element
.nest(element)
- nests previously defined element
.include(element)
- includes previously defined element
Use
If you want to use a variable add method .use()
at the end.
Render
After declaring all the properties you have to use .render()
method to enable the element to be rendered.
A simple example will look like this
const table = js_style()
.selector('.table')
.position('relative')
.color('#3e3e3e')
.backgroundColor('#ffffff')
.render()
and will result in
table {
position: relative;
color: #3e3e3e;
background-color: #ffffff;
}
Write
If you want to convert elements to CSS files you have to use .write()
method. This method accepts an object or array of objects with input
and output
as keys.
Syntax:
js_style().write({
input: INPUT_VARIABLE,
output: OUTPUT_FILE
})
or
js_style().write([
{
input: INPUT_VARIABLE,
output: OUTPUT_FILE
},
{
input: INPUT_VARIABLE,
output: OUTPUT_FILE
},
])
A simple example will look like this
const table = js_style()
.selector('.table')
.position('relative')
.color('#3e3e3e')
.backgroundColor('#ffffff')
.render()
const bigTable = js_style()
.selector('.table--big')
.position('relative')
.color('#3e3e3e')
.backgroundColor('#ffffff')
.width('100%')
.render()
js_style()
.write([
{
input: table,
output: '.././css/table.css'
},
{
input: bigTable,
output: 'bigTable'
},
])
This will result in 'table.css' file written in a specified directory and 'bigTable.css' written in the working directory.
Selector
To declare a selector use .selector()
method with selector name as an attribute:
.selector('body')
will result in
body {
Add
To add a property to your element you can use .add(prop, value)
method which expects a property name and value as sting values or an object with property name as a key and a value as a value.
.add('color', 'red')
.add('background-color', 'blue')
and
.add({
'color': 'red',
'background-color': 'blue'
})
will both result in
color: red;
background-color: blue;
Style names methods
js-style gives methods for all the style names with values as attributes. The style names match the CSS names, except names are written using camel casing. So we will write fontSize
instead of font-size
.
.color('#3e3e3e')
will result in
color: #3e3e3e;
Extend
js-styles provides .extend()
method that lets you share a set of CSS properties from one selector to another.
This code
const basicTable = js_style()
.selector('.table')
.position('relative')
.color('#3e3e3e')
.backgroundColor('#ffffff')
.use()
const bigTable = js_style()
.selector('.table--big')
.extend(basicTable)
.width('100%')
.height('100%')
.render()
will result in
.table {
position: relative;
color: #3e3e3e;
background-color: #ffffff;
}
.table--big {
position: relative;
color: #3e3e3e;
background-color: #ffffff;
width: 100%;
height: 100%;
}
Include
js-styles also provides .include()
method that lets you insert elements inside another.
This code
const basicTable = js_style()
.selector('.table')
.position('relative')
.color('#3e3e3e')
.backgroundColor('#ffffff')
.width('400px')
.use()
const smallScreen = js_style()
.selector('@media only screen and (max-width: 24em)')
.include(basicTable)
.render()
will result in
@media only screen and (max-width: 24em) {
.table {
position: relative;
color: #3e3e3e;
background-color: #ffffff;
width: 400px;
}
}
Nest
js-style provides .nest()
method that let's you nest CSS selectors.
This code
const js_style = require('./src/index.js')
const defaultPosition = 'relative';
const basicCell = js_style()
.selector('.cell')
.position(defaultPosition)
.color('#444444')
.backgroundColor('#ffffff')
.use()
const basicTable = js_style()
.selector('.table')
.nest(basicCell)
.position(defaultPosition)
.color('#3e3e3e')
.backgroundColor('#ffffff')
.use()
const basicPage = js_style()
.selector('div')
.nest(basicTable)
.backgroundColor('red')
.render()
will result in
div {
background-color: red
}
div .table {
position: relative
color: #3e3e3e
background-color: #ffffff
}
div .table .cell {
position: relative
color: #444444
background-color: #ffffff
}
Variables
Use the same color all over the place? js-style lets you use JavaScript variables to store values that you want to use multiple times.
const primaryColor = '#e3e3e3'
const table = js_style()
.selector('.table')
.position('relative')
.color(primaryColor)
.backgroundColor('#ffffff')
.render()
As simple as that.
js-style is licensed under the MIT License.