summaryrefslogtreecommitdiff
path: root/readme.md
blob: 6023f23f6b37ac1d8e52284b61dbd47a4d3bd605 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# useSunlight

A React hook for the current level of sunlight on an integer scale from `[0,10]`. Solar altitudes in the range `[0, PI]` are mapped to their height above the horizon on the unit circle (scaled up by 10), and all range below the horizon (`[PI, 2PI]`) are mapped to zero.

## Usage

```javascript
// src/demo-component.js
export const DemoComponent = ({ children }) => {
  const [sunlight] = useSunlight()
  const theme = sunlightToTheme(sunlight)
  const style = sunlightToStyle(theme)
  return <div style={style}>{children}</div>
}
```