Skip to content

AspectRatio API

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

Demos

Import

import AspectRatio from '@mui/joy/AspectRatio';
// or
import { AspectRatio } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

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

componentelementType-

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

flexboolfalse

By default, the AspectRatio will maintain the aspect ratio of its content. Set this prop to true when the container is a flex row and you want the AspectRatio to fill the height of its container.

maxHeightnumber
| string
-

The maximum calculated height of the element (not the CSS height).

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

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

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

Slot nameClass nameDefault componentDescription
root.MuiAspectRatio-root'div'The component that renders the root.
content.MuiAspectRatio-content'div'The component that renders the content.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiAspectRatio-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiAspectRatio-colorDangercolorDangerClass name applied to the content element if color="danger".
.MuiAspectRatio-colorNeutralcolorNeutralClass name applied to the content element if color="neutral".
.MuiAspectRatio-colorPrimarycolorPrimaryClass name applied to the content element if color="primary".
.MuiAspectRatio-colorSuccesscolorSuccessClass name applied to the content element if color="success".
.MuiAspectRatio-colorWarningcolorWarningClass name applied to the content element if color="warning".
.MuiAspectRatio-variantOutlinedvariantOutlinedClass name applied to the content element if variant="outlined".
.MuiAspectRatio-variantPlainvariantPlainClass name applied to the content element if variant="plain".
.MuiAspectRatio-variantSoftvariantSoftClass name applied to the content element if variant="soft".
.MuiAspectRatio-variantSolidvariantSolidClass name applied to the content element if variant="solid".

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

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.