Skip to content

Commit ed74575

Browse files
committed
READMe is updated
1 parent 7694e50 commit ed74575

1 file changed

Lines changed: 39 additions & 8 deletions

File tree

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,26 @@
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

13-
<p align="center">
14-
<img alt="React Native Progressive Fast Image"
13+
<table>
14+
<tr>
15+
<td>
16+
<b>Progressive Fast Image</b>
17+
</td>
18+
<td>
19+
<b>Built-in Loading Progressive Fast Image</b>
20+
</td>
21+
</tr>
22+
<tr>
23+
<td align="center">
24+
<img alt="React Native Progressive Fast Image"
1525
src="assets/Screenshots/React-Native-Progressive-Fast-Image.gif" />
16-
</p>
26+
</td>
27+
<td align="center">
28+
<img alt="React Native Progressive Fast Image"
29+
src="assets/Screenshots/React-Native-Progressive-Fast-Image-Loading.gif" />
30+
</td>
31+
</tr>
32+
</table>
1733

1834
# Installation
1935

@@ -52,15 +68,30 @@ It accepts every `Image` and `FastImage` props. You can use it like you used to.
5268

5369
# Configuration - Props
5470

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 |
71+
useNativeDriver?: boolean;
72+
73+
| Property | Type | Default | Description |
74+
| --------------- | :-----------------: | :-------: | ------------------------------------- |
75+
| source | Source | undefined | set the main source of the image |
76+
| thumbnailSource | ImageSourcePropType | undefined | set the thumbnail source of the image |
77+
| loadingSource | ImageSourcePropType | undefined | set the error source of the image |
78+
| errorSource | ImageSourcePropType | undefined | set the loading source of the image |
79+
80+
## Customization Props
81+
82+
| Property | Type | Default | Description |
83+
| -------------------------- | :-----: | :-----: | ------------------------------------------- |
84+
| style | style | default | change or override main image style |
85+
| loadingImageStyle | style | default | change or override loading image style |
86+
| thumbnailAnimationDuration | number | default | change the thumbnail animation's duration |
87+
| imageAnimationDuration | number | default | change the main image animation's duration |
88+
| useNativeDriver | boolean | true | change the animations useNativeDriver value |
5989

6090
## Future Plans
6191

6292
- [x] ~~LICENSE~~
63-
- [ ] Built-in Loading Indicator
93+
- [x] ~~Built-in Loading Indicator~~
94+
- [x] ~~Built-in Error Image Source~~
6495
- [ ] Write an article about the lib on Medium
6596

6697
## Better with built-in bug fix

0 commit comments

Comments
 (0)