IlyaSobolev/DocSpace-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

web: Components: Fixed EmptyScreenContainer component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-20 14:23:04 +03:00
parent b7e1f1ef81
commit 5a1839bda2
1 changed files with 20 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
web/ASC.Web.Components/src/components/empty-screen-container/README.md
View File

@ -1,35 +1,29 @@
# EmptyScreenContainer
## Usage
```js
import { EmptyScreenContainer } from 'asc-web-components';
```
#### Description
Used to display empty screen page
#### Usage
### Usage
```js
<EmptyScreenContainer
imageSrc="empty_screen_filter.png"
imageAlt="Empty Screen Filter image"
headerText="No results matching your search could be found"
descriptionText="No results matching your search could be found"
buttons={
<a href="/">Go to home</a>
}
/>
import { EmptyScreenContainer } from "asc-web-components";
```
#### Properties
```jsx
<EmptyScreenContainer
imageSrc="empty_screen_filter.png"
imageAlt="Empty Screen Filter image"
headerText="No results matching your search could be found"
descriptionText="No results matching your search could be found"
buttons={<a href="/">Go to home</a>}
/>
```
| Props | Type | Required | Values | Default | Description |
| ------------------ | ----------------------| :------: | --------------------------- | --------------- |----------------------------------------------------------------------------------------------------- |
| `imageSrc` | `string` | - | - | - | Image url source |
| `imageAlt` | `string`| - | - | - | Alternative image text |
| `headerText` | `string` | - | - | - | Header text |
| `descriptionText` | `string` | - | - | - | Description text |
| `buttons` | `element(s)` | - | - | - | Content of EmptyContentButtonsContainer |
### Properties
| Props | Type | Required | Values | Default | Description |
| ----------------- | :-------: | :------: | :----: | :-----: | --------------------------------------- |
| `imageSrc` | `string` | - | - | - | Image url source |
| `imageAlt` | `string` | - | - | - | Alternative image text |
| `headerText` | `string` | - | - | - | Header text |
| `descriptionText` | `string` | - | - | - | Description text |
| `buttons` | `element` | - | - | - | Content of EmptyContentButtonsContainer |