Blazing fast zero-runtime CSS in JS library
<script type="module">
import brandonkalLinaria from 'https://cdn.skypack.dev/@brandonkal/linaria';
</script>
Zero-runtime CSS in JS library.
This is a fork of Linaria. Reasons you will enjoy using the @brandonkal fork:
Modifiers look like this (with optional TS typing and shorthand prop syntax):
interface ButtonProps {
primary$?: boolean;
}
const Button = (p => styled.button<ButtonProps>`
background: black;
color: white;
&${[p.primary$]} {
background: blue;
color: black;
&:hover {
border-color: red;
}
}
`)({} as ButtonProps);
This has been published as a package due to a lack of response to an RFC and an open Pull Request. This package will be maintained and is used in production.
Consider using eslint-plugin-csstyper to lint dynamic CSS values!
yarn add @brandonkal/linaria
or
npm install @brandonkal/linaria
Linaria currently supports webpack and Rollup to extract the CSS at build time. To configure your bundler, check the following guides:
Optionally, add the linaria/babel preset to your Babel configuration at the end of the presets list to avoid errors when importing the components in your server code or tests:
{
"presets": ["@babel/preset-env", "@babel/preset-react", "linaria/babel"]
}
See Configuration to customize how Linaria processes your files.
Linaria can be used with any framework, with additional helpers for React. The basic syntax looks like this:
import { css } from '@brandonkal/linaria';
import { modularScale, hiDPI } from 'polished';
import fonts from './fonts';
// Write your styles in `css` tag
const header = css`
text-transform: uppercase;
font-family: ${fonts.heading};
font-size: ${modularScale(2)};
${hiDPI(1.5)} {
font-size: ${modularScale(2.5)};
}
`;
// Then use it as a class name
<h1 class={header}>Hello world</h1>;
You can use imported variables and functions for logic inside the CSS code. They will be evaluated at build time.
If you're using React, you can use the styled helper, which makes it easy to write React components with dynamic styles with a styled-component like syntax:
import { styled } from '@brandonkal/linaria/react';
import { families, sizes } from './fonts';
// Write your styles in `styled` tag
const Title = styled.h1`
font-family: ${families.serif};
`;
const Container = styled.div`
font-size: ${sizes.medium}px;
color: ${props => props.color};
border: 1px solid red;
&:hover {
border-color: blue;
}
${Title} {
margin-bottom: 24px;
}
`;
// Then use the resulting component
<Container color="#333">
<Title>Hello world</Title>
</Container>;
Dynamic styles will be applied using CSS custom properties (aka CSS variables) and don't require any runtime.
See Basics for a detailed information about the syntax.
css tagNo IE11 support when using dynamic styles in components with styled, since it uses CSS custom properties
Dynamic styles are not supported with css tag. See Dynamic styles with css tag for alternative approaches.
Modules used in the CSS rules cannot have side-effects. For example:
import { css } from '@brandonkal/linaria';
import colors from './colors';
const title = css`
color: ${colors.text};
`;
Here, there should be no side-effects in the colors.js file, or any file it imports. We recommend to move helpers and shared configuration to files without any side-effects.
This project wouldn't have been possible without the following libraries or the people behind them.
Special thanks to @kentcdodds for his babel plugin and @threepointone for his suggestions and encouragement.
Linaria is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. Callstack is a group of React and React Native geeks, contact us at hello@callstack.com if you need any help with these or just want to say hi!
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
