CardActionArea API

API reference docs for the React CardActionArea 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:

Card

Import

import CardActionArea from '@mui/material/CardActionArea';
// or
import { CardActionArea } from '@mui/material';

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

Props

Props of the ButtonBase component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
slotProps	{ focusHighlight?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ focusHighlight?: elementType, root?: elementType }	{}	The components used for each slot inside.
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.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in CardActionArea. You can take advantage of this to target nested components.

Theme default props

You can use MuiCardActionArea to change the default props of this component with the theme.

Slots

Slot name	Class name	Default component	Description
root	.MuiCardActionArea-root	`ButtonBase`	The component that renders the root.
focusHighlight	.MuiCardActionArea-focusHighlight	`span`	The component that renders the focusHighlight.

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 name	Rule name	Description
.Mui-focusVisible		State class applied to the ButtonBase root element if the action area is keyboard focused.

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.

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.