Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress πŸ’…
Clone or download
probablyup add ThemeConsumer & ThemeContext exports to RN, primitives entries (#…
…2217)

* add ThemeConsumer & ThemeContext exports to RN, primitives entries

closes #2213

* add changelog
Latest commit 83b0dc4 Nov 15, 2018
Permalink
Failed to load latest commit information.
.github add envinfo command to issue template Mar 7, 2018
benchmarks prettier Sep 30, 2018
docs use React.forwardRef Aug 22, 2018
example prettier Sep 30, 2018
flow-typed better typing for @emotion/unitless Nov 1, 2018
integration-test upgrade testing & linting stuff Sep 30, 2018
macro Add a babel-macro (#2032) Oct 8, 2018
native move special builds to their top level folders, add back jsnext:main … Sep 5, 2018
primitives move special builds to their top level folders, add back jsnext:main … Sep 5, 2018
sandbox update sandbox Nov 1, 2018
scripts add protocol to open collective link Oct 5, 2018
src add ThemeConsumer & ThemeContext exports to RN, primitives entries (#… Nov 15, 2018
test-utils add enzymeFind test-util Oct 2, 2018
.babelrc Flat bundles for each possible entry Dec 19, 2017
.babelrc.js react-native v0.54 Sep 30, 2018
.editorconfig Add editorconfig (#30) Sep 30, 2016
.eslintignore update sandbox Nov 1, 2018
.eslintrc.json don't do flow through eslint Nov 10, 2018
.flowconfig update sandbox Nov 1, 2018
.gitattributes Update test-results.json Nov 29, 2017
.gitignore Add component-based global styling API (#1867) Aug 27, 2018
.jest.integration.json Use new context API (#1894) Aug 12, 2018
.jest.native.json remove last remaining __DEV__ code Nov 11, 2018
.jest.primitives.json remove last remaining __DEV__ code Nov 11, 2018
.npmignore Add --tracing to benchmarks Jul 5, 2018
.prettierignore prettier Sep 30, 2018
.prettierrc prettier Sep 30, 2018
.travis.yml run bundle size on ci Oct 8, 2018
CHANGELOG.md add ThemeConsumer & ThemeContext exports to RN, primitives entries (#… Nov 15, 2018
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md Jul 4, 2017
CONTRIBUTING.md Add docs about running the benchmarks Jul 5, 2018
CORE_TEAM.md add imbhargav5 to core team Sep 6, 2018
LICENSE Update license year Jan 5, 2018
README.md add a note on babel macro config Oct 15, 2018
appveyor.yml just run appveyor for web Oct 15, 2018
package.json v4.1.1 Nov 12, 2018
rollup.config.js make the standalone build umd-compliant Nov 12, 2018
yarn.lock update lockfile Nov 12, 2018

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!

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!

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.