Reactive stylesheets for SolidJS
npm i solid-styled
yarn add solid-styled
pnpm add solid-styled
- Render stylesheets only once
- Fine-grained reactive CSS properties
- Scoped stylesheets
:global
selector@global
at-rule- SSR
- Near zero-runtime
<style jsx>
For solid-styled
to make its magic work properly, you need to add the solid-styled/babel
plugin in the babel configuration:
{
"plugins": [
"solid-styled/babel"
]
}
{
// Toggle verbose scope names based
// on the owning component's name,
// useful for debugging
// Default: false
"verbose": true,
// Allows prefixing scope names
// useful for package publishing
// Default: undefined ('')
"prefix": "example",
// Path of the filename, used for hashing
"source": "/path/to/file"
}
Use the css
tagged template for writing stylesheets.
import { css } from 'solid-styled';
function Title() {
css`
h1 {
color: red;
}
`;
return <h1>Hello World</h1>;
}
The template is also reactive. It works by replacing all templating values with a CSS variable. This allows the stylesheet to be only rendered once and can be shared by multiple components of the same scope.
import { css } from 'solid-styled';
function Button() {
const [color, setColor] = createSignal('red');
css`
button {
color: ${color()};
}
`;
return (
<button onClick={() => {
setColor((c) => (c === 'red' ? 'blue' : 'red'));
}}>
Current color: {color()}
</button>
);
}
By default, all styles are scoped to its component and cannot leak into another component. The scoping only applies to all DOM nodes that can be found in the component, including the children of the external components.
import { css } from 'solid-styled';
function ForeignTitle() {
return <h1>This is not affected</h1>;
}
function Title() {
css`
h1 {
color: red;
}
`;
return (
<>
<h1>This is affected.</h1>
<ForeignTitle />
<Container>
<h1>This is also affected.</h1>
</Container>
</>
)
}
Since all selectors in a given stylesheet are scoped by default, you can use the :global
pseudo selector to opt-out of scoping:
import { css } from 'solid-styled';
function Feed(props) {
css`
div > :global(* + *) {
margin-top: 0.5rem;
}
`;
return (
<div>
<For each={props.articles}>
{(item) => (
// This item is affected by the CSS of the Feed component.
<FeedArticle data={item} />
)}
</For>
</div>
);
}
You can use @global
instead of :global
if you want to declare multiple global styles
css`
/* this is global */
@global {
body {
background-color: black;
}
main {
padding: 0.5rem;
}
}
h1 {
color: white;
}
`;
Since solid-styled
scopes DOM elements and not components by default, it doesn't affect things like <Dynamic>
. Using use:solid-styled
, we can forward the current scope/sheet to the component.
css`
* {
color: red;
}
`;
<Dynamic component={props.as} use:solid-styled>
{props.children}
</Dynamic>
which compiles into
useSolidStyled('xxxx', '*[s\\:xxxx]{color:red}');
<Dynamic component={props.as} s:xxxx style={vars()}>
{props.children}
</Dynamic>
Inspired by styled-jsx
.
Use <style jsx>
instead of css
for declaring styles in JSX expressions. Both <style jsx>
and css
functions the same.
function Button() {
const [color, setColor] = createSignal('red');
return (
<>
<style jsx>
{`
button {
color: ${color()};
}
`}
</style>
<button onClick={() => {
setColor((c) => (c === 'red' ? 'blue' : 'red'));
}}>
Current color: {color()}
</button>
</>
);
}
You can also use <style jsx global>
for declaring global styles.
The main motivation for writing an alternative way of declaring styles with <style jsx>
is to facilitate the migration from solid-styled-jsx
to solid-styled
. Possibly, some developers may as well use <style jsx>
because of their familiarity with adding the styles inside the JSX.
For SSR, you can pass an array to the styles
prop of <StyleRegistry>
. This array collects all of the "critical" (initial render) stylesheets, that which you can render as a string with renderSheets
.
import { renderSheets } from 'solid-styled';
const styles = [];
renderToString(() => (
<StyleRegistry styles={styles}>
<App />
</StyleRegistry>
));
// Render sheets
// You can use the resulting sheet by inserting
// it into an HTML template.
const styles = renderSheets(styles);
solid-styled
uses PostCSS for processing the CSS templates. You can check the following plugins, that are used by default, for the features that are supported:
- Autoprefixer
postcss-nested
- CSSNano
In the future,
solid-styled
can possibly allow to load the PostCSS config and to allow other plugins to be used.
- Scoping
css
can only be called directly on components. This is so that the Babel plugin can find and transform the JSX of the component. Globalcss
(i.e.:global
or@global
) can be used inside other functions i.e. hooks, utilities. - Dynamic styles are only limited to CSS properties.
MIT © lxsmnsyc