linaria README

The project's README from github.com/callstack/linaria. As one markdown file: README.md.

Linaria

Zero-runtime CSS in JS library.


[![Build Status][build-badge]][build] [![Code Coverage][coverage-badge]][coverage] [![Version][version-badge]][package] [![MIT License][license-badge]][license]

![All Contributors][all-contributors-badge] [![PRs Welcome][prs-welcome-badge]][prs-welcome] [![Chat][chat-badge]][chat] [![Code of Conduct][coc-badge]][coc] [![Greenkeeper][greenkeeper-badge]][greenkeeper] [![Sponsored by Callstack][callstack-badge]][callstack]

[![tweet][tweet-badge]][tweet]

Features

Why use Linaria

Learn how Airbnb improved both developer experience and web performance with Linaria

Installation

npm install @linaria/core @linaria/react @wyw-in-js/babel-preset

or

yarn add @linaria/core @linaria/react @wyw-in-js/babel-preset

Setup

Linaria is now built on top of wyw-in-js.dev. It supports various bundlers to extract the CSS at build time. To configure your bundler, check the following guides on the wyw-in-js.dev site:

See Configuration to customize how Linaria processes your files.

Stability

Linaria relies on WyW (@wyw-in-js/*) to evaluate your modules at build time and extract CSS. If you hit issues like slow builds, invalidation storms, or unexpected code being executed during the build, it’s usually related to the WyW evaluation model and how your modules are structured.

Linaria 8 requires Node.js >=22.12.0 (aligned with the WyW 2 / Oxc dependency graph). WyW 2 defaults to eval.strategy: "hybrid", so statically provable values are resolved before falling back to the evaluator for dynamic values.

If your build depends on evaluator-only side effects or exact CSS rule order ties, review the Linaria 8 migration notes in docs/MIGRATION_GUIDE.md.

See https://wyw-in-js.dev/stability for practical guidance and common pitfalls.

Syntax

Linaria can be used with any framework, with additional helpers for React. The basic syntax looks like this:

import { css } from '@linaria/core';
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 className={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 '@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.

Demo

Edit Linaria Demo

Documentation

Contributing

We appreciate any support in library development!

Take a look on Contributing docs to check how you can run Linaria in development mode.

Trade-offs

Interoperability with other CSS-in-JS libraries

Linaria can work together with other CSS-in-JS libraries out-of-the-box. However, if you want to use styled components from Linaria as selectors in styled-components/emotion, you need to use @linaria/interop

Editor Plugins

VSCode

Atom

Webstorm

Sublime Text

Inspiration

Acknowledgements

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.

Made with ❤️ at Callstack

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 [email protected] if you need any help with these or just want to say hi!

Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥

Sponsors

{callstack}

Servers.com

Contributors

Thanks goes to these wonderful people (emoji key):

Paweł Trysła
Paweł Trysła

💻 📖 🤔
Satyajit Sahoo
Satyajit Sahoo

💻 📖 🤔
Michał Pierzchała
Michał Pierzchała

💻 📖 🤔
Lucas
Lucas

📖
Alexey Pronevich
Alexey Pronevich

📖
Wojtek Szafraniec
Wojtek Szafraniec

💻
Anton Evzhakov
Anton Evzhakov

💻 🤔 📖
Tushar Sonawane
Tushar Sonawane

📖 💡
Ferran Negre
Ferran Negre

📖
Jakub Beneš
Jakub Beneš

💻 📖
Oscar Busk
Oscar Busk

🐛 💻
Dawid
Dawid

💻 📖
Kacper Wiszczuk
Kacper Wiszczuk

💻 📖
Denis Rul
Denis Rul

💻
Johan Holmerin
Johan Holmerin

💻 📖
Gilad Peleg
Gilad Peleg

📖
Giuseppe
Giuseppe

💻
Matija Marohnić
Matija Marohnić

💻 📖
Stefan Schult
Stefan Schult

💻
Ward Peeters
Ward Peeters

💻
radoslaw-medryk
radoslaw-medryk

💻
杨兴洲
杨兴洲

💻
Dawid Karabin
Dawid Karabin

📖
Chris Abrams
Chris Abrams

💻 📖 🤔
Jayphen
Jayphen

💻
c4605
c4605

💻
Toru Kobayashi
Toru Kobayashi

💻
Jakub Mazurek
Jakub Mazurek

linaria (callstack/linaria)

Searching Database…

12.4K ·GitHub
What is this?Linaria is a zero-runtime CSS-in-JS library: you write styles in JavaScript or TypeScript, and they are extracted to plain CSS files at build time.
What does 'zero-runtime' actually mean for my app?No styling library ships to the browser. A bundler plugin extracts your styles into regular CSS files during the build, instead of injecting them into the page at runtime like classic CSS-in-JS.
How do I get it running in my project?Install the package and configure your bundler to extract the CSS at build time: Linaria is built on wyw-in-js.dev, with setup guides for webpack, esbuild, Rollup, Vite and Svelte.
Are there version requirements I should know about?Yes: Linaria 8 requires Node.js 22.12.0 or newer, aligned with its WyW 2 / Oxc dependency graph, plus one of the supported bundlers in your project.
What are the main trade-offs before adopting it?Three gotchas: dynamic styles via styled are not supported in IE11; the css tag does not support dynamic styles at all; and modules referenced in CSS rules must be free of side effects.
Does it work only with React, or with any framework?Any framework: the core syntax is plain CSS written in JS, while React users additionally get a styled helper for building components with prop-based dynamic styles.
Is this purely a web thing, or can it style native mobile apps too?It is web-only in scope: the output is standard CSS consumed by browsers, extracted through web bundlers such as webpack, Vite and Rollup.
How do dynamic styles work if nothing runs in the browser?Prop-based styles compile to CSS custom properties (CSS variables) at build time: changing a prop simply switches the variable value, so no runtime style engine is ever involved.
Can I mix Linaria with styled-components or Emotion?Yes, it works together with other CSS-in-JS libraries out of the box. To use Linaria styled components as selectors inside styled-components or Emotion, add the @linaria/interop package.
How do I find out where a generated style came from?Linaria emits CSS sourcemaps, so you can trace a rule in the extracted CSS back to the file and component that defined it, and you can lint your styles in JS with stylelint.
Does it support atomic CSS?Yes, the @linaria/atomic package adds support for atomic styles, useful for fine-grained utility-style rules instead of per-component blocks.
Creator
callstack
Size
33 MB
Stars
12.4K
Age
9y
Commits · 90 Days