Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chentsulin/styled-css-modules-component
Build styled component with css-modules
https://github.com/chentsulin/styled-css-modules-component
component css-modules react style styled-components
Last synced: 2 months ago
JSON representation
Build styled component with css-modules
- Host: GitHub
- URL: https://github.com/chentsulin/styled-css-modules-component
- Owner: chentsulin
- License: mit
- Created: 2017-01-30T19:14:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T02:45:29.000Z (almost 8 years ago)
- Last Synced: 2024-10-05T01:45:45.002Z (3 months ago)
- Topics: component, css-modules, react, style, styled-components
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 15
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# styled-css-modules-component
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][david_img]][david_site]
> Build styled component with css-modules
`styled-component` forces developers use clearer way to add styles to the components which looks great to me, but there are still some difficult unsolved issues in CSS-in-JS area, even after `radium`, `aphrodite` and a lot of libraries involved.
`css-modules` is a good choice for getting modularization without being as cutting-edge as the CSS-in-JS approaches. You can just write css and get full superpower from PostCSS ecosystem!
## Install
```sh
$ npm install styled-css-modules-component
```
> Note: You have to setup your own css-modules environment.
## Usage
### Basic
`styles.css`:
```css
.title {
font-size: 1.5em;
text-align: center;
color: palevioletred;
}
.wrapper {
padding: 4em;
background: papayawhip;
}
```
This creates two react components, `` and ``:
```js
import React from 'react';
import styled from 'styled-css-module-components';
import styles from './styles.css';
// Create a react component that renders an
which is
// centered, palevioletred and sized at 1.5em
const Title = styled.h1(styles.title);
// Create a react component that renders a with
// some padding and a papayawhip background
const Wrapper = styled.section(styles.wrapper);
```
You render them like so:
```jsx
// Use them like any other React component – except they're styled!
Hello World, this is my first styled css modules component!
```
Checkout full examples [here](https://github.com/chentsulin/styled-css-modules-component/blob/master/examples/basic/components/App.js).
### Passed props
`styles.css`:
```css
.input {
font-size: 1.25em;
padding: 0.5em;
margin: 0.5em;
color: palevioletred;
background: papayawhip;
border: none;
border-radius: 3px;
}
```
Styled components pass on all their props. This is a styled ``:
```js
import React from 'react';
import styled from 'styled-css-modules-components';
import styles from './styles.css';
// Create an component that'll render an tag with some styles
const Input = styled.input(styles.input);
```
You can just pass a `placeholder` prop into the `styled-css-modules-component`. It will pass it on to the DOM node like any other react component:
```jsx
// Render a styled input with a placeholder of "@chentsulin"
```
Checkout full examples [here](https://github.com/chentsulin/styled-css-modules-component/blob/master/examples/passed-props/components/App.js).
## Third-party components
`styles.css`:
```css
.link {
color: palevioletred;
display: block;
margin: 0.5em 0;
font-family: Helvetica, Arial, sans-serif;
}
```
The above also works perfectly for styling third-party components, like a `react-router` ``!
```js
import styled from 'styled-css-modules-components';
import { Link } from 'react-router';
const StyledLink = styled(Link)(styles.link);
```
```jsx
Standard, unstyled Link
This Link is styled!
```
Checkout full examples [here](https://github.com/chentsulin/styled-css-modules-component/blob/master/examples/third-party-components/components/App.js).
## Animations
Directly supported by CSS.
## Overriding component styles & Theming
See the long discusses at [css-modules #147](https://github.com/css-modules/css-modules/issues/147).
## React Native
Not supported.
## Relevant Projects
- [styled-component](https://github.com/styled-components/styled-components)
- [css-literal-loader](https://github.com/4Catalyzer/css-literal-loader)
## License
MIT © [C.T. Lin](https://github.com/chentsulin/styled-css-modules-component)
[npm-image]: https://badge.fury.io/js/styled-css-modules-component.svg
[npm-url]: https://npmjs.org/package/styled-css-modules-component
[travis-image]: https://travis-ci.org/chentsulin/styled-css-modules-component.svg
[travis-url]: https://travis-ci.org/chentsulin/styled-css-modules-component
[coveralls-image]: https://coveralls.io/repos/chentsulin/styled-css-modules-component/badge.svg?branch=master&service=github
[coveralls-url]: https://coveralls.io/r/chentsulin/styled-css-modules-component?branch=master
[david_img]: https://david-dm.org/chentsulin/styled-css-modules-component.svg
[david_site]: https://david-dm.org/chentsulin/styled-css-modules-component