Skip to content
Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress πŸ’…
JavaScript Other
Branch: master
Clone or download

Latest commit

Latest commit f0a84f4 May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add note on TS Jan 13, 2020
flow-typed switch back to mainline hoist-non-react-statics (#2934) Dec 23, 2019
packages v5.1.1 May 25, 2020
scripts/jest run all tests except integration ones for now Nov 7, 2019
src/utils add seal fn back to ServerStyleSheet for backward compat (#2581) Nov 7, 2019
.editorconfig Add editorconfig (#30) Sep 30, 2016
.eslintrc.json remove annoying, unnecessary lint checks Nov 7, 2019
.flowconfig update flow to 0.100 Nov 7, 2019
.gitattributes Update test-results.json Nov 29, 2017
.gitignore remove babel-plugin-preval and generate errormap as a build step Nov 7, 2019
.prettierignore prettier Sep 30, 2018
.prettierrc prettier Sep 30, 2018
.travis.yml run ci against v5 Dec 26, 2019
CHANGELOG.md v5.1.1 May 25, 2020
CODE_OF_CONDUCT.md Secure code of conduct links (#2445) Mar 18, 2019
CONTRIBUTING.md Fix typo in CONTRIBUTING.md Mar 7, 2019
CORE_TEAM.md add imbhargav5 to core team Sep 6, 2018
LICENSE Update license year Jan 5, 2018
README.md dynamic size badge Jan 14, 2020
babel-preset.js remove babel-plugin-preval and generate errormap as a build step Nov 7, 2019
babel.config.js Fix more configs after upgrade Nov 7, 2019
lerna.json Move to a mono-repo structure Jan 18, 2019
package.json upgrade wsrun, its buggy output has been annoying me Nov 7, 2019
yarn.lock minor dep updates (#3091) Apr 7, 2020

README.md


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

downloads: 600k/month Join the community on Spectrum gzip 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!

const Button = styled.button`
  color: grey;
`;

Alternatively, you may use style objects. This allows for easy porting of CSS from inline styles, while still supporting the more advanced styled-components capabilities like component selectors and media queries.

const Button = styled.button({
  color: 'grey',
});

Equivalent to:

const Button = styled.button`
  color: grey;
`;

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

Supported by Front End Center. Thank you for making this possible!

Upgrading from v4

  1. npm install styled-components@^5.0.0 react@^16.8 react-dom@^16.8 react-is@^16.8
  2. ??
  3. Profit!

If you use jest-styled-components, make sure you update that too.

Docs

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

Quicklinks to some of the most-visited pages:

Example

import React from 'react';

import styled from 'styled-components';

// Create a <Title> react component that renders an <h1> which is
// centered, palevioletred and sized at 1.5em
const Title = styled.h1`
  font-size: 1.5em;
  text-align: center;
  color: palevioletred;
`;

// Create a <Wrapper> react component that renders a <section> with
// some padding and a papayawhip background
const Wrapper = styled.section`
  padding: 4em;
  background: papayawhip;
`;

// Use them like any other React component – except they're styled!
<Wrapper>
  <Title>Hello World, this is my first styled component!</Title>
</Wrapper>

This is what you'll see in your browser:

Babel Macro

If you're using tooling that has babel-plugin-macros set up, you can switch to the styled-components/macro import path instead to gain the effects of the babel plugin without further setup.

import styled from 'styled-components/macro';

// A static className will be generated for Title (important for SSR)
const Title = styled.h1`
  font-size: 1.5em;
  text-align: center;
  color: palevioletred;
`;

If you wish to provide configuration options to the babel plugin similar to how you would in a .babelrc, see this guide. The config name is "styledComponents".

Built with styled-components

A lot of hard work goes into community libraries, projects, and guides. A lot of them make it easier to get started or help you with your next project! There’s also a whole lot of interesting apps and sites that people have built using styled-components.

Make sure to head over to awesome-styled-components to see them all! And please contribute and add your own work to the list so others can find it.

Contributing

If you want to contribute to styled-components please see our contributing and community guidelines, they'll help you get set up locally and explain the whole process.

Please also note that all repositories under the styled-components organization follow our Code of Conduct, make sure to review and follow it.

Badge

Let everyone know you're using styled-components β†’ style: styled-components

[![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components)

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Licensed under the MIT License, Copyright Β© 2016-present 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.

You can’t perform that action at this time.