Skip to content

Commit b7bc25e

Browse files
committed
chore(image-zoom): update readme
1 parent 16528c6 commit b7bc25e

File tree

2 files changed

+71
-3
lines changed

2 files changed

+71
-3
lines changed

docs/src/api-reference/image-zoom.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,68 @@
1-
# ImageZoom
1+
# ImageZoom
2+
3+
# ImageCacheIt
4+
5+
| Android Device | Android Emulator | iOS Device | iOS Simulator |
6+
| :-------------: |:-------------: |:-------------:| :-----: |
7+
| :white_check_mark:|:white_check_mark: |:white_check_mark:| :white_check_mark:|
8+
9+
10+
11+
# Configuration
12+
13+
### Core
14+
15+
::: tip IMPORTANT
16+
Ensure you've included `xmlns:ui="@triniwiz/nativescript-image-zoom"` on the
17+
Page element
18+
:::
19+
20+
```xml
21+
<ui:ImageZoom src="~/images/148080.jpg" maxZoom="5" minZoom="2"/>
22+
```
23+
24+
### Angular
25+
26+
```ts
27+
import { registerElement } from '@nativescript/angular/element-registry';
28+
registerElement('ImageZoom', () => require('@triniwiz/nativescript-image-zoom').ImageZoom);
29+
```
30+
31+
### Vue
32+
33+
```ts
34+
import { registerElement } from "nativescript-vue'";
35+
registerElement('ImageZoom', () => require('@triniwiz/nativescript-image-zoom').ImageZoom);
36+
```
37+
38+
39+
40+
### React
41+
42+
```ts
43+
import { registerElement } from "react-nativescript";
44+
registerElement('ImageZoom', () => require('@triniwiz/nativescript-image-zoom').ImageZoom);
45+
```
46+
47+
48+
49+
### Svelte
50+
51+
```ts
52+
import { registerNativeViewElement } from 'svelte-native/dom';
53+
registerNativeViewElement('ImageZoom', () => require('@triniwiz/nativescript-image-zoom').ImageZoom);
54+
```
55+
56+
```html
57+
<ImageZoom src="~/images/148080.jpg" maxZoom="5" minZoom="2"></ImageZoom>
58+
```
59+
60+
61+
## API
62+
63+
| Property | Default | Type | iOS | Android |
64+
| :-------------:|:-------------: |:-------------:| :-----:| :-----:|
65+
| maxZoom |5 | string | :white_check_mark: | :white_check_mark: |
66+
| minZoom |1 | string | :white_check_mark: | :white_check_mark: |
67+
| zoomScale |1 | string | :white_check_mark: | :x: |
68+
| src |undefined | string | :white_check_mark: | :white_check_mark: |

packages/nativescript-image-zoom/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
ns plugin add @triniwiz/nativescript-image-zoom
55
```
66

7-
## Usage
7+
## API documentation
8+
9+
[Documentation for the latest stable release](https://triniwiz.github.io/nativescript-plugins/api-reference/image-zoom.html)
810

9-
// TODO
1011

1112
## License
1213

0 commit comments

Comments
 (0)