Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[material-ui][docs] Add docs for complementary Card components #40346

Merged
merged 3 commits into from
Jan 4, 2024
Merged

[material-ui][docs] Add docs for complementary Card components #40346

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62d7144
Update cards.md
anle9650 Dec 28, 2023
5969d62
Update docs/data/material/components/cards/cards.md
samuelsycamore Jan 4, 2024
2d852f0
fix intro format
samuelsycamore Jan 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 20 additions & 5 deletions docs/data/material/components/cards/cards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,32 @@ materialDesign: https://m2.material.io/components/cards

<p class="description">Cards contain content and actions about a single subject.</p>

{{"component": "modules/components/ComponentLinkHeader.js"}}

## Introduction

Cards are surfaces that display content and actions on a single topic.
The Material UI Card component includes several complementary utility components to handle various use cases:

They should be easy to scan for relevant and actionable information. Elements, like text and images, should be placed on them in a way that clearly indicates hierarchy.
- Card: a surface-level container for grouping related components.
- Card Content: the wrapper for the Card content.
- Card Header: an optional wrapper for the Card header.
- Card Media: an optional container for displaying background images and gradient layers behind the Card Content.
- Card Actions: an optional wrapper that groups a set of buttons.
- Card Action Area: an optional wrapper that allows users to interact with the specified area of the Card.

{{"component": "modules/components/ComponentLinkHeader.js"}}
{{"demo": "BasicCard.js", "bg": true}}

## Basic card
## Basics

Although cards can support multiple actions, UI controls, and an overflow menu, use restraint and remember that cards are entry points to more complex and detailed information.
```jsx
import Card from '@mui/material/Card';
import CardContent from '@mui/material/CardContent';
```

{{"demo": "BasicCard.js", "bg": true}}
:::success
Although cards can support multiple actions, UI controls, and an overflow menu, use restraint and remember that cards are meant to be entry points to more complex and detailed information.
:::

### Outlined Card

Expand Down