Skip to content

readme #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2022
Merged

readme #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,43 @@
# Ionic React Photo Viewer

## [DEMO](https://codesyntax.github.io/ionic-react-photo-viewer/?path=/story/example-ionphotoviewer--ion-avatar-item-example)
##### Table of Contents

* [Demo](#demo)
* [Features](#features)
* [Installation](#installation)
* [Use example](#example)
* [Props](#props)


<a name="demo"/>

## [Demo](https://codesyntax.github.io/ionic-react-photo-viewer/?path=/story/example-ionphotoviewer--ion-avatar-item-example)
A react component for displaying images adapted to Ionic design.

The features:
<a name="features"/>

## Features:

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

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

https://user-images.githubusercontent.com/26112509/168749351-b7446907-458f-424f-86c9-c5ef639353d2.mov

https://user-images.githubusercontent.com/26112509/168749387-d7bb7b4a-f968-4e63-aaa2-876527ee6a58.mov


<a name="installation"/>

## Installation
```bash
npm install --save @codesyntax/ionic-react-photo-viewer
```

<a name="example"/>

## Use example
```tsx
// import component
Expand All @@ -40,6 +60,7 @@ import IonPhotoViewer from '@codesyntax/ionic-react-photo-viewer';
<IonLabel>Martin arrantzalea</IonLabel>
</IonItem>
```
<a name="props"/>

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