Skip to content
Edit this page

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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

The content of the component.

Type:

node
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
direction

Defines the flex-direction style property. It is applied for all screen sizes.

Type:

'column-reverse' | 'column' | 'row-reverse' | 'row' | Array<'column-reverse' | 'column' | 'row-reverse' | 'row'> | object
divider

Add an element between each child.

Type:

node
spacing

Defines the space between immediate children.

Type:

Array<number | string> | number | object | string
sx

The system prop, which allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
useFlexGap

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.

Type:

bool
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.

root'div'Required

Global class: .MuiStack-root

Description: The component that renders the root.

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