Skip to content

Commit 74357f2

Browse files
kuraydevkuraydev
committed
Ready to deploy
1 parent e0e65b4 commit 74357f2

4 files changed

Lines changed: 38 additions & 52 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,71 @@
1-
<img alt="React Native Typescript Library Starter" src="assets/logo.png" width="1050"/>
1+
<img alt="React Native Progressive Fast Image" 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-progressive-fast-image)
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+
[![Customizable progressive image for React Native with FastImage](https://img.shields.io/badge/-Customizable%20progressive%20image%20for%20React%20Native%20with%20FastImage-orange?style=for-the-badge)](https://github.com/WrathChaos/@freakycoder/react-native-progressive-fast-image)
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-progressive-fast-image.svg?style=for-the-badge)](https://www.npmjs.com/package/@freakycoder/react-native-progressive-fast-image)
8+
[![npm](https://img.shields.io/npm/dt/@freakycoder/react-native-progressive-fast-image.svg?style=for-the-badge)](https://www.npmjs.com/package/@freakycoder/react-native-progressive-fast-image)
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 Progressive Fast Image"
15+
src="assets/Screenshots/React-Native-Progressive-Fast-Image.gif" />
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
23+
npm i @freakycoder/react-native-progressive-fast-image
4624
```
4725

4826
## Peer Dependencies
4927

5028
<h5><i>IMPORTANT! You need install them</i></h5>
5129

5230
```js
53-
"react": ">= 16.x.x",
54-
"react-native": ">= 0.55.x",
31+
"react-native-fast-image": ">= 8.3.2"
5532
```
5633

5734
# Usage
5835

5936
## Import
6037

6138
```jsx
62-
import MyComponent from "react-native-typescript-library-starter";
39+
import ProgressiveFastImage from "@freakycoder/react-native-progressive-fast-image";
6340
```
6441

6542
## Fundamental Usage
6643

44+
It accepts every `Image` and `FastImage` props. You can use it like you used to.
45+
6746
```jsx
68-
<MyComponent />
47+
<ProgressiveFastImage
48+
source={require("./assets/my-image.png")}
49+
thumbnailSource={require("./assets/my-image.png")}
50+
/>
6951
```
7052

7153
# Configuration - Props
7254

73-
| Property | Type | Default | Description |
74-
| -------- | :-----: | :-----: | ------------------------------------------------------- |
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 |
55+
| Property | Type | Default | Description |
56+
| --------------- | :---: | :-------: | ------------------------------------- |
57+
| source | image | undefined | set the main source of the image |
58+
| thumbnailSource | image | undefined | set the thumbnail source of the image |
7959

8060
## Future Plans
8161

8262
- [x] ~~LICENSE~~
8363
- [ ] Write an article about the lib on Medium
8464

85-
# Change Log
86-
87-
Change log will be here !
88-
8965
## Author
9066

9167
FreakyCoder, kurayogun@gmail.com
9268

9369
## License
9470

95-
React Native Typescript Library Starter is available under the MIT license. See the LICENSE file for more info.
71+
React Native Progressive Fast Image is available under the MIT license. See the LICENSE file for more info.

‎assets/Screenshots/React-Native-Progressive-Fast-Image.gif‎

18.8 MB
Loading

‎example/App.tsx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import React from "react";
22
import { StatusBar, FlatList, Dimensions } from "react-native";
3-
import ProgressiveFastImage from "./build/dist/ProgressiveFastImage";
3+
import ProgressiveFastImage from "@freakycoder/react-native-progressive-fast-image";
44
const { width: ScreenWidth } = Dimensions.get("window");
5+
console.disableYellowBox = true;
56

67
const images = [
78
{
@@ -76,6 +77,7 @@ const App = () => {
7677

7778
return (
7879
<ProgressiveFastImage
80+
key={item}
7981
style={{
8082
width: ScreenWidth / 2,
8183
height: ScreenWidth / 2,

‎package.json‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
{
2-
"name": "react-native-typescript-library-starter",
2+
"name": "@freakycoder/react-native-progressive-fast-image",
33
"version": "0.1.0",
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",
4+
"description": "Customizable progressive image for React Native with FastImage",
5+
"main": "./build/dist/ProgressiveFastImage.js",
6+
"repository": "git@github.com:WrathChaos/react-native-progressive-fast-image.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-progressive-fast-image/issues",
1111
"keywords": [
12+
"progressive",
13+
"lazy",
14+
"lazy-load",
15+
"fast-image",
16+
"image",
17+
"progressive-image",
18+
"progressive-fast-image",
1219
"FreakyCoder",
1320
"freakycoder",
1421
"kuray",
@@ -28,7 +35,8 @@
2835
},
2936
"peerDependencies": {
3037
"react": ">= 16.x.x",
31-
"react-native": ">= 0.55.x"
38+
"react-native": ">= 0.55.x",
39+
"react-native-fast-image": ">= 8.3.2"
3240
},
3341
"devDependencies": {
3442
"@types/react": "^16.9.22",

0 commit comments

Comments
 (0)