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.

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

children

Used to render icon or text elements inside the AspectRatio if src is not set. This can be an element, or just a string.

Type:node

color

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.

Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'

Default:'neutral'

component

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

Type:elementType

flex

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.

Type:bool

Default:false

maxHeight

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

Type:number
| string

minHeight

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

Type:number
| string

objectFit

The CSS object-fit value of the first-child.

Type:'-moz-initial'
| 'contain'
| 'cover'
| 'fill'
| 'inherit'
| 'initial'
| 'none'
| 'revert-layer'
| 'revert'
| 'scale-down'
| 'unset'

Default:'cover'

ratio

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

Type:number
| string

Default:'16 / 9'

slotProps

The props used for each slot inside.

Type:{ content?: func
| object, root?: func
| object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ content?: elementType, root?: elementType }

Default:{}

sx

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

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string

Default:'soft'

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.

root

The component that renders the root.

Class name: .MuiAspectRatio-root

Default component: 'div'

content

The component that renders the content.

Class name: .MuiAspectRatio-content

Default component: 'div'

CSS classes

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

.MuiAspectRatio-colorContext

Class name applied to the root element when color inversion is triggered.

Rule name:colorContext

.MuiAspectRatio-colorDanger

Class name applied to the content element if color="danger".

Rule name:colorDanger

.MuiAspectRatio-colorNeutral

Class name applied to the content element if color="neutral".

Rule name:colorNeutral

.MuiAspectRatio-colorPrimary

Class name applied to the content element if color="primary".

Rule name:colorPrimary

.MuiAspectRatio-colorSuccess

Class name applied to the content element if color="success".

Rule name:colorSuccess

.MuiAspectRatio-colorWarning

Class name applied to the content element if color="warning".

Rule name:colorWarning

.MuiAspectRatio-variantOutlined

Class name applied to the content element if variant="outlined".

Rule name:variantOutlined

.MuiAspectRatio-variantPlain

Class name applied to the content element if variant="plain".

Rule name:variantPlain

.MuiAspectRatio-variantSoft

Class name applied to the content element if variant="soft".

Rule name:variantSoft

.MuiAspectRatio-variantSolid

Class name applied to the content element if variant="solid".

Rule name:variantSolid


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