Skip to content
Zero-runtime CSS in JS library
JavaScript TypeScript Other
Branch: master
Clone or download
Pull request Compare This branch is 1 commit behind callstack:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore: disable flow check to make CI green (callstack#416) May 17, 2019
.github Add Issue and PR templates (callstack#97) Sep 4, 2017
.vscode chore: setup typescript-styled-plugin for vscode on website (callstac… Oct 18, 2017
__ts-tests__ fix: fix typescript declarations for linaria/x (callstack#277) Dec 11, 2018
bin feat: add a CLI and expose the node API (callstack#227) Jan 7, 2019
docs Changed suggestion for hot style reloading (callstack#422) May 26, 2019
flow-typed/npm chore: update flow-typed defs Feb 24, 2019
src feat: Support webpack's resolve.modules (callstack#387) May 17, 2019
website chore: remove broken integration test Feb 22, 2019
.all-contributorsrc docs: add Anber as a contributor (callstack#316) Feb 21, 2019
.babelrc chore: upgrade deps Feb 22, 2019
.codecov.yml chore: link to coverage report of the branch in pr comment (callstack… Feb 27, 2018
.editorconfig Initial commit May 23, 2017
.eslintignore docs: redo website (callstack#230) Sep 27, 2018
.eslintrc chore: merge with the old linaria repo Sep 14, 2018
.flowconfig chore: merge with the old linaria repo Sep 14, 2018
.gitignore fix: allow customizing cache directory Oct 30, 2018
.release-it.json chore: migrate to release-it v12 (callstack#401) May 16, 2019
CODE_OF_CONDUCT.md doc: Add more badges, CoC and Contributing guide (callstack#95) Sep 4, 2017
CONTRIBUTING.md chore: setup husky and commitlint and update CONTRIBUTING.md Feb 15, 2019
LICENSE chore: add MIT license Oct 23, 2017
README.md chore: update dependencies to enable Greenkeeper 🌴 (callstack#345) Mar 16, 2019
babel.js fix: properly export entrypoints. fixes callstack#216 Sep 17, 2018
commitlint.config.js chore: setup husky and commitlint and update CONTRIBUTING.md Feb 15, 2019
greenkeeper.json chore: update dependencies to enable Greenkeeper 🌴 (callstack#345) Mar 16, 2019
index.d.ts fix: fix typescript declarations for linaria/x (callstack#277) Dec 11, 2018
loader.js fix: properly export entrypoints. fixes callstack#216 Sep 17, 2018
node.js feat: add a CLI and expose the node API (callstack#227) Jan 7, 2019
now.json chore: fix deployement on now Oct 15, 2018
package.json chore: migrate to release-it v12 (callstack#401) May 16, 2019
react.d.ts fix: fix typescript declarations for linaria/x (callstack#277) Dec 11, 2018
react.js fix: properly export entrypoints. fixes callstack#216 Sep 17, 2018
rollup.js feat: add Rollup plugin (callstack#253) Oct 15, 2018
server.d.ts fix: fix typescript declarations for linaria/x (callstack#277) Dec 11, 2018
server.js chore: merge with the old linaria repo Sep 14, 2018
stylelint-config.js feat: add stylelint preprocessor Sep 19, 2018
tsconfig.json chore: update typescript config Dec 11, 2018
tslint.json chore: remove broken integration test Feb 22, 2019
yarn.lock chore: migrate to release-it v12 (callstack#401) May 16, 2019

README.md

Linaria

Zero-runtime CSS in JS library.


Build Status Code Coverage Version MIT License

All Contributors PRs Welcome Chat Code of Conduct Greenkeeper Sponsored by Callstack

tweet

Features

  • Write CSS in JS, but with zero runtime, CSS is extracted to CSS files during build
  • Familiar CSS syntax with Sass like nesting
  • Use dynamic prop based styles with the React bindings, uses CSS variables behind the scenes
  • Easily find where the style was defined with CSS sourcemaps
  • Lint your CSS in JS with stylelint
  • Use JavaScript for logic, no CSS preprocessor needed
  • Optionally use any CSS preprocessor such as Sass or PostCSS

Why use Linaria

Installation

npm install linaria

or

yarn add linaria

Setup

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.

Syntax

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

import { css } from '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 '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

Trade-offs

  • No 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 '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.

Editor Plugins

VSCode

Atom

Recommended Libraries

  • gatsby-plugin-linaria – Gatsby plugin that sets up Babel and webpack configuration for Linaria.
  • polished.js - A lightweight toolset for writing styles in JavaScript.

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 hello@callstack.com if you need any help with these or just want to say hi!

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

💻
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

📖
Anton Evzhakov
Anton Evzhakov

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.