Github url

styled-components

by styled-components

styled-components /styled-components

Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without...

30.4K Stars 1.8K Forks Last release: 2 months ago (v5.1.1) MIT License 3.1K Commits 188 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

styled-components

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 Spectrumgzip sizemodule formats: umd, cjs, esmCode Coverage

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 [email protected]^5.0.0 [email protected]^16.8 [email protected]^16.8 [email protected]^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>
</section></wrapper>
</h1>
</title>

This is what you'll see in your browser:

Screenshot of the above code ran in a 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.