1- <img alt =" React Native Typescript Library Starter " src =" assets/logo.png " width =" 1050 " />
1+ <img alt =" React Native Animated " src =" assets/logo.png " width =" 1050 " />
22
3- [ ![ Battle Tested ✅] ( https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge )] ( https://github.com/WrathChaos/react-native-typescript-library-starter )
3+ [ ![ Battle Tested ✅] ( https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge )] ( https://github.com/WrathChaos/react-native-animated-component )
44
5- [ ![ React Native Typescript Library Starter ] ( https://img.shields.io/badge/-Extremely%20easy%20to%20create%20a% 20React%20Native%20Component%20Library%20with%20both%20Stateful%20and%20Functional% 20Component%20Examples -orange?style=for-the-badge )] ( https://github.com/WrathChaos/react-native-typescript-library-starter )
5+ [ ![ Animate any components with React Native Animated Component ] ( https://img.shields.io/badge/-Animate%20any%20components%20with% 20React%20Native%20Animated% 20Component-orange?style=for-the-badge )] ( https://github.com/WrathChaos/react-native-animated-component )
66
7- [ ![ npm version] ( https://img.shields.io/npm/v/react-native-typescript-library-starter .svg?style=for-the-badge )] ( https://www.npmjs.com/package/react-native-typescript-library-starter )
8- [ ![ npm] ( https://img.shields.io/npm/dt/react-native-typescript-library-starter .svg?style=for-the-badge )] ( https://www.npmjs.com/package/react-native-typescript-library-starter )
7+ [ ![ npm version] ( https://img.shields.io/npm/v/react-native-animated-component .svg?style=for-the-badge )] ( https://www.npmjs.com/package/react-native-animated-component )
8+ [ ![ npm] ( https://img.shields.io/npm/dt/react-native-animated-component .svg?style=for-the-badge )] ( https://www.npmjs.com/package/react-native-animated-component )
99![ Platform - Android and iOS] ( https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge )
1010[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge )] ( https://opensource.org/licenses/MIT )
1111[ ![ styled with prettier] ( https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge )] ( https://github.com/prettier/prettier )
1212
1313<p align =" center " >
14- <img alt="React Native Typescript Library Starter"
15- src="assets/Screenshots/typescript.jpg" />
14+ <img alt="React Native Animated"
15+ src="assets/Screenshots/react-native-animated.gif" />
16+ <img alt="React Native Animated"
17+ src="assets/Screenshots/react-native-animated-component.gif" />
1618</p >
1719
18- ## Library Usage
19-
20- - ` npm i `
21- - Delete example folder
22- - Delete build folder
23- - Make your own library into the ` lib ` folder
24- - Change package.json
25- - Change README for your own documentation
26- - ` npm run build `
27-
28- ```
29- > [email protected] build /Users/kuray/Coursion/MyLibraries/ReactNative/react-native-typescript-library-starter 30- > cd lib && tsc && cp ../package.json ../build/dist/ && Echo Build completed!
31-
32- Build completed!
33- ```
34-
35- - Test your build/dist into the new project
36- - Finally, time to npm publish :)
37-
38- ### Below part is for Documentation ! Remove above Library Usage
39-
4020# Installation
4121
4222Add the dependency:
4323
4424``` bash
45- npm i react-native-typescript-library-starter
25+ npm i react-native-animated-component
4626```
4727
4828## Peer Dependencies
4929
50- <h5 ><i >IMPORTANT! You need install them</i ></h5 >
51-
52- ``` js
53- " react" : " >= 16.x.x" ,
54- " react-native" : " >= 0.55.x" ,
55- ```
30+ <i >Zero Dependencies</i >
5631
5732# Usage
5833
5934## Import
6035
6136``` jsx
62- import MyComponent from " react-native-typescript-library-starter " ;
37+ import RNAnimated from " react-native-animated-component " ;
6338```
6439
6540## Fundamental Usage
6641
6742``` jsx
68- < MyComponent / >
43+ < RNAnimated
44+ appearFrom= " left"
45+ animationDuration= {1300 }
46+ style= {{ alignItems: " center" }}
47+ >
48+ {staticData .map (() => renderItem ())}
49+ < / RNAnimated>
6950```
7051
7152## Example Project 😍
@@ -83,21 +64,13 @@ should work of the example project.
8364
8465## Fundamentals
8566
86- | Property | Type | Default | Description |
87- | ----------- | :----: | :-------: | --------------------- |
88- | title | string | undefined | change the title |
89- | description | string | undefined | change the descrition |
90-
91- ## Customization (Optionals)
92-
93- | Property | Type | Default | Description |
94- | -------------- | :-------: | :-------: | ---------------------------------------------------------------------- |
95- | enableButton | boolean | false | let you enable the button (must use it for button) |
96- | onPress | function | undefined | set your own logic for the button functionality when it is pressed |
97- | buttonText | string | undefined | change the button's text |
98- | style | ViewStyle | default | set or override the style object for the main container |
99- | buttonStyle | ViewStyle | default | set or override the style object for the button style |
100- | ImageComponent | Image | default | set your own component instead of default react-native Image component |
67+ | Property | Type | Default | Description |
68+ | ----------------- | :--------: | :-----: | --------------------------------------------------------------------- |
69+ | appearFrom | AppearFrom | "left" | The component will appear from that direction |
70+ | animationDuration | number | 300 | change the animation duration |
71+ | style | ViewStyle | default | set or override the style object for the main container |
72+ | initialDelay | number | default | change the initial delay of the appearing animation |
73+ | delayInterval | number | 200 | change the each children's delay interval in each appearing animation |
10174
10275## Future Plans
10376
11891
11992## License
12093
121- React Native Typescript Library Starter is available under the MIT license. See the LICENSE file for more info.
94+ React Native Animated is available under the MIT license. See the LICENSE file for more info.
0 commit comments