Skip to content

Commit aa31bb8

Browse files
kuraydevkuraydev
committed
RNBounceable is ready to deploy
1 parent 57c3799 commit aa31bb8

3 files changed

Lines changed: 37 additions & 58 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,69 @@
1-
<img alt="React Native Typescript Library Starter" src="assets/logo.png" width="1050"/>
1+
<img alt="React Native Bounceable" 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-bounceable)
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+
[![React Native Bounceable](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-bounceable)
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/@freakycoder/react-native-bounceable.svg?style=for-the-badge)](https://www.npmjs.com/package/@freakycoder/react-native-bounceable)
8+
[![npm](https://img.shields.io/npm/dt/@freakycoder/react-native-bounceable.svg?style=for-the-badge)](https://www.npmjs.com/package/@freakycoder/react-native-bounceable)
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"
14+
<img alt="React Native Bounceable"
1515
src="assets/Screenshots/typescript.jpg" />
1616
</p>
1717

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-
> react-native-typescript-library-starter@0.1.0 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-
4018
# Installation
4119

4220
Add the dependency:
4321

4422
```bash
45-
npm i react-native-typescript-library-starter
46-
```
47-
48-
## Peer Dependencies
49-
50-
<h5><i>IMPORTANT! You need install them</i></h5>
51-
52-
```js
53-
"react": ">= 16.x.x",
54-
"react-native": ">= 0.55.x",
23+
npm i @freakycoder/react-native-bounceable
5524
```
5625

5726
# Usage
5827

5928
## Import
6029

6130
```jsx
62-
import MyComponent from "react-native-typescript-library-starter";
31+
import RNBounceable from "@freakycoder/react-native-bounceable";
6332
```
6433

6534
## Fundamental Usage
6635

36+
You can put **ANY children component** inside the **RNBounceable** component, it will make it bounce when it is pressed
37+
6738
```jsx
68-
<MyComponent />
39+
<RNBounceable onPress={() => {}}>
40+
<View style={styles.bounceButtonStyle}>
41+
<Text style={styles.bounceButtonTextStyle}>Bounce</Text>
42+
</View>
43+
</RNBounceable>
6944
```
7045

7146
# Configuration - Props
7247

73-
| Property | Type | Default | Description |
48+
Coming Soon with more customizable props
49+
50+
<!-- | Property | Type | Default | Description |
7451
| -------- | :-----: | :-----: | ------------------------------------------------------- |
75-
| outline | boolean | true | make the button outline |
76-
| solid | boolean | false | make the button with a solid background and a shadow |
77-
| gradient | boolean | false | make the button with a gradient background and a shadow |
78-
| width | number | 150 | change the button's width |
52+
| outline | boolean | true | make the button outline |
53+
| solid | boolean | false | make the button with a solid background and a shadow |
54+
| gradient | boolean | false | make the button with a gradient background and a shadow |
55+
| width | number | 150 | change the button's width | -->
7956

8057
## Future Plans
8158

8259
- [x] ~~LICENSE~~
60+
- [ ] More customizable animation props
8361
- [ ] Write an article about the lib on Medium
8462

85-
# Change Log
86-
87-
Change log will be here !
88-
8963
## Author
9064

9165
FreakyCoder, kurayogun@gmail.com
9266

9367
## License
9468

95-
React Native Typescript Library Starter is available under the MIT license. See the LICENSE file for more info.
69+
React Native Bounceable is available under the MIT license. See the LICENSE file for more info.

‎example/App.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import React from "react";
22
import { View, Text, StatusBar, SafeAreaView } from "react-native";
3-
import RNBounceable from "./build/dist/RNBounceable";
3+
import RNBounceable from "@freakycoder/react-native-bounceable";
44

55
const App = () => {
66
return (
77
<>
88
<StatusBar barStyle="dark-content" />
99
<SafeAreaView style={styles.container}>
10-
<RNBounceable>
10+
<RNBounceable onPress={() => {}}>
1111
<View style={styles.bounceButtonStyle}>
1212
<Text style={styles.bounceButtonTextStyle}>Bounce</Text>
1313
</View>

‎package.json‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
{
2-
"name": "react-native-typescript-library-starter",
3-
"version": "1.0.1",
4-
"description": "Extremely easy to create a React Native Component Library with both Stateful and Functional Component Examples.",
5-
"main": "./build/dist/index.js",
6-
"repository": "git@github.com:WrathChaos/react-native-typescript-library-starter.git",
2+
"name": "@freakycoder/react-native-bounceable",
3+
"version": "0.1.0",
4+
"description": "Fully customizable, animated, bounceable container for React Native",
5+
"main": "./build/dist/RNBounceable.js",
6+
"repository": "git@github.com:WrathChaos/react-native-bounceable.git",
77
"author": "FreakyCoder <kurayogun@gmail.com>",
88
"license": "MIT",
99
"homepage": "https://www.freakycoder.com",
10-
"bugs": "https://github.com/WrathChaos/react-native-typescript-library-starter/issues",
10+
"bugs": "https://github.com/WrathChaos/react-native-bounceable/issues",
1111
"keywords": [
12+
"bounceable",
13+
"rn-bounceable",
14+
"react-native-bounceable",
15+
"animated",
16+
"animation",
1217
"FreakyCoder",
1318
"freakycoder",
1419
"kuray",

0 commit comments

Comments
 (0)