node package manager

styled-components

styled-components

Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress ๐Ÿ’…

npm install --save styled-components

npm Join the community on Spectrum

gzip size size module formats: umd, cjs, esm

Utilising tagged template literals (a recent addition to JavaScript) and the power of CSS, styled-components allows you to write actual CSS code to style your components. It also removes the mapping between components and styles โ€“ using components as a low-level styling construct could not be easier!

styled-components is compatible with both React (for web) and ReactNative โ€“ meaning it's the perfect choice even for truly universal apps! See the documentation about ReactNative for more information.

Note: If you're not using npm as your package manager, aren't using a module bundler or aren't sure about either of those jump to Alternative Installation Methods.

Made by Glen Maddern, Max Stoiber and Phil Plรผckthun, supported by Front End Center and Thinkmill. Thank you for making this project possible!

Docs

See the documentation at styled-components.com/docs for more information about using styled-components!

Quicklinks

Quicklinks to some of the most-visited pages:

Linting

There is (currently experimental) support for stylelint โ€“ meaning you can take advantage of 150 rules to make sure your styled-components CSS is solid!

Recording of stylelint correctly reporting errors in a styled components' CSS

See the stylelint-processor-styled-components repository for installation instructions.

Syntax highlighting

The one thing you lose when writing CSS in template literals is syntax highlighting. We're working hard on making proper syntax highlighting happening in all editors. We currently have support for Atom, Visual Studio Code, and soon Sublime Text.

This is what it looks like when properly highlighted:

Syntax highlighted styled component

Atom

@gandm, the creator of language-babel, has added support for styled-components in Atom!

To get proper syntax highlighting, all you have to do is install and use the language-babel package for your JavaScript files!

Sublime Text

There is an open PR by @garetmckinley to add support for styled-components to babel-sublime! (if you want the PR to land, feel free to ๐Ÿ‘ the initial comment to let the maintainers know there's a need for this!)

As soon as that PR is merged and a new version released, all you'll have to do is install and use babel-sublime to highlight your JavaScript files!

Visual Studio Code

@gandm's language-babel has been ported to VSCode under the name Babel JavaScript by Michael McDermott. It provides the same all-in-one solution for Babel syntax highlighting with styled-components included.

If you would like to keep your current JavaScript syntax highlighting, you can use the vscode-styled-components extension to provide styled-components syntax highlighting inside your Javascript files. You can install it as usual from the Marketplace.

VIM / NeoVim

The vim-styled-components plugin gives you syntax highlighting inside your Javascript files. Install it with your usual plugin manager like Plug, Vundle, Pathogen, etc.

Also if you're looking for an awesome javascript syntax package you can never go wrong with YAJS.vim.

Other Editors

We could use your help to get syntax highlighting support to other editors! If you want to start working on syntax highlighting for your editor, open an issue to let us know.

Built with styled-components

Libraries

Grid Systems

Helpers

  • styled-props: Simple lib that allows you to set styled props in your styled-components without stress (demo)
  • styled-components-breakpoint: Utility function for using breakpoints with styled-components.
  • styled-theme: Extensible theming system for styled-components.
  • styled-tools: Useful interpolated functions for styled-components.
  • styled-ax: Functional theme property accessor(s)
  • react-create-component-from-tag-prop: Create a react component from a tag prop. Lets your users to choose which HTML elements get styled by your ๐Ÿ’… styled-components.
  • styled-components-theme: A library for refering to theme colors and modifying them inline. e.g. color: ${primary.lighten(0.3)};
  • styled-map: Super simple lib to map props to styles with styled-components
  • styled-system: Design system utilities for styled-components โ€“ used in grid-styled and Rebass (demo)
  • styled-shortcuts: Use simple string notation to access props. No functions necessary! Example: font-size: ${'theme.fontSize:px'}; (demo)
  • styled-shortcut-components: A convenience package that wraps styled-components with styled-shortcuts.
  • styled-media-query: Easily and beautifully use media queries with styled-component with custom breakpoints

Boilerplates

Websites

Other

Built something with styled-components? Submit a PR and add it to this list!

Further Reading

These are some great articles and talks about related topics in case you're hungry for more:

Alternative Installation Methods

If you're not using a module bundler or not using npm as your package manager, we also have a global ("UMD") build!

You can use that via the unpkg CDN to get styled-components, the URL is https://unpkg.com/styled-components/dist/styled-components.min.js.

To install styled-components with bower you'd do:

bower install styled-components=https://unpkg.com/styled-components/dist/styled-components.min.js

To use it from your HTML, add this at the bottom of your index.html, and you'll have access to the global window.styled variable:

<scriptย src="https://unpkg.com/styled-components/dist/styled-components.min.js"ย type="text/javascript"></script>

Other solutions

If styled-components isn't quite what you're looking for, maybe something in this list is:

  • glamorous - basically styled-components but using JS objects and functions instead of strings.

License

Licensed under the MIT License, Copyright ยฉ 2017 Glen Maddern and Maximilian Stoiber.

See LICENSE for more information.

Acknowledgements

This project builds on a long line of earlier work by clever folks all around the world. We'd like to thank Charlie Somerville, Nik Graf, Sunil Pai, Michael Chan, Andrey Popp, Jed Watson & Andrey Sitnik who contributed ideas, code or inspiration.

Special thanks to @okonet for the fantastic logo.