kylefang/react-content-loader
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-content-loader.git synced 2026-04-28 20:25:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor(Readme and types): Cosmetic things

Browse Source
This commit is contained in:
Danilo Woznica
2018-02-13 13:54:30 -02:00
parent f1258ce15d
commit 7b9d65d1f7
3 changed files with 23 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -59,18 +59,18 @@ const MyLoader = () => (
## Options
| Name | Type | Default | Description |
| ------------------- | --------- | ---------------- | ------------------------------------------------------------ |
| speed | _Number_ | `2` | Animation speed |
| animate | _Boolean_ | `true` | `false` to render with no animation |
| width | _Number_ | `400` | **viewBox** width of SVG |
| height | _Number_ | `130` | **viewBox** height of SVG |
| style | _Object_ | `null` | Ex: `{ marginTop: '50px' }` |
| primaryColor | _String_ | `#f3f3f3` | Background the SVG |
| secondaryColor | _String_ | `#ecebeb` | Animation color |
| preserveAspectRatio | _String_ | `xMidYMid meet` | Aspect ratio option of SVG |
| className | _String_ | '' | Classname in the <svg /> |
| uniquekey | _String_ | random unique id | **Use the same key value, it'll solve some problems to SSR** |
| Name | Type | Default | Description |
| ----------------------- | ----------- | ---------------- | ---------------------------------------------------------- |
| **animate** | `{Boolean}` | `true` | `false` to render with no animation |
| **speed** | `{Number}` | `2` | Animation speed in seconds |
| **className** | `{String}` | `''` | Classname in the `<svg/>` |
| **width** | `{Number}` | `400` | viewBox width of `<svg/>` |
| **height** | `{Number}` | `130` | viewBox height of `<svg/>` |
| **preserveAspectRatio** | `{String}` | `xMidYMid meet` | Aspect ratio option of `<svg/>` |
| **primaryColor** | `{String}` | `#f3f3f3` | Background |
| **secondaryColor** | `{String}` | `#ecebeb` | Animation color |
| **style** | `{Object}` | `null` | Ex: `{ marginTop: '50px' }` |
| **uniquekey** | `{String}` | random unique id | **Use the same key value, it works to Server Side Render** |
### Examples