Spaces:
Paused
Paused
| title: Card | |
| sidebar_label: Card | |
| <!-- | |
| Licensed to the Apache Software Foundation (ASF) under one | |
| or more contributor license agreements. See the NOTICE file | |
| distributed with this work for additional information | |
| regarding copyright ownership. The ASF licenses this file | |
| to you under the Apache License, Version 2.0 (the | |
| "License"); you may not use this file except in compliance | |
| with the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, | |
| software distributed under the License is distributed on an | |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| KIND, either express or implied. See the License for the | |
| specific language governing permissions and limitations | |
| under the License. | |
| --> | |
| import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; | |
| # Card | |
| A container component for grouping related content. Supports titles, borders, loading states, and hover effects. | |
| ## Live Example | |
| <StoryWithControls | |
| component="Card" | |
| props={{ | |
| padded: true, | |
| title: 'Dashboard Overview', | |
| children: | |
| 'This card displays a summary of your dashboard metrics and recent activity.', | |
| bordered: true, | |
| loading: false, | |
| hoverable: false, | |
| }} | |
| controls={[ | |
| { | |
| name: 'padded', | |
| label: 'Padded', | |
| type: 'boolean', | |
| description: 'Whether the card content has padding.', | |
| }, | |
| { | |
| name: 'title', | |
| label: 'Title', | |
| type: 'text', | |
| description: 'Title text displayed at the top of the card.', | |
| }, | |
| { | |
| name: 'children', | |
| label: 'Children', | |
| type: 'text', | |
| description: 'The content inside the card.', | |
| }, | |
| { | |
| name: 'bordered', | |
| label: 'Bordered', | |
| type: 'boolean', | |
| description: 'Whether to show a border around the card.', | |
| }, | |
| { | |
| name: 'loading', | |
| label: 'Loading', | |
| type: 'boolean', | |
| description: 'Whether to show a loading skeleton.', | |
| }, | |
| { | |
| name: 'hoverable', | |
| label: 'Hoverable', | |
| type: 'boolean', | |
| description: 'Whether the card lifts on hover.', | |
| }, | |
| ]} | |
| /> | |
| ## Try It | |
| Edit the code below to experiment with the component: | |
| ```tsx live | |
| function Demo() { | |
| return ( | |
| <Card title="Dashboard Overview" bordered> | |
| This card displays a summary of your dashboard metrics and recent | |
| activity. | |
| </Card> | |
| ); | |
| } | |
| ``` | |
| ## Card States | |
| ```tsx live | |
| function CardStates() { | |
| return ( | |
| <div style={{ display: 'flex', gap: 16, flexWrap: 'wrap' }}> | |
| <Card title="Default" bordered style={{ width: 250 }}> | |
| Default card content. | |
| </Card> | |
| <Card title="Hoverable" bordered hoverable style={{ width: 250 }}> | |
| Hover over this card. | |
| </Card> | |
| <Card title="Loading" bordered loading style={{ width: 250 }}> | |
| This content is hidden while loading. | |
| </Card> | |
| <Card title="No Border" style={{ width: 250 }}> | |
| Borderless card. | |
| </Card> | |
| </div> | |
| ); | |
| } | |
| ``` | |
| ## Props | |
| | Prop | Type | Default | Description | | |
| | ----------- | --------- | ------------------------------------------------------------------------------- | -------------------------------------------- | | |
| | `padded` | `boolean` | `true` | Whether the card content has padding. | | |
| | `title` | `string` | `"Dashboard Overview"` | Title text displayed at the top of the card. | | |
| | `children` | `string` | `"This card displays a summary of your dashboard metrics and recent activity."` | The content inside the card. | | |
| | `bordered` | `boolean` | `true` | Whether to show a border around the card. | | |
| | `loading` | `boolean` | `false` | Whether to show a loading skeleton. | | |
| | `hoverable` | `boolean` | `false` | Whether the card lifts on hover. | | |
| ## Import | |
| ```tsx | |
| import { Card } from '@superset-ui/core/components'; | |
| ``` | |
| :::tip[Improve this page] | |
| This documentation is auto-generated from the component's Storybook story. | |
| Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Card/Card.stories.tsx). | |
| ::: | |