Skip to main content

Flex

danger

This component will be marked as deprecated and removed in an upcoming version of the component library.

Please avoid using this component in new implementations and consider replacing its current implementation with dhl-grid-container in combination with dhl-grid-cell.

A layout utility Flex component which exposes short-hand flex properties to quickly create flex layouts.

Import

// with @dhl-official/react-library:
import { DhlFlex } from "@dhl-official/react-library"
// with @dhl-official/ui-libraries/react-library:
import { DhlFlex } from "@dhl-official/ui-libraries/react-library"

Code

<DhlFlex>
<DhlButton>0</DhlButton>
<DhlButton>1</DhlButton>
<DhlButton>2</DhlButton>
<DhlButton>3</DhlButton>
</DhlFlex>
info

It is highly recommended to use Design Tokens for spacing values.

However, other valid values are supported if passed as string e.g. "auto" or "12px" for custom cases.

Interactive Demo

Migrating from DUIL 1.0

  • No longer supports responsive value array.

Readme

Properties

PropertyAttributeDescriptionTypeDefault
alignalignAn optional prop used to define the alignItems value of the flex container."baseline" \| "center" \| "end" \| "first baseline" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "last baseline" \| "normal" \| "revert" \| "revert-layer" \| "safe center" \| "start" \| "stretch" \| "unsafe center" \| "unset"undefined
directiondirectionAn optional prop used to define the flex-direction of the flex container."column" \| "column-reverse" \| "row" \| "row-reverse"undefined
gapgapAn optional prop used to define the gap of the flex container.string"var(--dui-size-space-0)"
hh[DEPRECATED] An optional prop used to define the height of the flex container.

string"auto"
heightheightAn optional prop used to define the height of the flex container.string"auto"
justifyjustifyAn optional prop used to define the justifyContent value of the flex container."center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "left" \| "normal" \| "revert" \| "revert-layer" \| "right" \| "safe center" \| "space-around" \| "space-between" \| "space-evenly" \| "start" \| "stretch" \| "unsafe center" \| "unset"undefined
mm[DEPRECATED] An optional prop used to define the margin of the flex container.

string"var(--dui-size-space-0)"
marginmarginAn optional prop used to define the margin of the flex container.string"var(--dui-size-space-0)"
pp[DEPRECATED] An optional prop used to define the padding of the flex container.

string"var(--dui-size-space-0)"
paddingpaddingAn optional prop used to define the padding of the flex container.string"var(--dui-size-space-0)"
ww[DEPRECATED] An optional prop used to define the width of the flex container.

string"var(--dui-size-space-full)"
widthwidthAn optional prop used to define the width of the flex container.string"var(--dui-size-space-full)"
wrapwrapAn optional prop used to define the flex-wrap of the flex container."inherit" \| "initial" \| "nowrap" \| "revert" \| "revert-layer" \| "unset" \| "wrap" \| "wrap-reverse"undefined

Slots

SlotDescription
"unnamed"unnamed children slot for elements to be aligned by DhlFlex

Dependencies

Used by

Graph


Built by DHL User Interface Library Team!