Skip to content

Commit c631ffc

Browse files
committed
Update README
1 parent 8650ec1 commit c631ffc

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# React Native Animated SpinKit
22

3+
[![Stable Release](https://img.shields.io/npm/v/react-native-animated-spinkit.svg)](https://npm.im/react-native-animated-spinkit) [![license](https://badgen.now.sh/badge/license/MIT)](./LICENSE)
4+
35
A pure JavaScript port of [SpinKit](https://github.com/tobiasahlin/SpinKit) for React Native.
46

57
![](demo.gif)
68

79
## Why Another Port?
810

9-
SpinKit is a popular library that provides a set of loading indicators on the web and has been ported to other platforms, including React Native ([react-native-spinkit](https://github.com/maxs15/react-native-spinkit)). But since `react-native-spinkit` is a native module, it requires extra native dependencies and can't be used in [Expo](https://expo.io) projects without ejecting.
11+
The previous port of [SpinKit](https://github.com/tobiasahlin/SpinKit) for React Native ([react-native-spinkit](https://github.com/maxs15/react-native-spinkit)) is a native module so it requires extra native dependencies and can't be used in [Expo](https://expo.io) projects without ejecting.
1012

11-
This library is a pure JavaScript port of SpinKit implemented with the [Animated](https://facebook.github.io/react-native/docs/animated) API.
13+
This library is a pure JavaScript port of SpinKit implemented with the [Animated](https://facebook.github.io/react-native/docs/animated) API, which means you can use it in any React Native project and the spinners will look identical on Android and iOS.
1214

1315
## Installation
1416

@@ -44,13 +46,25 @@ Inherits [View Props](https://facebook.github.io/react-native/docs/view#props)
4446

4547
> `?number` | defaults to `48`
4648
47-
Width and height of the spinner
49+
Width and height of the spinner.
4850

4951
### color
5052

5153
> `?string` | defaults to `#000`
5254
53-
Color of the spinner
55+
Color of the spinner.
56+
57+
### animating
58+
59+
> `?boolean` | defaults to `true`
60+
61+
Whether to show the indicator or hide it.
62+
63+
### hidesWhenStopped
64+
65+
> `?boolean` | defaults to `true`
66+
67+
Whether the indicator should hide when not animating.
5468

5569
## Spinners
5670

0 commit comments

Comments
 (0)