Reflexbox

Responsive React Flexbox Grid System

http://jxnblk.com/reflexbox


Features

- Simple API for quickly controlling layout
- Helps promote composability and separation of concerns
- CSS-in-JS built in - no external dependencies
- Only generates the CSS needed to render

Getting Started

``
npm install reflexbox
`

`jsx
import React from 'react'
import { Flex, Box } from 'reflexbox'

class Component extends React.Component {
render() {
return (

Box A
Box B

)
}
}
`

Usage

`jsx
// Fractional width


// Pixel width


// Responsive widths


// Padding


// Responsive padding


// Margin


// Responsive margin


// top, right, bottom, left
mt={1}
mr={2}
mb={3}
ml={2}
/>

// x-axis


// y-axis


// align-items: center


// justify-content: space-between


// Flex wrap


// Flex direction column


// Order


// flex: 1 1 auto

`

API

$3

Component primitive with display: flex

$3

Primitive for controlling width, margin, padding and more.

$3

Both and share the same props.

- w (number|string) sets width, where numbers 0-1 are percentage values, larger numbers are pixel values, and strings are raw CSS values with units.
- flex (boolean) sets display: flex
- wrap (boolean) sets flex-wrap: wrap
- column (boolean) sets flex-direction: column
- auto (boolean) sets flex: 1 1 auto
- order (number) sets order
- align (string) sets align-items
- justify (string) sets justify-content

#### Margin and Padding

Margin and padding props accept numbers 0-4 for values from the spacing scale [ 0, 8, 16, 32, 64 ].
Numbers greater than 4 will be used as pixel values.
Negative values can be used for negative margins.
Strings can be passed for other CSS values, e.g. mx='auto'

- m (number|string) margin based on a scale from 0–4.
- mx (number|string) x-axis margin based on a scale from 0–4.
- my (number|string) y-axis margin based on a scale from 0–4.
- mt (number|string) margin-top based on a scale from 0–4.
- mb (number|string) margin-bottom based on a scale from 0–4.
- ml (number|string) margin-left based on a scale from 0–4.
- mr (number|string) margin-right based on a scale from 0–4.
- p (number|string) padding based on a scale from 0–4.
- px (number|string) x-axis padding based on a scale from 0–4.
- py (number|string) y-axis padding based on a scale from 0–4.
- pt (number|string) padding-top based on a scale from 0–4.
- pb (number|string) padding-bottom based on a scale from 0–4.
- pl (number|string) padding-left based on a scale from 0–4.
- pr (number|string) padding-right based on a scale from 0–4.

$3

All props accept arrays as values for mobile-first responsive styles.

`jsx
// Set widths for different breakpoints, starting from smallest to largest
// This example will be 100% width below the smallest breakpoint,
// then 50% and 25% for the next two breakpoints respectively

`

Null values can be passed to the array to skip a breakpoint.

`jsx

`

Configuration

Values for the breakpoints and space scale can be configured with
React Context.

Context can be set manually or with the component.


`jsx
import React from 'react'
import { ReflexProvider, Flex, Box } from 'reflexbox'

const space = [ 0, 6, 12, 18, 24 ]
const breakpoints = [ 32, 48, 64 ]

class App extends React.Component {
render () {
return (
space={space}
breakpoints={breakpoints}>

Box
Box
Box
Box


)
}
}
`

Higher Order Component

The core Reflexbox higher-order component can be used on any element that accepts className as a prop.

`jsx
import React from 'react'
import { reflex } from 'reflexbox'
import MyInput from './MyInput'

const FlexInput = reflex(MyInput)

const App = () => (

w={1/2}
mb={2}
defaultValue='Flex Input'
/>

)
`

$3

This currently DOES NOT work in Node.js server-side applications.
If you need server-side support, see version ^2.2.0` or one of the related libraries below.

---

$3

- Axs
- Grid Styled
- Gx
- Rebass
- Reline

MIT License