Stack API
API reference docs for the React Stack component. Learn about the props, CSS, and other APIs of this exported module.
Demos
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 of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | - | The content of the component. |
component | elementType | - | 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 | 'column' | Defines the |
divider | node | - | Add an element between each child. |
spacing | Array<number | string> | number | object | string | 0 | Defines the space between immediate children. |
sx | Array<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. |
useFlexGap | bool | false | If |
system
properties. You can use them as props directly on the component.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.
To learn how to customize the slot, check out the Overriding component structure guide.
Slot name | Class name | Default component | Description |
---|---|---|---|
root | .MuiStack-root | 'div' | The component that renders the root. |
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.