⚠️ CANARY: This is the
styled-components. It is published under the
@alphatag on npm and contains new features and changes for the next major version.
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 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
npm install styled-components@alpha react@^16.8 react-dom@^16.8 react-is@^16.8
Note that integrations like
jest-styled-componentsthat make use of internals will need to be updated to work with v5 and likely will not work properly during the alpha/beta period.
See the documentation at styled-components.com/docs for more information about using
Quicklinks to some of the most-visited pages:
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.5emconst 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 backgroundconst 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:
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.
;// A static className will be generated for Title (important for SSR)const Title = styledh1`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
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.
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.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Licensed under the MIT License, Copyright © 2016-present Glen Maddern and Maximilian Stoiber.
See LICENSE for more information.
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.