2020-11-09 11:45:57 +00:00
|
|
|
# Header Loader
|
|
|
|
|
|
|
|
|
|
Component that displays header loader
|
|
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
|
|
|
|
|
```js
|
2022-07-22 19:01:25 +00:00
|
|
|
import Loaders from "@docspace/common/components/Loaders";
|
2020-11-09 11:45:57 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
|
<Loaders.Header />
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Properties
|
|
|
|
|
|
|
|
|
|
| Props | Type | Required | Values | Default | Description |
|
|
|
|
|
| ------------------- | :------: | :------: | :----: | :-----: | ------------------------------------------------ |
|
2020-11-09 13:02:08 +00:00
|
|
|
| `title` | `string` | - | - | `` | It's used to describe what element it is. |
|
2020-11-11 08:38:30 +00:00
|
|
|
| `borderRadius` | `string` | - | - | `3` | Sets the corners rounding |
|
2020-11-09 11:45:57 +00:00
|
|
|
| `backgroundColor` | `string` | - | - | `#fff` | Used as background of animation |
|
|
|
|
|
| `foregroundColor` | `string` | - | - | `#fff` | Used as the foreground of animation |
|
|
|
|
|
| `backgroundOpacity` | `number` | - | - | 0.2 | Background opacity (0 = transparent, 1 = opaque) |
|
|
|
|
|
| `foregroundOpacity` | `number` | - | - | 0.25 | Animation opacity (0 = transparent, 1 = opaque) |
|
|
|
|
|
| `speed` | `number` | - | - | 2 | Animation speed in seconds |
|
|
|
|
|
| `animate` | `bool` | - | - | true | Opt-out of animations |
|
