summaryrefslogtreecommitdiff
path: root/readme.md
blob: 5fb5334a2059a3f000d8f01afd5b182946b0c3f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# sunlight-theme

[![CircleCI](https://circleci.com/gh/nvandoorn/sunlight-theme.svg?style=shield)](https://circleci.com/gh/nvandoorn/sunlight-theme)

A theme provider for `@emotion/core` and `emotion-theming` that supplies the level of sunlight with `use-sunlight`. Supports middleware via a prop.

## Demo

[https://optimistic-kalam-56c21b.netlify.com](https://optimistic-kalam-56c21b.netlify.com)

## Usage

```javascript
// src/demo-component.js

// define an array of 11 colours
const mainRange = colormap({
  colormap: 'autumn',
  nshades: 11,
  format: 'hex',
  alpha: 1
})

// define an emotion style
const containerStyle = ({ colours }) => css`
  color: ${colours.main};
`

// define a middleware function that translates
// the light level to a "theme" (some object
// that's useful for styles)
const colourMiddleware = theme => {
  return {
    ...theme,
    colours: {
      main: mainRange[theme.lightLevel]
    }
  }
}

export const DemoComponent = ({ children }) => {
  // middleware is optional but encouraged
  // for mapping light level to colours
  return (
    <SunlightTheme middleware={[colourMiddleware]}>
      <div css={containerStyle}>{children}</div>
    </SunlightTheme>
  )
}
```