AspectRatio API

API reference docs for the React AspectRatio 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 AspectRatio from '@mui/joy/AspectRatio';
// or
import { AspectRatio } 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.

Name	Type	Default	Description
children	node		Used to render icon or text elements inside the AspectRatio if `src` is not set. This can be an element, or just a string.
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning'	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
maxHeight	number \| string		The maximum calculated height of the element (not the CSS height).
minHeight	number \| string		The minimum calculated height of the element (not the CSS height).
objectFit	'-moz-initial' \| 'contain' \| 'cover' \| 'fill' \| 'inherit' \| 'initial' \| 'none' \| 'revert-layer' \| 'revert' \| 'scale-down' \| 'unset'	'cover'	The CSS object-fit value of the first-child.
ratio	number \| string	'16 / 9'	The aspect-ratio of the element. The current implementation uses padding instead of the CSS aspect-ratio due to browser support. https://caniuse.com/?search=aspect-ratio
slotProps	{ content?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ content?: elementType, root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'soft'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyAspectRatio 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.

Name	Default class	Default HTML tag	Description
root	.MuiAspectRatio-root	'div'	The component that renders the root.
content	.MuiAspectRatio-content	'div'	The component that renders the content.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Global class	Description
.MuiAspectRatio-colorContext	Class name applied to the root element when color inversion is triggered.
.MuiAspectRatio-colorDanger	Class name applied to the content element if `color="danger"`.
.MuiAspectRatio-colorInfo	Class name applied to the content element if `color="info"`.
.MuiAspectRatio-colorNeutral	Class name applied to the content element if `color="neutral"`.
.MuiAspectRatio-colorPrimary	Class name applied to the content element if `color="primary"`.
.MuiAspectRatio-colorSuccess	Class name applied to the content element if `color="success"`.
.MuiAspectRatio-colorWarning	Class name applied to the content element if `color="warning"`.
.MuiAspectRatio-variantOutlined	Class name applied to the content element if `variant="outlined"`.
.MuiAspectRatio-variantPlain	Class name applied to the content element if `variant="plain"`.
.MuiAspectRatio-variantSoft	Class name applied to the content element if `variant="soft"`.
.MuiAspectRatio-variantSolid	Class name applied to the content element if `variant="solid"`.