探客时代
Linaria
Zero-runtime CSS in JS library
README
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]](#contributors) [![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
- 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
- Supports atomic styles with @linaria/atomic
Installation
- ```sh
- npm install @linaria/core @linaria/react @linaria/babel-preset
- ```
or
- ```sh
- yarn add @linaria/core @linaria/react @linaria/babel-preset
- ```
Setup
Linaria currently supports webpack and Rollup to extract the CSS at build time. To configure your bundler, check the following guides:
- webpack
- esbuild
- Rollup
- Vite
- Svelte
Or configure Linaria with one of the following integrations:
- Preact
- Gatsby
Optionally, add the @linaria 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:
- ``` json
- {
- "presets": [
- "@babel/preset-env",
- "@babel/preset-react",
- "@linaria"
- ]
- }
- ```
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:
- ``` js
- 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 thestyled helper, which makes it easy to write React components with dynamic styles with a styled-component like syntax:
- ``` js
- 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
Documentation
- Basics
- [Dynamic styles with css tag](/docs/DYNAMIC_STYLES.md)
- Theming
- webpack
- Rollup
- CLI
- Linting
- Example
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
- 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](/docs/DYNAMIC_STYLES.md) for alternative approaches.
- Modules used in the CSS rules cannot have side-effects.
For example:
- ``` js
- import { css } from '@linaria/core';
- 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.
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
- Syntax Highlighting - language-babel
- Autocompletion - vscode-styled-components
- Linting - stylelint
Atom
- Syntax Highlighting and Autocompletion - language-babel
Webstorm
- Syntax Highlighting & Autocompletion - webstorm-styled-components
Sublime Text
- Syntax Highlighting & Autocompletion - Naomi, JSCustom (refer to document on how to turn on Styled Component syntax)
- Linting - SublimeLinter-stylelint, LSP Stylelint
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
- glam
Acknowledgements
This project wouldn't have been possible without the following libraries or the people behind them.
- babel
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!
Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥
Sponsors
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
[build-badge]: https://img.shields.io/circleci/project/github/callstack/linaria/master.svg?style=flat-square
[build]: https://circleci.com/gh/callstack/linaria
[coverage-badge]: https://img.shields.io/codecov/c/github/callstack/linaria.svg?style=flat-square
[coverage]: https://codecov.io/github/callstack/linaria
[version-badge]: https://img.shields.io/npm/v/linaria.svg?style=flat-square
[package]: https://www.npmjs.com/package/linaria
[license-badge]: https://img.shields.io/npm/l/linaria.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs-welcome]: https://github.com/callstack/linaria/blob/master/CONTRIBUTING.md
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/callstack/linaria/blob/master/CODE_OF_CONDUCT.md
[all-contributors-badge]: https://img.shields.io/badge/all_contributors-23-orange.svg?style=flat-square
[chat-badge]: https://img.shields.io/discord/426714625279524876.svg?style=flat-square&colorB=758ED3
[chat]: https://discord.gg/zwR2Cdh
[tweet-badge]: https://img.shields.io/badge/tweet-%23linaria-blue.svg?style=flat-square&colorB=1DA1F2&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAUCAYAAACXtf2DAAAAAXNSR0IArs4c6QAAAaRJREFUOBGtlM8rBGEYx3cWtRHJRaKcuMtBSitxkCQ3LtzkP9iUUu5ODspRHLhRLtq0FxeicEBC2cOivcge%2FMgan3fNM8bbzL4zm6c%2BPT%2Fe7%2FO8887svrFYBWbbtgWzsAt3sAcpqJFxxF1QV8oJFqFPFst5dLWQAT87oTgPB7DtziFRT1EA4yZolsFkhwjGYFRO8Op0KD8HVe7unoB6PRTBZG8IctAmG1xrHcfkQ2B55sfI%2ByGMXSBqV71xZ8CWdxBxN6ThFuECDEAL%2Bc9HIzDYumVZ966GZnX0SzCZvEqTbkaGywkyFE6hKAsBPhFQ18uPUqh2ggJ%2BUor%2F4M%2F%2FzOC8g6YzR1i%2F8g4vvSI%2ByD7FFNjexQrjHd8%2BnjABI3AU4Wl16TuF1qANGll81jsi5qu%2Bw6XIsCn4ijhU5FmCJpkV6BGNw410hfSf6JKBQ%2FUFxHGYBnWnmOwDwYQ%2BwzdHqO75HtiAMJfaC7ph32FSRJCENUhDHsLaJkL%2FX4wMF4%2BwA5bgAcrZE4sr0Cu9Jq9fxyrvBHWbNkMD5CEHWTjjT2m6r5D92jfmbbKJEWuMMAAAAABJRU5ErkJggg%3D%3D
[tweet]: https://twitter.com/intent/tweet?text=Check%20out%20linaria!%20https://github.com/callstack/linaria%20%F0%9F%91%8D
[greenkeeper-badge]: https://badges.greenkeeper.io/callstack/linaria.svg
[greenkeeper]: https://greenkeeper.io/
[callstack-badge]: https://callstack.com/images/callstack-badge.svg
[callstack]: https://callstack.com/open-source/?utm_source=github.com&utm_medium=referral&utm_campaign=linaria&utm_term=readme
