From e65406cc2fad750668f9ceaff5e7e67734014ca7 Mon Sep 17 00:00:00 2001 From: Quentin Ligier Date: Fri, 6 Oct 2017 05:23:09 +0200 Subject: [PATCH] refactor(photo-viewer): improve options documentation (#2014) --- src/@ionic-native/plugins/photo-viewer/index.ts | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/@ionic-native/plugins/photo-viewer/index.ts b/src/@ionic-native/plugins/photo-viewer/index.ts index f6de6076d..5c4481d05 100644 --- a/src/@ionic-native/plugins/photo-viewer/index.ts +++ b/src/@ionic-native/plugins/photo-viewer/index.ts @@ -1,5 +1,13 @@ import { Injectable } from '@angular/core'; import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; + +export interface PhotoViewerOptions { + /** + * Set to false to disable the share button (Android only). Default: true + */ + share?: boolean; +} + /** * @name Photo Viewer * @description This plugin can display your image in full screen with the ability to pan, zoom, and share the image. @@ -29,8 +37,8 @@ export class PhotoViewer extends IonicNativePlugin { * Shows an image in full screen * @param url {string} URL or path to image * @param title {string} - * @param options {any} + * @param options {PhotoViewerOptions} */ @Cordova({sync: true}) - show(url: string, title?: string, options?: {share?: boolean}): void { } + show(url: string, title?: string, options?: PhotoViewerOptions): void { } }