Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robinweser/react-css-component

Injecting CSS via React Components
https://github.com/robinweser/react-css-component

css css-in-js inline-css react-component reusable-components

Last synced: 30 days ago
JSON representation

Injecting CSS via React Components

Awesome Lists containing this project

README 

        
# CSS via Components



A single React component to inject CSS with ease.


It works with SSR (even using React 16's [renderToNodeStream](https://reactjs.org/docs/react-dom-server.html#rendertonodestream)) and client-side rendering out-of-the-box.


It also provides an *optional* optimisation path.



TravisCI Test Coverage npm version npm downloads dependencies



## Support Me

If you're using [Robin Frischmann](https://rofrischmann.de)'s packages, please consider supporting his [Open Source Work](https://github.com/rofrischmann) on [**Patreon**](https://www.patreon.com/rofrischmann).



## Installation

```sh

# yarn

yarn add react-css-component



# npm

npm i --save react-css-component

```

> **Caution**: It requires `react` and `prop-types` to be present.



## Why?

This package was created as a possible solution to a [question](https://twitter.com/kentcdodds/status/972268883339108352) by [Kent C. Dodds](https://twitter.com/kentcdodds).


Creating resuable React components in general is pretty easy, but adding styling is not. The simplest way is to just use [inline style](https://reactjs.org/docs/dom-elements.html#style), which works pretty well for many basic components. Yet, it is very limited. Neither do we have have pseudo classes nor do we have media queries.


So, at some point, we need actual CSS. We could include a CSS file, but that would require an additional build step e.g. using [Webpack](https://webpack.js.org) in combination with its [css-loader](https://github.com/webpack-contrib/css-loader). While this would work, it's not very compelling to enforce a certain build tool, just to use a single component.


Alright, how about [CSS in JS](http://michelebertoli.github.io/css-in-js/)? Using plain JavaScript to style the component sounds great, as the component is written in JavaScript anyways. But, [most CSS in JS solutions are way to big to depend on](https://github.com/hellofresh/css-in-js-perf-tests#bundle-sizes). They're built for applications, not for independent reusable components. Yet, we can still benefit from writing our CSS in JavaScript. This package is the attempt to provide the smallest universal solution for inlining CSS in JavaScript possible.



## How?

Depending on whether [universal rendering](#universalrendering) (server-side rendering with client-side rehydration) or [client-side only rendering](#clientrendering) is used, the implementation uses a different logic.



### Universal Rendering

**Server Rendering**: The [UniversalStyle](#style) component renders a primitive *style* DOM element that uses `dangerouslySetInnerHTML` to inject a CSS string.


**Client Rehydration**: At first, the [UniversalStyle](#style) component just gets rehydrated to match the server-side markup. But, as soon as it is about to unmount, the *style* element is copied to the `document.head` **once**. This will ensure it's existence just in case any other component using it's CSS is still visible.



#### Caveat

During server-side rendering, the [UniversalStyle](#style) component is not able to track it's own occurence, which may result in duplicate *style* elements. **This won't break anything, but also is not optimal**. To ensure that each [UniversalStyle](#style) instance is only rendered once, we need an unique cache on every render. This is achieved by passing a simple cache via React's context feature. Check the [StyleCacheProvider](#stylecacheprovider) component for more information.



### Client-Only Rendering

If we only render on the client-side anyways, we can skip that complex flow and just use the [ClientStyle](#style).


It simply injects a *style* element into the `document.head` on instantiation and tracks its occurence using a global cache.



> **Note**: The [ClientStyle](#style) component won't throw with server-side rendering, but it simply doesn't render styles.



## When?

It is important to point out, that this component does not fit for every use case.


It is especially built to be used for resuable shared components: If you're building a small React component and want to share it on npm, this is the perfect solution to add styling without having any additional setup on the user-side.


But, it should be used with caution when building applications. It does **not** solve common CSS problems such as specificity issues, global namespace conflicts or autoprefixing. Consider using a [CSS in JS library](http://michelebertoli.github.io/css-in-js/), [CSS Modules](https://github.com/css-modules/css-modules) or whatever tool is actually built with full applications in mind. 



## Style

This component is the core component and is used to inject the CSS.


Both the universal and the client-only version share the exact same API.



### Props



| Parameter | Type | Description |

| --- | --- | --- |

| css | (*string*) | A CSS string that is rendered |



### Import

```javascript

// universal rendering

import { UniversalStyle as Style } from 'react-css-component'



// client-only rendering

import { ClientStyle as Style } from 'react-css-component'

```



### Example

```javascript

const css = `

  .button {

    background-color: darkblue;

    padding: 20px 10px;

    font-size: 16px;

    color: white

  }



  .button:hover {

    background-color: blue

  }

`



// return an array to colocate style and the button

const Button = () => [

  

  Click Me!

]

```



## StyleCacheProvider

The StyleCacheProvider is used to prevent duplication. It is not required, but recommended.


It should wrap your whole application and is only required once, no matter how many components use the [Style](#style) component.


It does not alter the resulting DOM structure as it simply renders its children.


It passes an empty cache object via React's context feature.



> **Tip**: If you're using the [UniversalStyle](#style) component for a reusable shared component, make sure to inform your users about the caveat of not using this component.



### Example

```javascript

import { StyleCacheProvider } from 'react-css-component'



const App = () => (

  

    

  

)

```



## License

react-css-component is licensed under the [MIT License](http://opensource.org/licenses/MIT).


Documentation is licensed under [Creative Common License](http://creativecommons.org/licenses/by/4.0/).


Created with ♥ by [@rofrischmann](http://rofrischmann.de).