Skip to content

Stack API

API reference docs for the React Stack component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Stack from '@mui/joy/Stack';
// or
import { Stack } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDescription
childrennode
The content of the component.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
direction'column-reverse'
| 'column'
| 'row-reverse'
| 'row'
| Array<'column-reverse'
| 'column'
| 'row-reverse'
| 'row'>
| object
Defines the flex-direction style property. It is applied for all screen sizes.
dividernode
Add an element between each child.
spacingArray<number
| string>
| number
| object
| string
Defines the space between immediate children.
sxArray<func
| object
| bool>
| func
| object
The system prop, which allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
useFlexGapbool
If true, the CSS flexbox gap is used instead of applying margin to children.
While CSS gap removes the known limitations, it is not fully supported in some browsers. We recommend checking https://caniuse.com/?search=flex%20gap before using this flag.
To enable this flag globally, follow the theme's default props configuration.

As a CSS utility, the Stack component also supports all system properties. You can use them as props directly on the component.

The ref is forwarded to the root element.

Theme default props

You can use JoyStack to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

NameDefault classDefault HTML tagDescription
root.MuiStack-root'div'The component that renders the root.

You can override the style of the component using one of these customization options: