188 lines
9.6 KiB
Markdown
188 lines
9.6 KiB
Markdown
<div align="center">
|
||
<a href="https://www.styled-components.com">
|
||
<img alt="styled-components" src="https://raw.githubusercontent.com/styled-components/brand/master/styled-components.png" height="150px" />
|
||
</a>
|
||
</div>
|
||
|
||
<br />
|
||
|
||
<div align="center">
|
||
<strong>Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress 💅</strong>
|
||
<br />
|
||
<br />
|
||
<a href="https://www.npmjs.com/package/styled-components"><img src="https://www.styled-components.com/proxy/downloads.svg" alt="downloads: 600k/month"></a>
|
||
<a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/styled-components/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/styled-components/sponsors/badge.svg" /></a> <a href="https://discord.gg/hfGUrbrxaU">
|
||
<img alt="Discord" src="https://img.shields.io/discord/818449605409767454?logo=discord" /></a>
|
||
<a href="https://bundlephobia.com/result?p=styled-components" title="styled-components latest minified+gzip size"><img src="https://badgen.net/bundlephobia/minzip/styled-components" alt="gzip size"></a>
|
||
<a href="#alternative-installation-methods"><img src="https://img.shields.io/badge/module%20formats-umd%2C%20cjs%2C%20esm-green.svg" alt="module formats: umd, cjs, esm"></a>
|
||
<a href="https://codecov.io/gh/styled-components/styled-components"><img src="https://codecov.io/gh/styled-components/styled-components/coverage.svg?branch=main" alt="Code Coverage"></a>
|
||
</div>
|
||
|
||
---
|
||
|
||
## Looking for v5?
|
||
|
||
The `main` branch is under development of the upcoming v6 major version of styled-components. For changes targeting v5, please point your PRs at the `legacy-v5` branch.
|
||
|
||
---
|
||
|
||
Utilizing [tagged template literals](https://www.styled-components.com/docs/advanced#tagged-template-literals) (a recent addition to JavaScript) and the [power of CSS](https://www.styled-components.com/docs/api#supported-css), `styled-components` allow 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!
|
||
|
||
```jsx
|
||
const Button = styled.button`
|
||
color: grey;
|
||
`;
|
||
```
|
||
|
||
Alternatively, you may use [style objects](https://www.styled-components.com/docs/advanced#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.
|
||
|
||
```jsx
|
||
const Button = styled.button({
|
||
color: 'grey',
|
||
});
|
||
```
|
||
|
||
Equivalent to:
|
||
|
||
```jsx
|
||
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](https://www.styled-components.com/docs/basics#react-native) for more information.
|
||
|
||
_Supported by [Front End Center](https://frontend.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`
|
||
1. ??
|
||
1. Profit!
|
||
|
||
> If you use jest-styled-components, make sure you update that too.
|
||
|
||
## [Docs](https://www.styled-components.com/docs)
|
||
|
||
**See the documentation at [styled-components.com/docs](https://www.styled-components.com/docs)** for more information about using `styled-components`!
|
||
|
||
Quicklinks to some of the most-visited pages:
|
||
|
||
- [**Getting started**](https://www.styled-components.com/docs/basics)
|
||
- [API Reference](https://styled-components.com/docs/api)
|
||
- [Theming](https://www.styled-components.com/docs/advanced#theming)
|
||
- [Server-side rendering](https://www.styled-components.com/docs/advanced#server-side-rendering)
|
||
- [Tagged Template Literals explained](https://www.styled-components.com/docs/advanced#tagged-template-literals)
|
||
|
||
## Example
|
||
|
||
<!-- prettier-ignore -->
|
||
```JSX
|
||
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:
|
||
|
||
<div align="center">
|
||
<a href="https://styled-components.com">
|
||
<img alt="Screenshot of the above code ran in a browser" src="http://i.imgur.com/wUJpcjY.jpg" />
|
||
</a>
|
||
</div>
|
||
|
||
## 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.
|
||
|
||
```js
|
||
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](https://github.com/kentcdodds/babel-plugin-macros/blob/main/other/docs/author.md#config-experimental). 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 are 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](https://github.com/styled-components/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](./CONTRIBUTING.md), 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](./CODE_OF_CONDUCT.md), make sure to review and follow it.
|
||
|
||
## Badge
|
||
|
||
Let everyone know you're using _styled-components_ → [](https://github.com/styled-components/styled-components)
|
||
|
||
```md
|
||
[](https://github.com/styled-components/styled-components)
|
||
```
|
||
|
||
## Contributors
|
||
|
||
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
||
<a href="https://github.com/styled-components/styled-components/graphs/contributors"><img src="https://opencollective.com/styled-components/contributors.svg?width=890" /></a>
|
||
|
||
## Backers
|
||
|
||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/styled-components#backer)]
|
||
|
||
<a href="https://opencollective.com/styled-components#backers" target="_blank"><img src="https://opencollective.com/styled-components/backers.svg?width=890"></a>
|
||
|
||
## Sponsors
|
||
|
||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/styled-components#sponsor)]
|
||
|
||
<a href="https://opencollective.com/styled-components/sponsor/0/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/0/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/1/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/1/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/2/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/2/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/3/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/3/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/4/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/4/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/5/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/5/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/6/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/6/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/7/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/7/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/8/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/8/avatar.svg"></a>
|
||
<a href="https://opencollective.com/styled-components/sponsor/9/website" target="_blank"><img src="https://opencollective.com/styled-components/sponsor/9/avatar.svg"></a>
|
||
|
||
## License
|
||
|
||
Licensed under the MIT License, Copyright © 2016-present Glen Maddern and Maximilian Stoiber.
|
||
|
||
See [LICENSE](./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](https://github.com/okonet) for the fantastic logo.
|