@iamstarkov/theming-issue-5

theming

Unified CSSinJS theming solution for React

• ThemeProvider allows you to pass, update, merge and augment theme through context down react tree.
• withTheme allows you to receive theme and its updates in your components as a theme prop.
• createTheming allows you to integrate theming into your CSSinJS library with custom channel (if you need custom one).

See Motivation for details.

Table of Contents

• Install
• Usage
• Playground demo
• Motivation
• API
  • channel
  • ThemeProvider
  • withTheme
  • createTheming
• Credits
• License

Install

npm install --save theming
# or
yarn add theming

Usage

In your components

Note: this component i will use later to show what theme you will get

import React from 'react';
import { withTheme } from 'theming';

const DemoBox = props => {
  console.log(props.theme);
  return (<div />);
}

export default withTheme(DemoBox);

In your app

import React from 'react';
import { ThemeProvider } from 'theming';
import DemoBox from './components/DemoBox'

const theme = {
  color: 'black',
  background: 'white',
};

const App = () => (
  <ThemeProvider theme={theme}>
    <DemoBox /> {/* { color: 'black', background: 'white' } */}
  </ThemeProvider>
)

export default App;

Playground demo

Be our guest, play with theming in this webpackbin: https://www.webpackbin.com/bins/-Km8TglfWP84oYhDquT1

Motivation

These components are enabling seamless theming for your react applications. And as far as you dont want to pass theme object to each and every component. Thats why you want to use context. But as far context feature is experimental API and it is likely to break in future releases of React you don't want to use it directly. Here theming comes to play.

If you insist on using context despite these warnings, try to isolate your use of context to a small area and avoid using the context API directly when possible so that it's easier to upgrade when the API changes.

If you insist on using context despite these warnings, try to isolate your use of context to a small area and avoid using the context API directly when possible so that it's easier to upgrade when the API changes.
— Context, React documentation

Regarding isolation your use of context to a small area and small areas_ in particular our very own react prophet Dan Abramov have a thing to say:

Should I use React unstable “context” feature?

— Dan Abramov @dan_abramov on Twitter

So you are fine to use context for theming. theming package provides everything you need to do that:

• ThemeProvider allows you to pass and update theme through context down react tree.
• withTheme allows you to receive theme and its updates in your components as a theme prop.
• createTheming allows you to integrate theming into your CSSinJS library with custom channel (if you need custom one).

API

channel

Theming package by default uses this string as a name of the field in context (hence contextTypes and childContextTypes). If you want to build your own components on top of theming, it might be a good idea to not rely on hard coded value, but instead import this value from the package.

import { channel } from 'theming';

console.log(channel); '__THEMING__';

ThemeProvider

React High-Order component, which passes theme object down the react tree by context.

import { ThemeProvider } from 'theming';
const theme = { /*…*/ };

<ThemeProvider theme={theme}>
  <App />
</ThemeProvider>

props

props.theme

Required
Type: Object, Function

If its Object and its root ThemeProvider then its intact and being passed down the react tree.

const theme = { themed: true };

<ThemeProvider theme={theme}>
  <DemoBox /> {/* { themed: true } */}
</ThemeProvider>

If its Object and its nested ThemeProvider then its being merged with theme from parent ThemeProvider and passed down to the react tree.

const theme = { themed: true };
const patch = { merged: true };

<ThemeProvider theme={theme}>
  <ThemeProvider theme={patch}>
    <DemoBox /> {/* { themed: true, merged: true } */}
  </ThemeProvider>
</ThemeProvider>

If its Function and its nested ThemeProvider then its being applied to the theme from parent ThemeProvider. if result is an Object it will be passed down to the react tree, throws otherwise.

const theme = { themed: true };
const augment = outerTheme =>
  Object.assign({}, outerTheme, { augmented: true });

<ThemeProvider theme={theme}>
  <ThemeProvider theme={augment}>
    <DemoBox /> {/* { themed: true, augmented: true } */}
  </ThemeProvider>
</ThemeProvider>

props.children

Required
Type: PropTypes.element

ThemeProvider uses React.Children.only in render, which returns the only child in children. Throws otherwise.

withTheme(component)

React High-Order component, which maps context to theme prop.

component

Required
Type: PropTypes.element

You need to have ThemeProvider with a theme somewhere upper the react tree, after that wrap your component in withTheme and your component will get theme as a prop. withTheme will handle initial theme object as well as theme updates.

PS. It doesnt break if you have PureComponent somewhere in between your ThemeProvider and withTheme (i have tests for that).

Usage with Component:

import React from 'react';
import { withTheme } from 'theming';

const DemoBox = props => {
  console.log(props.theme);
  return (<div />);
}

export default withTheme(DemoBox);

In the app:

import React from 'react';
import { ThemeProvider } from 'theming';
import DemoBox from './components/DemoBox'

const theme = {
  color: 'black',
  background: 'white',
};

const App = () => (
  <ThemeProvider theme={theme}>
    <DemoBox /> {/* { color: 'black', background: 'white' } */}
  </ThemeProvider>
)

export default App;

createTheming(customChannel)

Function to create ThemeProvider and withTheme with custom context channel.

customChannel

Type: String
Default: __THEMING__
Result: Object { channel, withTheme, ThemeProvider }

withTheme and ThemeProvider are the same as default ones, but with overwritten context channel.

channel is customChannel to track what is context channel.

import { createTheming } from 'theming';

const theming = createTheming('__styled-components__');

const { channel, withTheme, ThemeProvider } = theming;

export default {
  channel,
  withTheme,
  ThemeProvider,
};

Credits

• Thanks to jss creator Oleg Slobodskoi @kof for immersive help, support and code review.
• Thanks to styled-components creator Max Stoiber @mxstbr for initial and battle tested implementation of theming support in styled-components as well as help and code review.
• Thanks to styled-components' core team member Phil Plückthun @philpl for help and code review.
• Thanks to glamorous creator Kent C. Dodds @kentcdodds for help, support and code review.
• Thanks to glamorous's core team member Alessandro Arnodo @vesparny for improved theming support in glamorous and brcast.
• Thanks to Gert Sallaerts @gertt for the playground demo.

License

MIT © Vladimir Starkov