DocSpace-client/packages/asc-web-components/request-loader/README.md

29 lines
1.6 KiB
Markdown
Raw Normal View History

2019-09-08 14:43:11 +00:00
# RequestLoader
2019-06-18 14:37:36 +00:00
RequestLoader component is used for displaying loading actions on a page
### Usage
2019-06-18 14:37:36 +00:00
```js
2021-02-25 21:19:45 +00:00
import RequestLoader from "@appserver/components/request-loader";
2019-06-18 14:37:36 +00:00
```
```jsx
2019-06-18 14:37:36 +00:00
<RequestLoader label="Loading... Please wait..." />
```
### Properties
| Props | Type | Required | Values | Default | Description |
| ------------- | :------------: | :------: | :----: | :-------------------------: | ----------------------------- |
| `className` | `string` | - | - | - | Accepts class |
| `fontColor` | `string` | - | - | `#999` | Text label font color |
| `fontSize` | `string` | - | - | `12px` | Text label font size |
| `id` | `string` | - | - | - | Accepts id |
| `label` | `string` | - | - | `Loading... Please wait...` | Svg aria-label and text label |
| `loaderColor` | `string` | - | - | `#999` | Svg color |
| `loaderSize` | `string` | - | - | `16px` | Svg height and width value |
| `style` | `obj`, `array` | - | - | - | Accepts css style |
| `visible` | `bool` | - | - | `false` | Visibility |
| `zIndex` | `string` | - | - | `256` | CSS z-index |