react-flex-element

Flexbox elements for React.

<Flex row spaceBetween gap={32}>
  <FlexItem selfStart />
  <FlexItem shrink grow />
  <Flex
    selfStretch
    column
    spaceBetween
    alignEnd
    gap={16}
    grow={2}
  >
    <FlexItem selfStretch />
    <FlexItem selfCenter />
    <FlexItem grow />
  </Flex>
</Flex>

Live Example

Tl;dr

You don't know CSS Flexbox? Read here!

2 components:

• <Flex />
  • creates a flex container.
  • provides EVERY Flexbox property.
• <FlexItem />
  • creates a flexed item.
  • provides Flexbox properties for items only.

3 ways to set properties:

• flags (row, start, stretch, ecc...)
• classic properties (display, flexDirection, justifyContent, ecc...)
• short version of classic properties (justify, align, self, ecc...)

Install

# Install via NPM
npm i react-flex-element
# or Yarn
yarn add react-flex-element

Usage

Every Flexbox property can be set via one or more dedicated props.

Flexible "container" props

This first set of props refers to "flex container" related properties. For this reason they are only available for the component Flex.

display

| props | type | value | | --- | --- | --- | | / | / | flex (default) | | inline | boolean | inline-flex | | display | string | any |

<>
  <Flex /> // flex
  <Flex inline /> // inline-flex
  <Flex display="inline-flex" /> // inline-flex
</>

flex-direction

| props | type | value | | --- | --- | --- | | row | boolean | row (default) | | col or column | boolean | column | | rowReverse | boolean | row-reverse | | colReverse or columnReverse | boolean | column-reverse | | direction or flexDirection | string | any |

<>
  <Flex row /> // row
  <Flex col /> // column
  <Flex column /> // column
  <Flex rowReverse /> // row-reverse
  <Flex colReverse /> // column-reverse
  <Flex columnReverse /> // column-reverse

  <Flex direction="column-reverse" /> // column-reverse
  <Flex flexDirection="column-reverse" /> // column-reverse
</>

The additional reverse prop can be used to programmatically revert the specified direction:

| prop | type | | --- | --- | | reverse | boolean |

<>
  <Flex row reverse /> // row-reverse
  <Flex row reverse={true} /> // row-reverse
  <Flex row reverse={false} /> // row
</>

flex-wrap

| props | type | value | | --- | --- | --- | | nowrap | boolean | nowrap (default) | | wrap | boolean | wrap | | wrapReverse | boolean | wrap-reverse | | wrap or flexWrap | string | any |

<>
  <Flex wrap /> // wrap
  <Flex nowrap /> // nowrap
  <Flex wrapReverse /> // wrap-reverse

  <Flex wrap={true} /> // wrap
  <Flex wrap={false} /> // nowrap

  <Flex wrap="wrap-reverse" /> // wrap-reverse
  <Flex flexWrap="wrap-reverse" /> // wrap-reverse
</>

justify-content

| props | type | value | | --- | --- | --- | | start | boolean | flex-start (default) | | end | boolean | flex-end | | center | boolean | center | | spaceBetween | boolean | space-between | | spaceAround | boolean | space-around | | spaceEvenly | boolean | space-evenly | | justify or justifyContent | string | any |

<>
  <Flex start /> // flex-start
  <Flex end /> // flex-end
  <Flex center /> // center
  <Flex spaceBetween /> // space-between
  <Flex spaceAround /> // space-around
  <Flex spaceEvenly /> // space-evenly

  <Flex justify="space-beetween" /> // space-beetween
  <Flex justifyContent="space-beetween" /> // space-beetween
</>

align-items

| props | type | value | | --- | --- | --- | | alignStart | boolean | flex-start | | alignEnd | boolean | flex-end | | alignCenter | boolean | center (default) | | stretch or alignStretch | boolean | stretch | | baseline or alignBaseline | boolean | baseline | | align or alignItems | string | any |

<>
  <Flex alignStart /> // flex-start
  <Flex alignEnd /> // flex-end
  <Flex alignCenter /> // center
  <Flex alignStretch /> // stretch
  <Flex alignBaseline /> // baseline

  <Flex align="flex-end" /> // flex-end
  <Flex alignItems="flex-end" /> // flex-end
</>

align-content

| props | type | value | | --- | --- | --- | | contentStart | boolean | flex-start | | contentEnd | boolean | flex-end | | contentCenter | boolean | center | | contentStretch | boolean | stretch | | contentBaseline | boolean | baseline | | alignContent | string | any |

<>
  <Flex contentStart /> // flex-start
  <Flex contentEnd /> // flex-end
  <Flex contentCenter /> // center
  <Flex contentStretch /> // stretch
  <Flex contentSpaceBetween /> // space-between
  <Flex contentSpaceAround /> // space-around

  <Flex alignContent="flex-end" /> // flex-end
</>

row-gap

| props | type | value | | --- | --- | --- | | rowGap | number or string | any |

<>
  <Flex rowGap={10} /> // 10px
  <Flex rowGap="10px" /> // 10px
</>

column-gap

| props | type | value | | --- | --- | --- | | colGap or columnGap | number or string | any |

<>
  <Flex colGap={10} /> // 10px
  <Flex colGap="10px" /> // 10px
  <Flex columnGap={10} /> // 10px
  <Flex columnGap="10px" /> // 10px
</>

gap

| props | type | value | | --- | --- | --- | | gap | number or string or Array | any |

<>
  <Flex gap={10} /> // 10px
  <Flex gap="10px" /> // 10px

  <Flex gap={[10, 20]} /> // 10px 20px
  <Flex gap="10px 20px" /> // 10px 20px
</>

Flexible "item" props

The set of props below refers to "flex items" related properties. They are all available for both Flex and FlexItem components.

order

| props | type | value | | --- | --- | --- | | order | number or string | any |

<>
  <Flex order={3} /> // 3
  <Flex order="3" /> // 3
</>

flex-grow

| props | type | value | | --- | --- | --- | | grow or flexGrow | booolean or number or string | / |

<>
  <Flex grow /> // 1
  <Flex grow={true} /> // 1
  <Flex grow={false} /> // 0
  <Flex grow={3} /> // 3
  <Flex grow="3" /> // 3
  <Flex flexGrow={3} /> // 3
  <Flex flexGrow="3" /> // 3
</>

flex-shrink

| props | type | value | | --- | --- | --- | | shrink or flexShrink | booolean or number or string | / |

<>
  <Flex shrink /> // 1
  <Flex shrink={true} /> // 1
  <Flex shrink={false} /> // 0
  <Flex shrink={3} /> // 3
  <Flex shrink="3" /> // 3
  <Flex flexShrink={3} /> // 3
  <Flex flexShrink="3" /> // 3
</>

flex-basis

| props | type | value | | --- | --- | --- | | basis or flexBasis | number or string | / |

<>
  <Flex basis={10} /> // 10px
  <Flex basis="10px" /> // 10px
  <Flex flexBasis={10} /> // 10px
  <Flex flexBasis="10px" /> // 10px
</>

align-self

| props | type | value | | --- | --- | --- | | selfStart | boolean | flex-start | | selfEnd | boolean | flex-end | | selfCenter | boolean | center | | selfStretch | boolean | stretch | | selfBaseline | boolean | baseline | | self or alignSelf | string | / |

<>
  <Flex selfStart /> // flex-start
  <Flex selfEnd /> // flex-end
  <Flex selfCenter /> // center
  <Flex selfStretch /> // stretch
  <Flex selfBaseline /> // baseline
  
  <Flex self="flex-end" /> // flex-end
  <Flex alignSelf="flex-end" /> // flex-end
<>

width and height

| props | type | value | |-----------------------|---------------------|-----------| | fill | boolean \| string | see below |

<>
  <Flex fill /> // 100% width and height
  <Flex fill="x" /> // 100% width
  <Flex fill="y" /> // 100% height
  <Flex fill="page" /> // 100vw width and 100vh height
  <Flex fill="page-x" /> // 100vw width
  <Flex fill="page-y" /> // 100vh height
<>

Other props

By default, both Flex and FlexItem components renders a div element with the specified flex properties.

Nevertheless, it is possible to change this behaviour via the as prop:

| props | type | | --- | --- | | as | string or React.ComponentType |

Examples:

<>
  <Flex as="input" />
  <Flex as={MyCustomComp} />
</>

In addition, any additional prop passed to Flex or FlexItem will be drilled down to the render element or component.

Basic usage

<FlexItem id="myDiv" class="some-class" selfEnd grow={3} />

Usage with a different element

<FlexItem as="a" href="#foo" onClick={handleClick} grow />

Usage with a custom component

const MyComp = ({ size }) => (
  <span style={{ fontSize: size }}>
    {children}
  </span>
)

return (
  <FlexItem as={MyComp} size={18} selfEnd />
)

Components

Flex

Use it to create a flexible container.

<Flex>Hello world!</Flex>

By default, it renders a div element with the following CSS properties set:

display: flex;
align-items: center;

It provides all the properties listed above.

FlexItem

Use it to create a flexible item.

// React
<FlexItem>Hello world!</FlexItem>

By default, it renders a div element, but it does not set any CSS property.

Lastly, it provides only props related to order, flex-grow, flex-shrink, flex-basis and align-self properties.