2016-05-26 17:46:55 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2016-11-09 14:43:32 +08:00
|
|
|
type: Data Display
|
2016-05-26 17:46:55 +08:00
|
|
|
title: Card
|
2016-06-17 15:39:05 +08:00
|
|
|
cols: 1
|
2016-05-26 17:46:55 +08:00
|
|
|
---
|
|
|
|
|
|
2017-09-16 11:28:18 +08:00
|
|
|
Simple rectangular container.
|
2016-05-26 17:46:55 +08:00
|
|
|
|
2016-09-10 13:43:30 +08:00
|
|
|
## When To Use
|
2016-05-26 17:46:55 +08:00
|
|
|
|
2017-09-16 11:28:18 +08:00
|
|
|
A card can be used to display content related to a single subject. The content can consist of multiple elements of varying types and sizes.
|
2016-05-26 17:46:55 +08:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2019-12-26 14:37:39 +08:00
|
|
|
```jsx
|
2016-05-26 17:46:55 +08:00
|
|
|
<Card title="Card title">Card content</Card>
|
|
|
|
|
```
|
|
|
|
|
|
2017-07-07 13:36:54 +08:00
|
|
|
### Card
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
| actions | The action list, shows at the bottom of the Card. | Array<ReactNode> | - | |
|
2019-11-20 20:31:43 +08:00
|
|
|
| activeTabKey | Current TabPane's key | string | - | |
|
|
|
|
|
| headStyle | Inline style to apply to the card head | object | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| bodyStyle | Inline style to apply to the card content | object | - | |
|
|
|
|
|
| bordered | Toggles rendering of the border around the card | boolean | `true` | |
|
|
|
|
|
| cover | Card cover | ReactNode | - | |
|
2019-11-20 20:31:43 +08:00
|
|
|
| defaultActiveTabKey | Initial active TabPane's key, if `activeTabKey` is not set. | string | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| extra | Content to render in the top-right corner of the card | string\|ReactNode | - | |
|
|
|
|
|
| hoverable | Lift up when hovering card | boolean | false | |
|
|
|
|
|
| loading | Shows a loading indicator while the contents of the card are being fetched | boolean | false | |
|
|
|
|
|
| tabList | List of TabPane's head. | Array<{key: string, tab: ReactNode}> | - | |
|
2019-08-23 14:14:41 +08:00
|
|
|
| tabBarExtraContent | Extra content in tab bar | React.ReactNode | - | |
|
2019-11-20 20:31:43 +08:00
|
|
|
| size | Size of card | `default` \| `small` | `default` | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| title | Card title | string\|ReactNode | - | |
|
|
|
|
|
| type | Card style type, can be set to `inner` or not set | string | - | |
|
|
|
|
|
| onTabChange | Callback when tab is switched | (key) => void | - | |
|
2017-07-07 13:36:54 +08:00
|
|
|
|
|
|
|
|
### Card.Grid
|
|
|
|
|
|
2019-08-25 16:00:47 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --------- | ------------------------------- | ------- | ------- | ------- |
|
|
|
|
|
| className | className of container | string | - | |
|
2019-11-20 20:31:43 +08:00
|
|
|
| hoverable | Lift up when hovering card grid | boolean | true | |
|
2019-08-25 16:00:47 +08:00
|
|
|
| style | style object of container | object | - | |
|
2017-08-09 14:34:10 +08:00
|
|
|
|
|
|
|
|
### Card.Meta
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| ----------- | ------------------------- | --------- | ------- | ------- |
|
|
|
|
|
| avatar | avatar or icon | ReactNode | - | |
|
|
|
|
|
| className | className of container | string | - | |
|
|
|
|
|
| description | description content | ReactNode | - | |
|
|
|
|
|
| style | style object of container | object | - | |
|
|
|
|
|
| title | title content | ReactNode | - | |
|
