Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/porsager/bss
🎨 Better Style Sheets
https://github.com/porsager/bss
css css-in-js stylesheets
Last synced: 7 days ago
JSON representation
🎨 Better Style Sheets
- Host: GitHub
- URL: https://github.com/porsager/bss
- Owner: porsager
- License: wtfpl
- Created: 2017-07-08T11:39:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T23:56:17.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T00:35:24.626Z (23 days ago)
- Topics: css, css-in-js, stylesheets
- Language: JavaScript
- Homepage:
- Size: 722 KB
- Stars: 91
- Watchers: 14
- Forks: 14
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - bss - 🎨 Better Style Sheets (JavaScript)
README
[]() []() []()
## 🎨 `bss`
A simpler way to do CSS in Javascript directly on the elements you're styling.
`bss` allows you to write your styles directly on the element where they matter using plenty of fun constructors.
- [CSS Strings](#css-strings)
- [Lean Strings](#lean-strings)
- [JS Objects](#js-objects)
- [Functions](#functions)
- [Helpers](#helpers)
Any group of definitions are resolved once one of the following properties are accessed / called
- [`.style` Returns a Javascript style object ](#style)
- [`.class` Returns a class name](#class)
- [`.valueOf() or '' +` returns '.' + b.class](#tostring)
## Installation
Using npm
``` bash
npm install bss -S
```
Require from CDN
``` html
```
Or download and include - [download bss.js](https://unpkg.com/bss/bss.js)
## Example usage
Here's a quick example of using bss together with [mithril](https://github.com/mithriljs/mithril.js) - see the example [live here](https://flems.io/#0=N4IgtglgJlA2CmIBcBWFA6AzCgNCA9gK4AuADicsQE6Hx4DO8CAxsfFMiOgFb0h4AzCAj5IA2qAB2AQzCIkXXvxDN8ktus4JiAAjU6AvDuq0AOpPNh0YIuoAUUfM0Jz16AEb4oATxw7g5jo6AG4Q8ADuSCGSXvCGAHw6YHYA5AAWAIwpOgDUOu4ezKlU7CkAlOhFKeFpEGzl6AL0dpgATBXE0qnM8OrwVOV+AZJBQfTE3ghRBe5F+gBk8zopAOYlvQ3jk3SBo2rMsBDMANZRdmUJeiNGAIRquwC+fikAEkyw+Drh+FSwUOXmB5lEAPAC6eEOkmOogkIEIv04aWIZHoSAA9GjCJJSMcVpV8GA0ZBiGkqMIAAIZdBUzDKCakeQgJR4UjSYjMNLwGFiDJ4dgASUkUHgAA9TCBlLsdModAAfWU6NnUfgZABsOFaAAYcJhMGrMDq9arMOCeXhWOxxTpFjK7FKgjLgjFhegODg1RqACyGjIATgNur9JpwZpAxAgwXgAFEEK5iOYZaMgvLorFXQT0KySuoY-A44YDEYdAASRzMdDSVgR6Ox3rxkajMoJvCmYgPcytgRYqtqfitb0ADgA7IbWnrR3rQaCnqB4bBEcjSKiMVicXjVIT3PQ+Hh6YylGCHkA)
``` js
// Some js file
import b from 'bss'
import m from 'mithril'
let on = true
m.mount(document.body, {
view: vnode => m('h1' + b.bc('red').c('white').fs(32).ta('center'), {
style: b.bc(on && 'green').style,
onclick: () => on = !on
}, 'Hello world')
})
```
Creates the following in the dom, which toggles the style attribute on click.
``` html
.bdp4f3o1 {
background-color: red;
color: white;
font-size: 32px;
}
Hello world
```
## Ways of writing CSS
In the spirit of Javscript - `bss` Allows you to write the same thing in many different ways.
### CSS Strings
``` js
b`
background-color: black;
text-align: center;
`
.$hover(`
background-color: red;
`)
```
### Lean Strings
``` js
b`
background-color black
text-align center
`
.$hover`
background-color red
`
```
### JS Objects
``` js
b({
backgroundColor: 'black',
textAlign: 'center',
':hover': {
backgroundColor: 'red'
}
})
```
### Functions
``` js
b.backgroundColor('black')
.textAlign('center')
.$hover(
b.backgroundColor('red')
)
```
## Output
### `.class`
The `.class` getter closes the current style description, creates a class name, adds the styles to a stylesheet in `` and returns the class name
``` js
b.textAlign('center').class // Returns eg. bdp4f3o1
```
### `.style`
The `.style` getter also closes the current style description and return a JS object with the styles
``` js
b.textAlign('center').style // Returns { textAlign: 'center' }
```
### `valueOf()`
`.valueOf()` will be called if b is used like `'div' + b` because javascript casts automatically using `.valueOf()`.
Casting `b` to a string will call `.class` and prepend a period for easy use in vdom libraries.
``` js
'div' + b.textAlign('center') // Returns eg. div.bdp4f3o1
```
You can also override `.valueOf` if you set classNames instead of selectors
```
b.valueOf = function() { return this.class + ' ' }
`
` // Returns eg.
```
## Short property names
Short property names can also be used and are the acronyms of full css properties with collisions [handpicked by popularity](lib/popular.js)
``` js
b.bc('black')
.ta('center')
.$hover(
b.bc('red')
)
```
## `.helper`
Define your own helpers to work in a fashion similar to tachyons, or simply to make your life easier.
Tachyon style helpers
``` js
b.f1.p1 // { font-size: '3rem'; padding: '0.25rem'; }
// Created like this:
b.helper('f1', b.fontSize('3rem'))
b.helper('p1', b.padding('0.25rem'))
// Or like this:
b.helper({
f1: b.fontSize('3rem'),
p1: b.padding('0.25rem')
})
```
Helpers can also take values like this:
``` js
b.size('100%').align('center') // Fills an element in it's parent and centers all children on both axes.
// Created like this:
b.helper('size', (width, height) =>
b.width(width).height(height || width)
)
b.helper('align', (x, y) =>
b.display('flex').justifyContent(x).alignItems(y || x)
)
```
They can even be easy to use media query groupers like this:
```js
b.desktop(
b.fontSize(128)
)
// Equally valid is
b.desktop(`
fs 128
`)
// Created like this:
b.helper('desktop', style => b.$media('(min-width:801px)', style))
```
Helpers can be called in a couple different ways:
```js
b.helper('size', (width, height) =>
b.width(width).height(height || width)
)
// Can be invoked by css/lean strings:
b`
color green // you can mix in normal styles
size 50 100
`
// Or functions:
b.color('green').size(50, 100)
```
When invoking a helper through a css/lean string arguments are converted to strings, whereas functions can accept object arguments.
## Pixel values and Numbers
Properties accepting pixel values will automatically have `px` added if a number type is passed.
```
b.fontSize(32) // font-size: 32px;
b.width(200) // width: 200px;
```
## `.$hover` :pseudo selectors
All of the different css pseudo selectors normally used with a colon `:` is added with the dollor `$` for ease of use in js.
``` js
b(`
color: red;
`).$hover(`
color: blue;
`)
b.color('red').$hover(b.color('blue'))
```
## `.$nest` nested selectors
Targeting nested children is sometimes useful, and is done by using `$nest` and supplying the first argument with a regular child css selector, and then supply styling as the second argument for that selector.
``` js
b.color('red').$nest('li', b.color('blue'))
b.color('red').$nest(':hover li', b.color('blue'))
b.color('red').$nest('> &', b.margin(10))
```
`&` is a placeholder for the generated class like in `sass/less`.
Once you use `&` in `$nest` you take full responsibility of adding the generated class in the correct places to avoid creating global selectors.
One case where this could happen is if using the comma seperator to make multiple selectores, like doing `$nest('th &, tr', ...)`. This would create a global `tr` style. To do this right the code would need to be `$nest('th &, tr &, ...)`.
Normally bss handles this for you such that `$nest('th, tr', ...)` will be scoped locally, but using `&` overrides this behavior.
## `.$media` @media queries
``` js
b.color('red').$media('(max-width: 600px)', b.color('blue'))
```
## `.$keyframes` @keyframes
Animation in CSS is usually a mixture of `transition` and `animation / @keyframes`. `Transition` is handled as usual css properties by `bss`, but `@keyframes` are a bit different.
Creating a keyframe animation is done using `b.$keyframes` and will return a generated name for the animation specified.
```js
const fadeIn = b.$keyframes({
from: b.o(0).style,
to: b.o(1).style
})
// To use the animation do:
b.animation(fadeIn + ' 1s')
```
## `.$animate`
Often it might not be necessary to consider the animation name so a built in helper method called `$animate` comes in handy. It takes a regular animation shorthand value as the first argument, excluding the animation name. The second parameter is the animation definition itself.
``` js
b.$animate('1s linear', {
from: b.o(0).style,
to: b.o(1).style
})
```
## `.css`
A way to add regular css properties to a selector and prepend to the generated stylesheet
```
b.css('html', b.boxSizing('border-box'))
b.css('*, *:before, *:after', b.boxSizing('inherit'))
```
## `.setDebug`
Since chrome dev tools doesn't allow changing styles applied using CSSOM you can activate debugging mode which doesn't apply the styles using CSSOM.
```
b.setDebug(true)
```
The only caveat here is that animations and applied styles can result in small quicks like blinking fonts and styles.
## Specificity
To enhance developer expectations bss uses double class names for regular definitions to give higher specificity than nested items, which might have rules added from regular css, or from `$nest`. To support this `$nest` will not increase specificity by only adding the class name once.
## Browser support
`bss` is tested and works in ie9+ and the other major browsers.
> TODO - Create browser support table
### Prefixes
When using `bss` in the browser it automatically adds only the necessary prefixes, so you can go ahead and use the raw property and expect it to work in browsers that only has the prefixed version.
Prefixes for css property values like `linear-gradient` are not supported yet, so if you want to support older browsers you'll need to add them manually like
```
b`
background -webkit-linear-gradient(45deg, red, blue)
background -moz-linear-gradient(45deg, red, blue)
background linear-gradient(45deg, red, blue)
...etc
`
```
## Server support
> TODO - If using it on the server you can specify the prefixes that you'd like to be generated when generating the css.