Skip to content

Commit f9aa1eb

Browse files
authored
Merge pull request #12 from codesyntax/develop
readme
2 parents c1e615f + 3d3c2a9 commit f9aa1eb

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

readme.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,43 @@
11
# Ionic React Photo Viewer
22

3-
## [DEMO](https://codesyntax.github.io/ionic-react-photo-viewer/?path=/story/example-ionphotoviewer--ion-avatar-item-example)
3+
##### Table of Contents
4+
5+
* [Demo](#demo)
6+
* [Features](#features)
7+
* [Installation](#installation)
8+
* [Use example](#example)
9+
* [Props](#props)
10+
11+
12+
<a name="demo"/>
13+
14+
## [Demo](https://codesyntax.github.io/ionic-react-photo-viewer/?path=/story/example-ionphotoviewer--ion-avatar-item-example)
415
A react component for displaying images adapted to Ionic design.
516

6-
The features:
17+
<a name="features"/>
18+
19+
## Features:
720

821
* Pinch-to-zoom capability.
922
* IonAvatar and IonThumbnail support.
1023
* Blurred background support ([Available for Chrome and Safari](https://caniuse.com/css-backdrop-filter)).
1124
* IonHeader integration to adapt it to the native design.
1225

13-
![IonPhotoViewer demo](./docs/ion-photo-viewer-demo.gif)
1426

27+
https://user-images.githubusercontent.com/26112509/168749351-b7446907-458f-424f-86c9-c5ef639353d2.mov
28+
29+
https://user-images.githubusercontent.com/26112509/168749387-d7bb7b4a-f968-4e63-aaa2-876527ee6a58.mov
30+
31+
32+
<a name="installation"/>
1533

1634
## Installation
1735
```bash
1836
npm install --save @codesyntax/ionic-react-photo-viewer
1937
```
2038

39+
<a name="example"/>
40+
2141
## Use example
2242
```tsx
2343
// import component
@@ -40,6 +60,7 @@ import IonPhotoViewer from '@codesyntax/ionic-react-photo-viewer';
4060
<IonLabel>Martin arrantzalea</IonLabel>
4161
</IonItem>
4262
```
63+
<a name="props"/>
4364

4465
## Props
4566
* title: string
@@ -49,4 +70,4 @@ import IonPhotoViewer from '@codesyntax/ionic-react-photo-viewer';
4970
* licenseKey: string
5071
* The license key of lightgallery.
5172
* children: React.ReactNode
52-
* Img element.
73+
* Img element.

0 commit comments

Comments
 (0)