react-spinners
Advanced tools
Comparing version 0.7.0-alpha.4 to 0.7.0-alpha.5
@@ -5,2 +5,6 @@ # Change Log | ||
## 0.7.0-alpha.5 | ||
- clean up readme. break up prop section with individual prop headers | ||
## 0.7.0-alpha.4 | ||
@@ -7,0 +11,0 @@ |
{ | ||
"name": "react-spinners", | ||
"version": "0.7.0-alpha.4", | ||
"version": "0.7.0-alpha.5", | ||
"description": "A collection of react loading spinners", | ||
@@ -5,0 +5,0 @@ "repository": { |
@@ -34,3 +34,3 @@ # React Spinners | ||
Each loader accepts a `loading` prop as a boolean. The loader will not render anything if `loading` is `false`. The `loading` prop defaults to `true`. | ||
Each loader accepts a `loading` prop as a boolean. The loader will render `null` if `loading` is `false`. | ||
@@ -46,3 +46,3 @@ **IMPORTANT**: This package uses [emotion](https://github.com/emotion-js/emotion). Remember to add the plugin to `.babelrc`, for example: | ||
### Examples | ||
### Example | ||
@@ -97,8 +97,11 @@ ```js | ||
Color prop accepts a color hash. It also accepts basic colors. This is the list of colors accepted: | ||
### `color` prop | ||
`color` prop accepts a color hash in the format of `#XXXXXX` or `#XXX`. It also accepts basic colors listed below: | ||
> maroon, red, orange, yellow, olive, green, purple, white, | ||
> fuchsia, lime, teal, aqua, blue, navy, black, gray, silver | ||
Note: | ||
### `css` prop | ||
`css` works exactly like the `css` works with the emotion package. | ||
@@ -109,4 +112,6 @@ You can directly write your css in css syntax without the dirty camelCase css in jss syntax. | ||
For `size`, `height`, `width`, and `radius` props, the input can be number or string. | ||
### `size`, `height`, `width`, and `radius` props | ||
The input to these props can be number or string. | ||
- If value is number, the loader will default to css unit `px`. | ||
@@ -117,2 +122,4 @@ - If value is string, the loader will verify the unit against valid css units. | ||
The table below has the default values for each loader. | ||
| Loader | size | height | width | radius | margin | | ||
@@ -119,0 +126,0 @@ | ----------------: | :--: | :----: | :---: | :----: | :----: | |
134553
141