You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,71 +66,71 @@ const MyLoader = () => (
66
66
67
67
## Options
68
68
69
-
**`animate?: boolean`**
69
+
#### **`animate?: boolean`**
70
70
71
71
Defaults to `true`. Opt-out of animations with `false`
72
72
73
-
**`ariaLabel? string | boolean`**
73
+
#### **`ariaLabel? string | boolean`**
74
74
75
75
Defaults to `Loading interface...`. It's used to describe what element it is. Use `false` to remove.
76
76
77
-
**`baseUrl? string`**
77
+
#### **`baseUrl? string`**
78
78
79
79
Required if you're using `<base url="/" />` in your `<head/>`. Defaults to an empty string. This prop is common used as: `<ContentLoader baseUrl={window.location.pathname} />` which will fill the SVG attribute with the relative path. Related [#93](https://github.com/danilowoz/react-content-loader/issues/93).
80
80
81
-
**`speed?: number`**
81
+
#### **`speed?: number`**
82
82
83
83
Defaults to `2`. Animation speed in seconds.
84
84
85
-
**`interval?: number`**
85
+
#### **`interval?: number`**
86
86
87
87
Defaults to `0.25`. Interval of time between runs of the animation, as a fraction of the animation speed.
88
88
89
-
**`className? string`**
89
+
#### **`className? string`**
90
90
91
91
Defaults to an empty string. The classname will be set in the `<svg />` element.
92
92
93
-
**`width? number`**
93
+
#### **`width? number`**
94
94
95
95
Defaults to `400`. It will be set in the viewbox attr in the `<svg />`.
96
96
97
-
**`height? number`**
97
+
#### **`height? number`**
98
98
99
99
Defaults to `130`. It will be set in the viewbox attr in the `<svg />`.
100
100
101
-
**`gradientRatio? number`**
101
+
#### **`gradientRatio? number`**
102
102
103
103
Defaults to `2`. Width of the animated gradient as a fraction of the viewbox width.
104
104
105
-
**`rtl? boolean`**
105
+
#### **`rtl? boolean`**
106
106
107
107
Defaults to `false`. Content right-to-left.
108
108
109
-
**`preserveAspectRatio?: string`**
109
+
#### **`preserveAspectRatio?: string`**
110
110
111
111
Defaults to `xMidYMid meet`. Aspect ratio option of `<svg/>`. See the available options [here](https://github.com/danilowoz/react-content-loader/blob/master/src/interface.ts#L7).
112
112
113
-
**`primaryColor?: string`**
113
+
#### **`primaryColor?: string`**
114
114
115
115
Defaults to `#f3f3f3` which is used as background of animation.
116
116
117
-
**`secondaryColor?: string`**
117
+
#### **`secondaryColor?: string`**
118
118
119
119
Defaults to `#ecebeb` which is used as the placeholder/layer of animation.
120
120
121
-
**`primaryOpacity?: string`**
121
+
#### **`primaryOpacity?: string`**
122
122
123
123
Defaults to `1`. Background opacity (0 = transparent, 1 = opaque) used to solve a issue in [Safari](#safari--ios)
124
124
125
-
**`secondaryOpacity?: string`**
125
+
#### **`secondaryOpacity?: string`**
126
126
127
127
Defaults to `1`. Animation opacity (0 = transparent, 1 = opaque) used to solve a issue in [Safari](#safari--ios)
128
128
129
-
**`style?: React.CSSProperties`**
129
+
#### **`style?: React.CSSProperties`**
130
130
131
131
Defaults to an empty object.
132
132
133
-
**`uniquekey?: string`**
133
+
#### **`uniquekey?: string`**
134
134
135
135
Defaults to random unique id. Use the same value of prop key, that will solve inconsistency on the SSR, see more [here](https://github.com/danilowoz/react-content-loader/issues/78).
0 commit comments