Skip to content
Edit this page

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

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

Type:

{ content?: elementType, root?: elementType }

Default:

{}
sx

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

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

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'div'Required

Global class: .MuiAspectRatio-root

Description: The component that renders the root.

content'div'Required

Global class: .MuiAspectRatio-content

Description: The component that renders the content.

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

CSS classes

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

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