Skip to content

Commit 69f56bd

Browse files
authored
Update README.md
1 parent f3c539b commit 69f56bd

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,71 +66,71 @@ const MyLoader = () => (
6666

6767
## Options
6868

69-
**`animate?: boolean`**
69+
#### **`animate?: boolean`**
7070

7171
Defaults to `true`. Opt-out of animations with `false`
7272

73-
**`ariaLabel? string | boolean`**
73+
#### **`ariaLabel? string | boolean`**
7474

7575
Defaults to `Loading interface...`. It's used to describe what element it is. Use `false` to remove.
7676

77-
**`baseUrl? string`**
77+
#### **`baseUrl? string`**
7878

7979
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).
8080

81-
**`speed?: number`**
81+
#### **`speed?: number`**
8282

8383
Defaults to `2`. Animation speed in seconds.
8484

85-
**`interval?: number`**
85+
#### **`interval?: number`**
8686

8787
Defaults to `0.25`. Interval of time between runs of the animation, as a fraction of the animation speed.
8888

89-
**`className? string`**
89+
#### **`className? string`**
9090

9191
Defaults to an empty string. The classname will be set in the `<svg />` element.
9292

93-
**`width? number`**
93+
#### **`width? number`**
9494

9595
Defaults to `400`. It will be set in the viewbox attr in the `<svg />`.
9696

97-
**`height? number`**
97+
#### **`height? number`**
9898

9999
Defaults to `130`. It will be set in the viewbox attr in the `<svg />`.
100100

101-
**`gradientRatio? number`**
101+
#### **`gradientRatio? number`**
102102

103103
Defaults to `2`. Width of the animated gradient as a fraction of the viewbox width.
104104

105-
**`rtl? boolean`**
105+
#### **`rtl? boolean`**
106106

107107
Defaults to `false`. Content right-to-left.
108108

109-
**`preserveAspectRatio?: string`**
109+
#### **`preserveAspectRatio?: string`**
110110

111111
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).
112112

113-
**`primaryColor?: string`**
113+
#### **`primaryColor?: string`**
114114

115115
Defaults to `#f3f3f3` which is used as background of animation.
116116

117-
**`secondaryColor?: string`**
117+
#### **`secondaryColor?: string`**
118118

119119
Defaults to `#ecebeb` which is used as the placeholder/layer of animation.
120120

121-
**`primaryOpacity?: string`**
121+
#### **`primaryOpacity?: string`**
122122

123123
Defaults to `1`. Background opacity (0 = transparent, 1 = opaque) used to solve a issue in [Safari](#safari--ios)
124124

125-
**`secondaryOpacity?: string`**
125+
#### **`secondaryOpacity?: string`**
126126

127127
Defaults to `1`. Animation opacity (0 = transparent, 1 = opaque) used to solve a issue in [Safari](#safari--ios)
128128

129-
**`style?: React.CSSProperties`**
129+
#### **`style?: React.CSSProperties`**
130130

131131
Defaults to an empty object.
132132

133-
**`uniquekey?: string`**
133+
#### **`uniquekey?: string`**
134134

135135
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).
136136

0 commit comments

Comments
 (0)