npm package: @hypobox/react
Description: Tiny React Box component.
Author: estrattonbailey
Latest version: 1.5.0

# @hypobox/react

[![npm version](https://img.shields.io/npm/v/@hypobox/react?style=flat&colorA=4488FF&colorB=4488FF)](https://www.npmjs.com/package/@hypobox/react) [![test coverage](https://img.shields.io/coveralls/github/sure-thing/hypobox-react?style=flat&colorA=223355&colorB=223355)](https://coveralls.io/github/sure-thing/hypobox-react?branch=main) [![npm bundle size](https://badgen.net/bundlephobia/minzip/@hypobox/react?color=223355&labelColor=223355)](https://bundlephobia.com/result?p=@hypobox/react)

Minimalist CSS-in-JS solution for React. Built with
[hypostyle](https://github.com/sure-thing/hypostyle).

```bash
npm i @hypobox/react hypostyle react
```

## Usage

To use `@hypobox/react`, first have a look at
[hypostyle](https://github.com/sure-thing/hypostyle). Basically, you provide
`@hypobox/react` a `hypostyle` instance, and then you style components using attributes
on React components that match your `hypostyle` setup.

### Setup

```jsx
import React from 'react'
import { render } from 'react-dom'
import { hypostyle } from 'hypostyle'
import presets from 'hypostyle/presets'
import { Hypo } from '@hypobox/react'

const instance = hypostyle(presets)

render(
  <Hypo hypostyle={instance}>
    <App />
  </Hypo>
)
```

### Styling

In `hypobox`, all styling is done via the `Box` component.

```jsx
import { Box } from '@hypobox/react'

function App() {
  return <Box color="tomato">Hello world!</Box>
}
```

If you've configured `shorthands` in your `hypostyle` instance (or are using
the presets), you can also use those:

```jsx
<Box c="tomato">Hello world!</Box>
```

### Responsive Styles

Just like `hypostyle`, you can pass arrays or objects to denote responsive
values:

```jsx
<Box display={['none', 'none', 'flex']} />
```

Or:

```jsx
<Box display={{ 2: 'flex' }} />
```

### Macros & Variants

`macros` especially shine when used with JSX. Imagine the following config:

```jsx
const instance = hypostyle({
  macros: {
    caps: { textTransform: 'uppercase' },
  },
  variants: {
    link: {
      primary: {
        c: 'blue',
        '&:hover': {
          c: 'black',
        },
      },
    },
  },
})
```

You can reference those values like this:

```jsx
<Box as="a" caps link="primary">
  Click me!
</Box>
```

### Custom Styles

For props you don't have configured as shorthands, or for custom values and
breakpoints, use the `cx` prop. Examples:

```jsx
<Box cx={{ c: 'tomato' }} />
<Box cx={{
  '@media (max-width: 567px)': {
    display: 'none'
  }
}} />
```

`cx` also supports passing a function. The function will be
callled with the full `theme` you passed you `hypostyle` instance:

```jsx
<Box
  cx={(theme) => ({
    c: theme.tokens.colors.primary,
  })}
/>
```

### Defaults and Extending Components

If you like, `compose` provides a familiar interface:

```javascript
import { compose } from '@hypobox/react'

const H1 = compose('h1', { fs: 1 })
```

And you can use it to extend components as well:

```javascript
const Headline = compose(H1, { color: 'primary' })
```

### Server Rendering

SSR is very simple. Complete example:

```javascript
import React from 'react'
import { renderToString } from 'react-dom/server'
import { hypostyle } from 'hypostyle'
import presets from 'hypostyle/presets'
import { Hypo, Box } from '@hypobox/react'

const instance = hypostyle(presets)

const body = renderToString(
  <Hypo hypostyle={instance}>
    <Box f aic jcc>
      Flexy centered content
    </Box>
  </Hypo>
)

const stylesheet = hypo.flush()

const html = `
<!DOCTYPE html>
<html>
  <head>
    <style>${stylesheet}</style>
  </head>
  <body>${body}</body>
</html>
`
```

### Related

- [hyposcript](https://github.com/sure-thing/hyposcript)
- [hypostyle](https://github.com/sure-thing/hypostyle)
- [hypobox](https://github.com/sure-thing/hypobox)
- [styled-system](https://github.com/styled-system/styled-system)
- [nano-css](https://github.com/streamich/nano-css)

### License

MIT License © [Sure Thing](https://github.com/sure-thing)