DocSpace-buildtools/packages/components/request-loader/README.md

29 lines
1.6 KiB
Markdown

# RequestLoader
RequestLoader component is used for displaying loading actions on a page
### Usage
```js
import RequestLoader from "@docspace/components/request-loader";
```
```jsx
<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 |