2018-12-26 16:01:00 +08:00
|
|
|
---
|
|
|
|
category: Components
|
2022-11-09 12:28:04 +08:00
|
|
|
group: Data Display
|
2018-12-26 16:01:00 +08:00
|
|
|
title: Empty
|
2022-11-30 20:14:41 +08:00
|
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*ZdiZSLzEV0wAAAAAAAAAAAAADrJ8AQ/original
|
2023-02-09 22:17:31 +08:00
|
|
|
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*obM7S5lIxeMAAAAAAAAAAAAADrJ8AQ/original
|
2018-12-26 16:01:00 +08:00
|
|
|
---
|
|
|
|
|
|
|
|
Empty state placeholder.
|
|
|
|
|
|
|
|
## When To Use
|
|
|
|
|
2019-04-02 10:26:45 +08:00
|
|
|
- When there is no data provided, display for friendly tips.
|
|
|
|
- User tutorial to create something in fresh new situation.
|
2019-03-20 17:45:35 +08:00
|
|
|
|
2022-11-09 12:28:04 +08:00
|
|
|
## Examples
|
|
|
|
|
2022-11-17 17:31:26 +08:00
|
|
|
<!-- prettier-ignore -->
|
2022-11-09 12:28:04 +08:00
|
|
|
<code src="./demo/basic.tsx">Basic</code>
|
|
|
|
<code src="./demo/simple.tsx">Chose image</code>
|
|
|
|
<code src="./demo/customize.tsx">Customize</code>
|
|
|
|
<code src="./demo/config-provider.tsx">ConfigProvider</code>
|
|
|
|
<code src="./demo/description.tsx">No description</code>
|
|
|
|
|
2018-12-26 16:01:00 +08:00
|
|
|
## API
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
<Empty>
|
|
|
|
<Button>Create</Button>
|
|
|
|
</Empty>
|
|
|
|
```
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
| --- | --- | --- | --- | --- |
|
2020-10-09 10:08:52 +08:00
|
|
|
| description | Customize description | ReactNode | - | |
|
|
|
|
| image | Customize image. Will treat as image url when string provided | ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | |
|
2020-10-21 10:33:43 +08:00
|
|
|
| imageStyle | The style of image | CSSProperties | - | |
|
2019-04-02 10:26:45 +08:00
|
|
|
|
|
|
|
## Built-in images
|
|
|
|
|
2019-05-07 14:57:32 +08:00
|
|
|
- Empty.PRESENTED_IMAGE_SIMPLE
|
2019-04-02 10:26:45 +08:00
|
|
|
|
2020-01-03 19:00:01 +08:00
|
|
|
<div class="site-empty-buildIn-img site-empty-buildIn-simple"><div>
|
2019-04-02 10:26:45 +08:00
|
|
|
|
2019-05-07 14:57:32 +08:00
|
|
|
- Empty.PRESENTED_IMAGE_DEFAULT
|
2019-04-02 10:26:45 +08:00
|
|
|
|
2020-01-03 19:00:01 +08:00
|
|
|
<div class="site-empty-buildIn-img site-empty-buildIn-default"></div>
|
|
|
|
|
|
|
|
<style>
|
|
|
|
.site-empty-buildIn-img {
|
|
|
|
background-repeat: no-repeat;
|
2021-06-01 13:28:25 +08:00
|
|
|
background-size: contain;
|
2020-01-03 19:00:01 +08:00
|
|
|
}
|
|
|
|
.site-empty-buildIn-simple {
|
|
|
|
width: 55px;
|
|
|
|
height: 35px;
|
|
|
|
background-image: url("https://user-images.githubusercontent.com/507615/54591679-b0ceb580-4a65-11e9-925c-ad15b4eae93d.png");
|
|
|
|
}
|
|
|
|
.site-empty-buildIn-default {
|
|
|
|
width: 121px;
|
|
|
|
height: 116px;
|
|
|
|
background-image: url("https://user-images.githubusercontent.com/507615/54591670-ac0a0180-4a65-11e9-846c-e55ffce0fe7b.png");
|
|
|
|
}
|
|
|
|
</style>
|
2023-04-11 10:25:24 +08:00
|
|
|
|
|
|
|
## Design Token
|
|
|
|
|
|
|
|
<ComponentTokenTable component="Empty"></ComponentTokenTable>
|