Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sadick254/scoped-style
A tiny css in js library 🚀
https://github.com/sadick254/scoped-style
css css-in-js hyperapp inferno inferno-js javascript preact react styled-components tiny universal
Last synced: 2 months ago
JSON representation
A tiny css in js library 🚀
- Host: GitHub
- URL: https://github.com/sadick254/scoped-style
- Owner: sadick254
- Created: 2018-09-17T16:09:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-09T15:07:30.000Z (over 4 years ago)
- Last Synced: 2024-04-25T10:41:49.405Z (9 months ago)
- Topics: css, css-in-js, hyperapp, inferno, inferno-js, javascript, preact, react, styled-components, tiny, universal
- Language: JavaScript
- Homepage:
- Size: 328 KB
- Stars: 137
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - scoped-style
README
# Scoped Style
Scoped style is a next gen tiny css-in-js library to help you style your components. Use the full power of css that you are used to.
## Works With
- [React](https://reactjs.org/)
- [Preact](https://preactjs.com/)
- [Hyperapp](https://github.com/jorgebucaran/hyperapp)
- [Inferno](https://infernojs.org/)
## Installation
```cmd
npm i scoped-style
// or
yarn add scoped-style
```
## Usage
```javascript
import scoped from 'scoped-style';
// for react
import React from 'react';
const styled = scoped(React.createElement);
//
// for Preact
import { h } from 'preact';
const styled = scoped(h);
//
// for Hyperapp
import { h } from 'hyperapp';
const styled = scoped(h);
//
// for Infernojs
import { createElement } from 'inferno-create-element';
const styled = scoped(createElement);
//
// define global css
styled.global`
* {
margin: 0;
}
html,
body {
width: 100%;
height: 100%;
}
`;
// and scoped css
const Button = styled('button')`
background: ${props => (props.primary ? 'orange' : 'gray')};
border: none;
border-radius: 2px;
:hover,
:focus,
:active {
padding: 10px;
}
@media screen and (max-width: 640px) {
background: blue;
:hover,
:focus,
:active {
padding: 5px;
}
}
`;
// keyframes
const spin = styled.keyframes`
to {
transform: rotate(360deg);
}
`;
const Loader = styled('div')`
border: 3px solid hsla(185, 100%, 62%, 0.2);
border-top-color: #3cefff;
border-radius: 50%;
width: 2em;
height: 2em;
animation: ${() => spin} 1s linear infinite;
`;
// styling children
const BlueChildren = styled('div')`
> * {
color: blue;
}
`;
const App = ({ children }) => (
Login
{children}
);
// Your rendering code
```
## Support and limitations
### Combinators
Supported :
- [Adjacent sibling combinator](https://developer.mozilla.org/en-US/docs/Web/CSS/Adjacent_sibling_combinator) : `+`
- [General sibling combinator](https://developer.mozilla.org/en-US/docs/Web/CSS/General_sibling_combinator) : `~`
- [Child combinator](https://developer.mozilla.org/en-US/docs/Web/CSS/Child_combinator) : `>`
Not supported :
- [Descendant combinator](https://developer.mozilla.org/en-US/docs/Web/CSS/Descendant_combinator)
- [Column combinator](https://developer.mozilla.org/en-US/docs/Web/CSS/Column_combinator)
### Selectors
Selectors must be used in with a combinator.
We support them all :
- [Type selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Type_selectors)
- [Class selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors)
- [ID selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors)
- [Universal selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Universal_selectors)
- [Attribute selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors)
### Pseudo selectors
We support them all.
Warning, if you are using the `content` property : special characters (like `â—€`) are not suppoted, you must convert them (via [http://enc.joyho.net/](http://enc.joyho.net/) for example) and it will work (`content: "\\25C0";`).
## Questions, bugs and feature requests
You have a question about usage, feel free to open an issue.
You found a bug, feel free to open an issue.
You've got a feature requests, feel free to open an issue.
## Advanced example : radio button, checkbox
```javascript
const Label = styled('label')`
position: relative;
padding-left: 2rem;
padding-right: 0.75rem;
margin-bottom: 0.75rem;
cursor: pointer;
font-size: 1rem;
user-select: none;
> input {
position: absolute;
opacity: 0;
cursor: pointer;
height: 0;
width: 0;
}
> input[type='checkbox'] ~ span {
position: absolute;
top: 0.2rem;
left: 0;
height: 1rem;
width: 1rem;
background-color: #eee;
}
> input[type='radio'] ~ span {
position: absolute;
top: 0.2rem;
left: 0;
height: 1rem;
width: 1rem;
background-color: #eee;
border-radius: 50%;
}
:hover > input ~ span {
background-color: #ccc;
transition: 0.2s;
}
> input:checked ~ span {
background-color: #0080b3;
}
:active > span {
transform: scale(0);
}
> span:after {
content: '';
position: absolute;
display: none;
}
> input:checked ~ span:after {
display: block;
}
> input[type='checkbox'] ~ span:after {
left: 0.25rem;
top: 0.05rem;
width: 0.25rem;
height: 0.6rem;
border: solid white;
border-width: 0 0.2rem 0.2rem 0;
transform: rotate(45deg);
}
> input[type='radio'] ~ span:after {
left: 0.3rem;
top: 0.3rem;
width: 0.4rem;
height: 0.4rem;
border-radius: 50%;
background: white;
}
`;
const Radio = ({ name, checked, onChange }) => (
{name}
);
const Checkbox = ({ name, checked, onChange }) => (
{name}
);
```
## Scoped function second parameter
```javascript
import scoped from 'scoped-style';
```
`scoped` can take a second parameter : a callback who "render" the css generated by `styled` function.
The default callback is exported via `scoped.defaultCallback`.
### SSR example
Client :
```javascript
import { createElement } from 'inferno-create-element';
import scoped from './scoped-style';
if (typeof global !== 'undefined') {
global.scopedStyleCSS == '';
}
const styler = css => {
if (typeof document !== 'undefined') {
scoped.defaultCallback(css);
} else if (typeof global !== 'undefined') {
global.scopedStyleCSS += css;
}
};
export const styled = scoped(createElement, styler);
```
Server :
```javascript
app.get('*', (req, res) => {
// first render the root component to string via the SSR function of your framework
const content = renderToString();
res.send(`
Citral
${global.scopedStyleCSS /* then use the generated styles string */}
${content}
`);
});
```