@alitajs/fileviewer

Documents and images viewer

Install

npm install @alitajs/fileviewer
npx cap sync

iOS

• in Xcode, open Info.plist and add a new Information Property like Privacy - Photo Library Usage Description and set a value to We need to write photos. This is required to have the Shareof images and the create Movie working.

API

• openDocument(...)
• previewImage(...)
• Interfaces

openDocument(...)

openDocument(options: OpenDocumentOptions) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | OpenDocumentOptions |

previewImage(...)

previewImage(options: PreviewImageOptions) => Promise<PreviewImageResult>

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | PreviewImageOptions |

Returns: Promise<PreviewImageResult>

Interfaces

OpenDocumentOptions

| Prop | Type | Description | | -------------- | ------------------- | ----------- | | filePath | string | 文件本地路径 |

PreviewImageResult

| Prop | Type | Description | | ---------------- | -------------------- | ----------------------------------------------------------- | | result | boolean | result set to true when successful else false | | message | string | a returned message | | imageIndex | number | Result Image index at closing returned |

PreviewImageOptions

| Prop | Type | Description | | --------------- | ------------------------------------------------------- | ---------------------------------------------------------- | | images | Image[] | List of image | | options | ViewerOptions | Viewer options (optional) | | mode | 'gallery' | 'slider' | 'one' | Viewer mode ("gallery","slider","one") (default "slider") | | startFrom | number | Viewer image index to start from for mode ("slider","one") |

Image

| Prop | Type | Description | | ----------- | ------------------- | -------------------- | | url | string | image url | | title | string | image title optional |

ViewerOptions

| Prop | Type | Description | | ------------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------ | | share | boolean | display the share button (default true) | | title | boolean | display the image title if any (default true) | | transformer | string | transformer Android "zoom", "depth" or "none" (default "zoom") | | spancount | number | Grid span count (default 3) | | maxzoomscale | number | Max Zoom Scale (default 3) | | compressionquality | number | Compression Quality for Sharing Image range [0-1] (default 0.8) | | divid | string | Div HTML Element Id (Web only) (default 'photoviewer-container') | | movieoptions | MovieOptions | Movie Options iOS only |

MovieOptions

| Prop | Type | Description | | --------------- | ------------------- | ------------------------------------------------------------------------ | | name | string | Movie Name (default "myMovie") iOS only | | imagetime | number | Image Time Duration in Seconds (default 3) iOS only | | mode | string | Movie Mode "portrait" / "landscape" (default "landscape") iOS only | | ratio | string | Movie Ratio "4/3" / "16/9" (default "16/9") iOS only |

How to use this plugin in existing native project

ios

in Podfile

pod 'AlitajsBarcode'

android

in build.gradle

repositories {
  ...
  maven { url 'https://jitpack.io' }
}

dependencies {
  implementation 'com.github.alitajs:alitajs-native-barcode:Tag'
}