DocSpace-client/packages/common/components/Loaders/SectionHeaderLoader/README.md

27 lines
1.4 KiB
Markdown
Raw Normal View History

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