From e965d654c54eeffc00ed52647734bb3cbcce0d04 Mon Sep 17 00:00:00 2001 From: perry Date: Thu, 9 Feb 2017 11:40:55 -0600 Subject: [PATCH] readme templates --- scripts/docs/dgeni-readmes-config.js | 2 +- scripts/docs/templates/readme.template.md | 54 +++ src/@ionic-native/plugins/3dtouch/readme.md | 28 ++ .../plugins/actionsheet/readme.md | 32 ++ src/@ionic-native/plugins/admob/readme.md | 30 ++ .../android-fingerprint-auth/readme.md | 21 + .../plugins/appavailability/readme.md | 31 ++ src/@ionic-native/plugins/apprate/readme.md | 31 ++ .../plugins/appversion/readme.md | 31 ++ .../plugins/background-geolocation/readme.md | 31 ++ .../plugins/backgroundmode/readme.md | 31 ++ src/@ionic-native/plugins/backlight/readme.md | 34 ++ src/@ionic-native/plugins/badge/readme.md | 35 ++ .../plugins/barcodescanner/readme.md | 36 ++ .../plugins/base64togallery/readme.md | 30 ++ .../plugins/batterystatus/readme.md | 36 ++ src/@ionic-native/plugins/ble/readme.md | 41 ++ .../plugins/bluetoothserial/readme.md | 31 ++ .../plugins/brightness/readme.md | 31 ++ .../plugins/broadcaster/readme.md | 29 ++ src/@ionic-native/plugins/calendar/readme.md | 31 ++ .../plugins/call-number/readme.md | 29 ++ .../plugins/camera-preview/readme.md | 37 ++ src/@ionic-native/plugins/camera/readme.md | 38 ++ src/@ionic-native/plugins/card-io/readme.md | 29 ++ src/@ionic-native/plugins/clipboard/readme.md | 39 ++ src/@ionic-native/plugins/code-push/readme.md | 31 ++ src/@ionic-native/plugins/contacts/readme.md | 21 + .../_includes/v2_fluid/native_menu.html | 366 ++++++++++++++++++ src/@ionic-native/plugins/crop/readme.md | 21 + .../plugins/datepicker/readme.md | 30 ++ src/@ionic-native/plugins/dbmeter/readme.md | 29 ++ src/@ionic-native/plugins/deeplinks/readme.md | 30 ++ .../plugins/device-feedback/readme.md | 28 ++ src/@ionic-native/plugins/device/readme.md | 21 + .../plugins/deviceaccounts/readme.md | 29 ++ .../plugins/devicemotion/readme.md | 21 + .../plugins/deviceorientation/readme.md | 21 + .../plugins/diagnostic/readme.md | 21 + src/@ionic-native/plugins/dialogs/readme.md | 23 ++ .../plugins/emailcomposer/readme.md | 38 ++ .../plugins/estimote-beacons/readme.md | 29 ++ src/@ionic-native/plugins/facebook/readme.md | 84 ++++ .../plugins/file-chooser/readme.md | 28 ++ .../plugins/file-opener/readme.md | 21 + src/@ionic-native/plugins/file/readme.md | 37 ++ src/@ionic-native/plugins/filepath/readme.md | 28 ++ .../plugins/filetransfer/readme.md | 21 + .../plugins/fingerprint-aio/readme.md | 36 ++ src/@ionic-native/plugins/firebase/readme.md | 29 ++ .../plugins/flashlight/readme.md | 23 ++ src/@ionic-native/plugins/geofence/readme.md | 32 ++ .../plugins/geolocation/readme.md | 23 ++ .../plugins/globalization/readme.md | 35 ++ .../plugins/google-plus/readme.md | 30 ++ .../plugins/googleanalytics/readme.md | 34 ++ src/@ionic-native/plugins/googlemap/readme.md | 21 + .../plugins/headercolor/readme.md | 28 ++ src/@ionic-native/plugins/hotspot/readme.md | 34 ++ src/@ionic-native/plugins/http/readme.md | 33 ++ src/@ionic-native/plugins/httpd/readme.md | 29 ++ src/@ionic-native/plugins/ibeacon/readme.md | 31 ++ .../plugins/imagepicker/readme.md | 24 ++ .../plugins/imageresizer/readme.md | 26 ++ .../plugins/inappbrowser/readme.md | 21 + .../plugins/inapppurchase/readme.md | 29 ++ src/@ionic-native/plugins/insomnia/readme.md | 30 ++ src/@ionic-native/plugins/instagram/readme.md | 21 + src/@ionic-native/plugins/is-debug/readme.md | 22 ++ src/@ionic-native/plugins/keyboard/readme.md | 21 + .../plugins/launch-review/readme.md | 31 ++ .../plugins/launchnavigator/readme.md | 21 + .../plugins/localnotifications/readme.md | 21 + .../plugins/location-accuracy/readme.md | 21 + src/@ionic-native/plugins/market/readme.md | 21 + .../plugins/media-capture/readme.md | 21 + src/@ionic-native/plugins/media/readme.md | 21 + src/@ionic-native/plugins/mixpanel/readme.md | 21 + .../plugins/music-controls/readme.md | 23 ++ .../plugins/native-audio/readme.md | 21 + .../plugins/native-geocoder/readme.md | 35 ++ .../plugins/native-page-transitions/readme.md | 30 ++ .../plugins/nativestorage/readme.md | 21 + .../plugins/navigationbar/readme.md | 34 ++ src/@ionic-native/plugins/network/readme.md | 36 ++ src/@ionic-native/plugins/nfc/readme.md | 29 ++ src/@ionic-native/plugins/onesignal/readme.md | 34 ++ src/@ionic-native/plugins/pay-pal/readme.md | 21 + .../plugins/photo-viewer/readme.md | 21 + .../plugins/pin-dialog/readme.md | 21 + src/@ionic-native/plugins/pinterest/readme.md | 35 ++ .../plugins/power-management/readme.md | 22 ++ src/@ionic-native/plugins/printer/readme.md | 29 ++ src/@ionic-native/plugins/push/readme.md | 25 ++ src/@ionic-native/plugins/rollbar/readme.md | 35 ++ .../plugins/safari-view-controller/readme.md | 29 ++ .../plugins/screen-orientation/readme.md | 33 ++ .../plugins/screenshot/readme.md | 21 + .../plugins/securestorage/readme.md | 33 ++ src/@ionic-native/plugins/serial/readme.md | 28 ++ src/@ionic-native/plugins/shake/readme.md | 21 + src/@ionic-native/plugins/sim/readme.md | 32 ++ src/@ionic-native/plugins/sms/readme.md | 30 ++ .../plugins/socialsharing/readme.md | 30 ++ .../plugins/speech-recognition/readme.md | 35 ++ .../plugins/spinnerdialog/readme.md | 30 ++ .../plugins/splashscreen/readme.md | 21 + src/@ionic-native/plugins/sqlite/readme.md | 21 + src/@ionic-native/plugins/statusbar/readme.md | 34 ++ .../plugins/stepcounter/readme.md | 32 ++ .../plugins/streaming-media/readme.md | 29 ++ src/@ionic-native/plugins/stripe/readme.md | 27 ++ .../plugins/text-to-speech/readme.md | 21 + .../plugins/themeable-browser/readme.md | 21 + src/@ionic-native/plugins/toast/readme.md | 32 ++ src/@ionic-native/plugins/touchid/readme.md | 30 ++ .../plugins/twitter-connect/readme.md | 41 ++ src/@ionic-native/plugins/vibration/readme.md | 32 ++ .../plugins/video-editor/readme.md | 30 ++ .../plugins/video-player/readme.md | 30 ++ src/@ionic-native/plugins/webintent/readme.md | 28 ++ .../plugins/youtube-video-player/readme.md | 29 ++ src/@ionic-native/plugins/z-bar/readme.md | 31 ++ src/@ionic-native/plugins/zip/readme.md | 21 + 124 files changed, 3899 insertions(+), 1 deletion(-) create mode 100644 scripts/docs/templates/readme.template.md create mode 100644 src/@ionic-native/plugins/3dtouch/readme.md create mode 100644 src/@ionic-native/plugins/actionsheet/readme.md create mode 100644 src/@ionic-native/plugins/admob/readme.md create mode 100644 src/@ionic-native/plugins/android-fingerprint-auth/readme.md create mode 100644 src/@ionic-native/plugins/appavailability/readme.md create mode 100644 src/@ionic-native/plugins/apprate/readme.md create mode 100644 src/@ionic-native/plugins/appversion/readme.md create mode 100644 src/@ionic-native/plugins/background-geolocation/readme.md create mode 100644 src/@ionic-native/plugins/backgroundmode/readme.md create mode 100644 src/@ionic-native/plugins/backlight/readme.md create mode 100644 src/@ionic-native/plugins/badge/readme.md create mode 100644 src/@ionic-native/plugins/barcodescanner/readme.md create mode 100644 src/@ionic-native/plugins/base64togallery/readme.md create mode 100644 src/@ionic-native/plugins/batterystatus/readme.md create mode 100644 src/@ionic-native/plugins/ble/readme.md create mode 100644 src/@ionic-native/plugins/bluetoothserial/readme.md create mode 100644 src/@ionic-native/plugins/brightness/readme.md create mode 100644 src/@ionic-native/plugins/broadcaster/readme.md create mode 100644 src/@ionic-native/plugins/calendar/readme.md create mode 100644 src/@ionic-native/plugins/call-number/readme.md create mode 100644 src/@ionic-native/plugins/camera-preview/readme.md create mode 100644 src/@ionic-native/plugins/camera/readme.md create mode 100644 src/@ionic-native/plugins/card-io/readme.md create mode 100644 src/@ionic-native/plugins/clipboard/readme.md create mode 100644 src/@ionic-native/plugins/code-push/readme.md create mode 100644 src/@ionic-native/plugins/contacts/readme.md create mode 100644 src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html create mode 100644 src/@ionic-native/plugins/crop/readme.md create mode 100644 src/@ionic-native/plugins/datepicker/readme.md create mode 100644 src/@ionic-native/plugins/dbmeter/readme.md create mode 100644 src/@ionic-native/plugins/deeplinks/readme.md create mode 100644 src/@ionic-native/plugins/device-feedback/readme.md create mode 100644 src/@ionic-native/plugins/device/readme.md create mode 100644 src/@ionic-native/plugins/deviceaccounts/readme.md create mode 100644 src/@ionic-native/plugins/devicemotion/readme.md create mode 100644 src/@ionic-native/plugins/deviceorientation/readme.md create mode 100644 src/@ionic-native/plugins/diagnostic/readme.md create mode 100644 src/@ionic-native/plugins/dialogs/readme.md create mode 100644 src/@ionic-native/plugins/emailcomposer/readme.md create mode 100644 src/@ionic-native/plugins/estimote-beacons/readme.md create mode 100644 src/@ionic-native/plugins/facebook/readme.md create mode 100644 src/@ionic-native/plugins/file-chooser/readme.md create mode 100644 src/@ionic-native/plugins/file-opener/readme.md create mode 100644 src/@ionic-native/plugins/file/readme.md create mode 100644 src/@ionic-native/plugins/filepath/readme.md create mode 100644 src/@ionic-native/plugins/filetransfer/readme.md create mode 100644 src/@ionic-native/plugins/fingerprint-aio/readme.md create mode 100644 src/@ionic-native/plugins/firebase/readme.md create mode 100644 src/@ionic-native/plugins/flashlight/readme.md create mode 100644 src/@ionic-native/plugins/geofence/readme.md create mode 100644 src/@ionic-native/plugins/geolocation/readme.md create mode 100644 src/@ionic-native/plugins/globalization/readme.md create mode 100644 src/@ionic-native/plugins/google-plus/readme.md create mode 100644 src/@ionic-native/plugins/googleanalytics/readme.md create mode 100644 src/@ionic-native/plugins/googlemap/readme.md create mode 100644 src/@ionic-native/plugins/headercolor/readme.md create mode 100644 src/@ionic-native/plugins/hotspot/readme.md create mode 100644 src/@ionic-native/plugins/http/readme.md create mode 100644 src/@ionic-native/plugins/httpd/readme.md create mode 100644 src/@ionic-native/plugins/ibeacon/readme.md create mode 100644 src/@ionic-native/plugins/imagepicker/readme.md create mode 100644 src/@ionic-native/plugins/imageresizer/readme.md create mode 100644 src/@ionic-native/plugins/inappbrowser/readme.md create mode 100644 src/@ionic-native/plugins/inapppurchase/readme.md create mode 100644 src/@ionic-native/plugins/insomnia/readme.md create mode 100644 src/@ionic-native/plugins/instagram/readme.md create mode 100644 src/@ionic-native/plugins/is-debug/readme.md create mode 100644 src/@ionic-native/plugins/keyboard/readme.md create mode 100644 src/@ionic-native/plugins/launch-review/readme.md create mode 100644 src/@ionic-native/plugins/launchnavigator/readme.md create mode 100644 src/@ionic-native/plugins/localnotifications/readme.md create mode 100644 src/@ionic-native/plugins/location-accuracy/readme.md create mode 100644 src/@ionic-native/plugins/market/readme.md create mode 100644 src/@ionic-native/plugins/media-capture/readme.md create mode 100644 src/@ionic-native/plugins/media/readme.md create mode 100644 src/@ionic-native/plugins/mixpanel/readme.md create mode 100644 src/@ionic-native/plugins/music-controls/readme.md create mode 100644 src/@ionic-native/plugins/native-audio/readme.md create mode 100644 src/@ionic-native/plugins/native-geocoder/readme.md create mode 100644 src/@ionic-native/plugins/native-page-transitions/readme.md create mode 100644 src/@ionic-native/plugins/nativestorage/readme.md create mode 100644 src/@ionic-native/plugins/navigationbar/readme.md create mode 100644 src/@ionic-native/plugins/network/readme.md create mode 100644 src/@ionic-native/plugins/nfc/readme.md create mode 100644 src/@ionic-native/plugins/onesignal/readme.md create mode 100644 src/@ionic-native/plugins/pay-pal/readme.md create mode 100644 src/@ionic-native/plugins/photo-viewer/readme.md create mode 100644 src/@ionic-native/plugins/pin-dialog/readme.md create mode 100644 src/@ionic-native/plugins/pinterest/readme.md create mode 100644 src/@ionic-native/plugins/power-management/readme.md create mode 100644 src/@ionic-native/plugins/printer/readme.md create mode 100644 src/@ionic-native/plugins/push/readme.md create mode 100644 src/@ionic-native/plugins/rollbar/readme.md create mode 100644 src/@ionic-native/plugins/safari-view-controller/readme.md create mode 100644 src/@ionic-native/plugins/screen-orientation/readme.md create mode 100644 src/@ionic-native/plugins/screenshot/readme.md create mode 100644 src/@ionic-native/plugins/securestorage/readme.md create mode 100644 src/@ionic-native/plugins/serial/readme.md create mode 100644 src/@ionic-native/plugins/shake/readme.md create mode 100644 src/@ionic-native/plugins/sim/readme.md create mode 100644 src/@ionic-native/plugins/sms/readme.md create mode 100644 src/@ionic-native/plugins/socialsharing/readme.md create mode 100644 src/@ionic-native/plugins/speech-recognition/readme.md create mode 100644 src/@ionic-native/plugins/spinnerdialog/readme.md create mode 100644 src/@ionic-native/plugins/splashscreen/readme.md create mode 100644 src/@ionic-native/plugins/sqlite/readme.md create mode 100644 src/@ionic-native/plugins/statusbar/readme.md create mode 100644 src/@ionic-native/plugins/stepcounter/readme.md create mode 100644 src/@ionic-native/plugins/streaming-media/readme.md create mode 100644 src/@ionic-native/plugins/stripe/readme.md create mode 100644 src/@ionic-native/plugins/text-to-speech/readme.md create mode 100644 src/@ionic-native/plugins/themeable-browser/readme.md create mode 100644 src/@ionic-native/plugins/toast/readme.md create mode 100644 src/@ionic-native/plugins/touchid/readme.md create mode 100644 src/@ionic-native/plugins/twitter-connect/readme.md create mode 100644 src/@ionic-native/plugins/vibration/readme.md create mode 100644 src/@ionic-native/plugins/video-editor/readme.md create mode 100644 src/@ionic-native/plugins/video-player/readme.md create mode 100644 src/@ionic-native/plugins/webintent/readme.md create mode 100644 src/@ionic-native/plugins/youtube-video-player/readme.md create mode 100644 src/@ionic-native/plugins/z-bar/readme.md create mode 100644 src/@ionic-native/plugins/zip/readme.md diff --git a/scripts/docs/dgeni-readmes-config.js b/scripts/docs/dgeni-readmes-config.js index cdeb1d5bb..f5099dbcd 100644 --- a/scripts/docs/dgeni-readmes-config.js +++ b/scripts/docs/dgeni-readmes-config.js @@ -177,7 +177,7 @@ module.exports = function(currentVersion) { templateFinder.templatePatterns = [ '${ doc.template }', '${ doc.docType }.template.md', - 'common.template.html' + 'readme.template.md' ]; }); diff --git a/scripts/docs/templates/readme.template.md b/scripts/docs/templates/readme.template.md new file mode 100644 index 000000000..3b79221da --- /dev/null +++ b/scripts/docs/templates/readme.template.md @@ -0,0 +1,54 @@ +<@- block body @> +<@- block content @> +<@- block header @> + + Improve this doc + + +# <$ doc.name $> + +<@ endblock -@> + +<@- if doc.beta == true @> +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+<@ endif -@> + +<@- for prop in doc.decorators[0].argumentInfo @> +``` +$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif @> +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>) + +Cordova Repo: [<$ prop.repo $>](<$ prop.repo $>) + + +<@- block description @> +<$ doc.description $> +<@ endblock -@> + +<@- if doc.directiveInfo @> +## <$ doc.directiveInfo.type $> +### <$ doc.directiveInfo.properties[0].name $>: `<$ doc.directiveInfo.properties[0].values $>` +<@ endif -@> + +<@- if prop.platforms @> + +## Supported platforms +<@ block platforms @> +<@ for platform in prop.platforms -@> +- <$ platform $> +<@ endfor @> +<@ endblock -@> + +<@ endif -@> + +<@ endfor -@> + +<@ endblock -@> + +<@ endblock -@> diff --git a/src/@ionic-native/plugins/3dtouch/readme.md b/src/@ionic-native/plugins/3dtouch/readme.md new file mode 100644 index 000000000..af32ac6b3 --- /dev/null +++ b/src/@ionic-native/plugins/3dtouch/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# 3DTouch + + +``` +$ ionic plugin add cordova-plugin-3dtouch +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/3dtouch/) + +Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-3dtouch](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch) + + + + + +## Supported platforms + +- iOS + + + + + diff --git a/src/@ionic-native/plugins/actionsheet/readme.md b/src/@ionic-native/plugins/actionsheet/readme.md new file mode 100644 index 000000000..d50931c6d --- /dev/null +++ b/src/@ionic-native/plugins/actionsheet/readme.md @@ -0,0 +1,32 @@ + + + Improve this doc + + +# Action Sheet + + +``` +$ ionic plugin add cordova-plugin-actionsheet +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/actionsheet/) + +Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-actionsheet](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet) + + +The ActionSheet plugin shows a native list of options the user can choose from. + +Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see the [ActionSheet plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet). + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/admob/readme.md b/src/@ionic-native/plugins/admob/readme.md new file mode 100644 index 000000000..523a76b3b --- /dev/null +++ b/src/@ionic-native/plugins/admob/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# AdMob + + +``` +$ ionic plugin add cordova-plugin-admobpro +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/admob/) + +Cordova Repo: [https://github.com/floatinghotpot/cordova-admob-pro](https://github.com/floatinghotpot/cordova-admob-pro) + + +Plugin for Google Ads, including AdMob / DFP (doubleclick for publisher) and mediations to other Ad networks. + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/android-fingerprint-auth/readme.md b/src/@ionic-native/plugins/android-fingerprint-auth/readme.md new file mode 100644 index 000000000..dbaca69de --- /dev/null +++ b/src/@ionic-native/plugins/android-fingerprint-auth/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Android Fingerprint Auth + + +``` +$ ionic plugin add cordova-plugin-android-fingerprint-auth +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/android-fingerprint-auth/) + +Cordova Repo: [https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth](https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth) + + +This plugin will open a native dialog fragment prompting the user to authenticate using their fingerprint. If the device has a secure lockscreen (pattern, PIN, or password), the user may opt to authenticate using that method as a backup. + + + diff --git a/src/@ionic-native/plugins/appavailability/readme.md b/src/@ionic-native/plugins/appavailability/readme.md new file mode 100644 index 000000000..4803fb061 --- /dev/null +++ b/src/@ionic-native/plugins/appavailability/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# App Availability + + +``` +$ ionic plugin add cordova-plugin-appavailability +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/appavailability/) + +Cordova Repo: [https://github.com/ohh2ahh/AppAvailability](https://github.com/ohh2ahh/AppAvailability) + + +This plugin allows you to check if an app is installed on the user's device. It requires an URI Scheme (e.g. twitter://) on iOS or a Package Name (e.g com.twitter.android) on Android. + +Requires Cordova plugin: cordova-plugin-appavailability. For more info, please see the [AppAvailability plugin docs](https://github.com/ohh2ahh/AppAvailability). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/apprate/readme.md b/src/@ionic-native/plugins/apprate/readme.md new file mode 100644 index 000000000..23c25c093 --- /dev/null +++ b/src/@ionic-native/plugins/apprate/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# App Rate + + +``` +$ ionic plugin add cordova-plugin-apprate +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/apprate/) + +Cordova Repo: [https://github.com/pushandplay/cordova-plugin-apprate](https://github.com/pushandplay/cordova-plugin-apprate) + + +The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never. + +Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [AppRate plugin docs](https://github.com/pushandplay/cordova-plugin-apprate). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/appversion/readme.md b/src/@ionic-native/plugins/appversion/readme.md new file mode 100644 index 000000000..b4315e7bf --- /dev/null +++ b/src/@ionic-native/plugins/appversion/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# App Version + + +``` +$ ionic plugin add cordova-plugin-app-version +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/appversion/) + +Cordova Repo: [https://github.com/whiteoctober/cordova-plugin-app-version](https://github.com/whiteoctober/cordova-plugin-app-version) + + +Reads the version of your app from the target build settings. + +Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see the [Cordova App Version docs](https://github.com/whiteoctober/cordova-plugin-app-version). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/background-geolocation/readme.md b/src/@ionic-native/plugins/background-geolocation/readme.md new file mode 100644 index 000000000..82b426ee3 --- /dev/null +++ b/src/@ionic-native/plugins/background-geolocation/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# BackgroundGeolocation + + +``` +$ ionic plugin add cordova-plugin-mauron85-background-geolocation +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/background-geolocation/) + +Cordova Repo: [https://github.com/mauron85/cordova-plugin-background-geolocation](https://github.com/mauron85/cordova-plugin-background-geolocation) + + +This plugin provides foreground and background geolocation with battery-saving "circular region monitoring" and "stop detection". For +more detail, please see https://github.com/mauron85/cordova-plugin-background-geolocation + + +## Supported platforms + +- iOS +- Android +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/backgroundmode/readme.md b/src/@ionic-native/plugins/backgroundmode/readme.md new file mode 100644 index 000000000..615b06d46 --- /dev/null +++ b/src/@ionic-native/plugins/backgroundmode/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# Background Mode + + +``` +$ ionic plugin add cordova-plugin-background-mode +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/backgroundmode/) + +Cordova Repo: [https://github.com/katzer/cordova-plugin-background-mode](https://github.com/katzer/cordova-plugin-background-mode) + + +Cordova plugin to prevent the app from going to sleep while in background. +Requires Cordova plugin: cordova-plugin-background-mode. For more info about plugin, vist: https://github.com/katzer/cordova-plugin-background-mode + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/backlight/readme.md b/src/@ionic-native/plugins/backlight/readme.md new file mode 100644 index 000000000..da66bcda2 --- /dev/null +++ b/src/@ionic-native/plugins/backlight/readme.md @@ -0,0 +1,34 @@ + + + Improve this doc + + +# Backlight + + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic plugin add cordova-plugin-backlight +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/backlight/) + +Cordova Repo: [https://github.com/mebibou/cordova-plugin-backlight](https://github.com/mebibou/cordova-plugin-backlight) + + +This plugin adds turning on/off the device backlight. + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/badge/readme.md b/src/@ionic-native/plugins/badge/readme.md new file mode 100644 index 000000000..de96c3f33 --- /dev/null +++ b/src/@ionic-native/plugins/badge/readme.md @@ -0,0 +1,35 @@ + + + Improve this doc + + +# Badge + + +``` +$ ionic plugin add cordova-plugin-badge +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/badge/) + +Cordova Repo: [https://github.com/katzer/cordova-plugin-badge](https://github.com/katzer/cordova-plugin-badge) + + +The essential purpose of badge numbers is to enable an application to inform its users that it has something for them — for example, unread messages — when the application isn’t running in the foreground. + +Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge). + + +## Supported platforms + +- Android +- iOS +- Browser +- Windows +- Amazon FireOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/barcodescanner/readme.md b/src/@ionic-native/plugins/barcodescanner/readme.md new file mode 100644 index 000000000..47deebe1e --- /dev/null +++ b/src/@ionic-native/plugins/barcodescanner/readme.md @@ -0,0 +1,36 @@ + + + Improve this doc + + +# Barcode Scanner + + +``` +$ ionic plugin add phonegap-plugin-barcodescanner +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/barcodescanner/) + +Cordova Repo: [https://github.com/phonegap/phonegap-plugin-barcodescanner](https://github.com/phonegap/phonegap-plugin-barcodescanner) + + +The Barcode Scanner Plugin opens a camera view and automatically scans a barcode, returning the data back to you. + +Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please see the [BarcodeScanner plugin docs](https://github.com/phonegap/phonegap-plugin-barcodescanner). + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 +- Windows 10 +- Windows 8 +- BlackBerry 10 +- Browser + + + + + diff --git a/src/@ionic-native/plugins/base64togallery/readme.md b/src/@ionic-native/plugins/base64togallery/readme.md new file mode 100644 index 000000000..453a7f9c0 --- /dev/null +++ b/src/@ionic-native/plugins/base64togallery/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Base64 To Gallery + + +``` +$ ionic plugin add cordova-base64-to-gallery +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/base64togallery/) + +Cordova Repo: [https://github.com/Nexxa/cordova-base64-to-gallery](https://github.com/Nexxa/cordova-base64-to-gallery) + + +This plugin allows you to save base64 data as a png image into the device + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/batterystatus/readme.md b/src/@ionic-native/plugins/batterystatus/readme.md new file mode 100644 index 000000000..ad74bfa2d --- /dev/null +++ b/src/@ionic-native/plugins/batterystatus/readme.md @@ -0,0 +1,36 @@ + + + Improve this doc + + +# Battery Status + + +``` +$ ionic plugin add cordova-plugin-battery-status +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/batterystatus/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-battery-status](https://github.com/apache/cordova-plugin-battery-status) + + +Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status). + + +## Supported platforms + +- Amazon Fire OS +- iOS +- Android +- BlackBerry 10 +- Windows Phone 7 +- Windows Phone 8 +- Windows +- Firefox OS +- Browser + + + + + diff --git a/src/@ionic-native/plugins/ble/readme.md b/src/@ionic-native/plugins/ble/readme.md new file mode 100644 index 000000000..27837c3eb --- /dev/null +++ b/src/@ionic-native/plugins/ble/readme.md @@ -0,0 +1,41 @@ + + + Improve this doc + + +# BLE + + +``` +$ ionic plugin add cordova-plugin-ble-central +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/ble/) + +Cordova Repo: [https://github.com/don/cordova-plugin-ble-central](https://github.com/don/cordova-plugin-ble-central) + + +This plugin enables communication between a phone and Bluetooth Low Energy (BLE) peripherals. + +The plugin provides a simple JavaScript API for iOS and Android. + +- Scan for peripherals +- Connect to a peripheral +- Read the value of a characteristic +- Write new value to a characteristic +- Get notified when characteristic's value changes + +Advertising information is returned when scanning for peripherals. Service, characteristic, and property info is returned when connecting to a peripheral. All access is via service and characteristic UUIDs. The plugin manages handles internally. + +Simultaneous connections to multiple peripherals are supported. + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/bluetoothserial/readme.md b/src/@ionic-native/plugins/bluetoothserial/readme.md new file mode 100644 index 000000000..7f367c0d8 --- /dev/null +++ b/src/@ionic-native/plugins/bluetoothserial/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# Bluetooth Serial + + +``` +$ ionic plugin add cordova-plugin-bluetooth-serial +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/bluetoothserial/) + +Cordova Repo: [https://github.com/don/BluetoothSerial](https://github.com/don/BluetoothSerial) + + +This plugin enables serial communication over Bluetooth. It was written for communicating between Android or iOS and an Arduino. + + +## Supported platforms + +- Android +- iOS +- Windows Phone +- Browser + + + + + diff --git a/src/@ionic-native/plugins/brightness/readme.md b/src/@ionic-native/plugins/brightness/readme.md new file mode 100644 index 000000000..d92ed7f21 --- /dev/null +++ b/src/@ionic-native/plugins/brightness/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# Brightness + + +``` +$ ionic plugin add cordova-plugin-brightness +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/brightness/) + +Cordova Repo: [https://github.com/mgcrea/cordova-plugin-brightness](https://github.com/mgcrea/cordova-plugin-brightness) + + +The Brightness plugin let you control the display brightness of your device. + +Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/broadcaster/readme.md b/src/@ionic-native/plugins/broadcaster/readme.md new file mode 100644 index 000000000..e93574326 --- /dev/null +++ b/src/@ionic-native/plugins/broadcaster/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# Broadcaster + + +``` +$ ionic plugin add cordova-plugin-broadcaster +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/broadcaster/) + +Cordova Repo: [https://github.com/bsorrentino/cordova-broadcaster](https://github.com/bsorrentino/cordova-broadcaster) + + +This plugin adds exchanging events between native code and your app. + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/calendar/readme.md b/src/@ionic-native/plugins/calendar/readme.md new file mode 100644 index 000000000..facb275ad --- /dev/null +++ b/src/@ionic-native/plugins/calendar/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# Calendar + + +``` +$ ionic plugin add cordova-plugin-calendar +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/calendar/) + +Cordova Repo: [https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin) + + +This plugin allows you to add events to the Calendar of the mobile device. + +Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see the [Calendar plugin docs](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/call-number/readme.md b/src/@ionic-native/plugins/call-number/readme.md new file mode 100644 index 000000000..2e7fa90a4 --- /dev/null +++ b/src/@ionic-native/plugins/call-number/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# CallNumber + + +``` +$ ionic plugin add call-number +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/call-number/) + +Cordova Repo: [https://github.com/Rohfosho/CordovaCallNumberPlugin](https://github.com/Rohfosho/CordovaCallNumberPlugin) + + +Call a number directly from your Cordova/Ionic application. + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/camera-preview/readme.md b/src/@ionic-native/plugins/camera-preview/readme.md new file mode 100644 index 000000000..95636f2e0 --- /dev/null +++ b/src/@ionic-native/plugins/camera-preview/readme.md @@ -0,0 +1,37 @@ + + + Improve this doc + + +# CameraPreview + + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic plugin add cordova-plugin-camera-preview +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/camera-preview/) + +Cordova Repo: [https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview) + + +Showing camera preview in HTML + +For more info, please see the [Cordova Camera Preview Plugin Docs](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/camera/readme.md b/src/@ionic-native/plugins/camera/readme.md new file mode 100644 index 000000000..ac000af6e --- /dev/null +++ b/src/@ionic-native/plugins/camera/readme.md @@ -0,0 +1,38 @@ + + + Improve this doc + + +# Camera + + +``` +$ ionic plugin add cordova-plugin-camera +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/camera/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-camera](https://github.com/apache/cordova-plugin-camera) + + +Take a photo or capture video. + +Requires ionic-native and the Cordova plugin: `cordova-plugin-camera`. For more info, please see the [Cordova Camera Plugin Docs](https://github.com/apache/cordova-plugin-camera). + + +## Supported platforms + +- Android +- BlackBerry +- Browser +- Firefox +- FireOS +- iOS +- Windows +- Windows Phone 8 +- Ubuntu + + + + + diff --git a/src/@ionic-native/plugins/card-io/readme.md b/src/@ionic-native/plugins/card-io/readme.md new file mode 100644 index 000000000..2cd6c492d --- /dev/null +++ b/src/@ionic-native/plugins/card-io/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# CardIO + + +``` +$ ionic plugin add card.io.cordova.mobilesdk +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/card-io/) + +Cordova Repo: [https://github.com/card-io/card.io-Cordova-Plugin](https://github.com/card-io/card.io-Cordova-Plugin) + + + + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/clipboard/readme.md b/src/@ionic-native/plugins/clipboard/readme.md new file mode 100644 index 000000000..f56570ed4 --- /dev/null +++ b/src/@ionic-native/plugins/clipboard/readme.md @@ -0,0 +1,39 @@ + + + Improve this doc + + +# Clipboard + + +``` +$ ionic plugin add https://github.com/VersoSolutions/CordovaClipboard.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/clipboard/) + +Cordova Repo: [https://github.com/VersoSolutions/CordovaClipboard](https://github.com/VersoSolutions/CordovaClipboard) + + +Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8. + +Requires Cordova plugin: https://github.com/VersoSolutions/CordovaClipboard +For more info, please see the [Clipboard plugin docs](https://github.com/VersoSolutions/CordovaClipboard.git). + + +## Supported platforms + +- Amazon Fire OS +- iOS +- Android +- BlackBerry 10 +- Windows Phone 7 +- Windows Phone 8 +- Windows +- Firefox OS +- Browser + + + + + diff --git a/src/@ionic-native/plugins/code-push/readme.md b/src/@ionic-native/plugins/code-push/readme.md new file mode 100644 index 000000000..f0552167f --- /dev/null +++ b/src/@ionic-native/plugins/code-push/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# CodePush + + +``` +$ ionic plugin add cordova-plugin-code-push +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/code-push/) + +Cordova Repo: [https://github.com/Microsoft/cordova-plugin-code-push](https://github.com/Microsoft/cordova-plugin-code-push) + + +CodePush plugin for Cordova by Microsoft that supports iOS and Android. + +For more info, please see https://github.com/ksachdeva/ionic2-code-push-example + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/contacts/readme.md b/src/@ionic-native/plugins/contacts/readme.md new file mode 100644 index 000000000..cd11da386 --- /dev/null +++ b/src/@ionic-native/plugins/contacts/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Contacts + + +``` +$ ionic plugin add cordova-plugin-contacts +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/contacts/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-contacts](https://github.com/apache/cordova-plugin-contacts) + + +Access and manage Contacts on the device. + + + diff --git a/src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html b/src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html new file mode 100644 index 000000000..fea8137c2 --- /dev/null +++ b/src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html @@ -0,0 +1,366 @@ + +
  • + 3DTouch +
    • +
  • + Action Sheet +
    • +
  • + AdMob +
    • +
  • + Android Fingerprint Auth +
    • +
  • + App Availability +
    • +
  • + App Rate +
    • +
  • + App Version +
    • +
  • + Background Mode +
    • +
  • + BackgroundGeolocation +
    • +
  • + Badge +
    • +
  • + Barcode Scanner +
    • +
  • + Base64 To Gallery +
    • +
  • + Battery Status +
    • +
  • + BLE +
    • +
  • + Bluetooth Serial +
    • +
  • + Brightness +
    • +
  • + Broadcaster +
    • +
  • + Calendar +
    • +
  • + CallNumber +
    • +
  • + Camera +
    • +
  • + CardIO +
    • +
  • + Clipboard +
    • +
  • + CodePush +
    • +
  • + Contacts +
    • +
  • + Crop +
    • +
  • + Date Picker +
    • +
  • + DB Meter +
    • +
  • + Device +
    • +
  • + Device Motion +
    • +
  • + Device Orientation +
    • +
  • + DeviceAccounts +
    • +
  • + DeviceFeedback +
    • +
  • + Diagnostic +
    • +
  • + Dialogs +
    • +
  • + EstimoteBeacons +
    • +
  • + Facebook +
    • +
  • + File +
    • +
  • + FileChooser +
    • +
  • + FileOpener +
    • +
  • + FilePath +
    • +
  • + Firebase +
    • +
  • + Flashlight +
    • +
  • + Geofence +
    • +
  • + Geolocation +
    • +
  • + Globalization +
    • +
  • + Google Analytics +
    • +
  • + Google Maps +
    • +
  • + Google Plus +
    • +
  • + HeaderColor +
    • +
  • + HTTP +
    • +
  • + Httpd +
    • +
  • + IBeacon +
    • +
  • + Image Picker +
    • +
  • + ImageResizer +
    • +
  • + InAppBrowser +
    • +
  • + InAppPurchase +
    • +
  • + Insomnia +
    • +
  • + Instagram +
    • +
  • + Ionic Deeplinks +
    • +
  • + IsDebug +
    • +
  • + Keyboard +
    • +
  • + Launch Navigator +
    • +
  • + LaunchReview +
    • +
  • + Local Notifications +
    • +
  • + LocationAccuracy +
    • +
  • + Market +
    • +
  • + Media Capture +
    • +
  • + MediaPlugin +
    • +
  • + Mixpanel +
    • +
  • + MusicControls +
    • +
  • + NativeAudio +
    • +
  • + NativePageTransitions +
    • +
  • + NativeStorage +
    • +
  • + Network +
    • +
  • + NFC +
    • +
  • + OneSignal +
    • +
  • + PayPal +
    • +
  • + Photo Viewer +
    • +
  • + Pin Dialog +
    • +
  • + PowerManagement +
    • +
  • + Printer +
    • +
  • + Push +
    • +
  • + SafariViewController +
    • +
  • + Screen Orientation +
    • +
  • + Screenshot +
    • +
  • + Secure Storage +
    • +
  • + Serial +
    • +
  • + Shake +
    • +
  • + Sim +
    • +
  • + SMS +
    • +
  • + Social Sharing +
    • + +
  • + Splashscreen +
    • +
  • + SQLite +
    • +
  • + Status Bar +
    • +
  • + Stepcounter +
    • +
  • + StreamingMedia +
    • +
  • + TextToSpeech +
    • +
  • + ThemeableBrowser +
    • +
  • + Toast +
    • +
  • + TouchID +
    • +
  • + Transfer +
    • +
  • + Twitter Connect +
    • +
  • + Vibration +
    • +
  • + VideoEditor +
    • +
  • + VideoPlayer +
    • +
  • + WebIntent +
    • +
  • + YoutubeVideoPlayer +
    • +
  • + ZBar +
    • +
  • + Zip +
    • + + +
  • + Backlight β +
    • +
  • + CameraPreview β +
    • +
  • + Email Composer β +
    • +
  • + FingerprintAIO β +
    • +
  • + Hotspot β +
    • +
  • + NativeGeocoder β +
    • +
  • + NavigationBar β +
    • +
  • + Pinterest β +
    • +
  • + Rollbar β +
    • +
  • + SpeechRecognition β +
    • +
  • + Stripe β +
    • diff --git a/src/@ionic-native/plugins/crop/readme.md b/src/@ionic-native/plugins/crop/readme.md new file mode 100644 index 000000000..4d1002f57 --- /dev/null +++ b/src/@ionic-native/plugins/crop/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Crop + + +``` +$ ionic plugin add cordova-plugin-crop +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/crop/) + +Cordova Repo: [https://github.com/jeduan/cordova-plugin-crop](https://github.com/jeduan/cordova-plugin-crop) + + +Crops images + + + diff --git a/src/@ionic-native/plugins/datepicker/readme.md b/src/@ionic-native/plugins/datepicker/readme.md new file mode 100644 index 000000000..9511885de --- /dev/null +++ b/src/@ionic-native/plugins/datepicker/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Date Picker + + +``` +$ ionic plugin add cordova-plugin-datepicker +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/datepicker/) + +Cordova Repo: [https://github.com/VitaliiBlagodir/cordova-plugin-datepicker](https://github.com/VitaliiBlagodir/cordova-plugin-datepicker) + + +The DatePicker plugin allows the user to fetch date or time using native dialogs. + + +## Supported platforms + +- Android +- iOS +- Windows + + + + + diff --git a/src/@ionic-native/plugins/dbmeter/readme.md b/src/@ionic-native/plugins/dbmeter/readme.md new file mode 100644 index 000000000..4f9f9f0d7 --- /dev/null +++ b/src/@ionic-native/plugins/dbmeter/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# DB Meter + + +``` +$ ionic plugin add cordova-plugin-dbmeter +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/dbmeter/) + +Cordova Repo: [https://github.com/akofman/cordova-plugin-dbmeter](https://github.com/akofman/cordova-plugin-dbmeter) + + +This plugin defines a global DBMeter object, which permits to get the decibel values from the microphone. + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/deeplinks/readme.md b/src/@ionic-native/plugins/deeplinks/readme.md new file mode 100644 index 000000000..bcf01e95b --- /dev/null +++ b/src/@ionic-native/plugins/deeplinks/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Ionic Deeplinks + + +``` +$ ionic plugin add ionic-plugin-deeplinks --variable URL_SCHEME=myapp --variable DEEPLINK_SCHEME=https --variable DEEPLINK_HOST=example.com --variable ANDROID_PATH_PREFIX=/ +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/deeplinks/) + +Cordova Repo: [https://github.com/driftyco/ionic-plugin-deeplinks](https://github.com/driftyco/ionic-plugin-deeplinks) + + +This plugin handles deeplinks on iOS and Android for both custom URL scheme links +and Universal App Links. + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/device-feedback/readme.md b/src/@ionic-native/plugins/device-feedback/readme.md new file mode 100644 index 000000000..d29ff8da0 --- /dev/null +++ b/src/@ionic-native/plugins/device-feedback/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# DeviceFeedback + + +``` +$ ionic plugin add cordova-plugin-velda-devicefeedback +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/device-feedback/) + +Cordova Repo: [https://github.com/VVelda/device-feedback](https://github.com/VVelda/device-feedback) + + +Plugin that lets you provide haptic or acoustic feedback on Android devices. + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/device/readme.md b/src/@ionic-native/plugins/device/readme.md new file mode 100644 index 000000000..6a3056575 --- /dev/null +++ b/src/@ionic-native/plugins/device/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Device + + +``` +$ ionic plugin add cordova-plugin-device +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/device/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-device](https://github.com/apache/cordova-plugin-device) + + +Access information about the underlying device and platform. + + + diff --git a/src/@ionic-native/plugins/deviceaccounts/readme.md b/src/@ionic-native/plugins/deviceaccounts/readme.md new file mode 100644 index 000000000..7d876652a --- /dev/null +++ b/src/@ionic-native/plugins/deviceaccounts/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# DeviceAccounts + + +``` +$ ionic plugin add https://github.com/loicknuchel/cordova-device-accounts.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/deviceaccounts/) + +Cordova Repo: [https://github.com/loicknuchel/cordova-device-accounts](https://github.com/loicknuchel/cordova-device-accounts) + + + + + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/devicemotion/readme.md b/src/@ionic-native/plugins/devicemotion/readme.md new file mode 100644 index 000000000..3bddcf970 --- /dev/null +++ b/src/@ionic-native/plugins/devicemotion/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Device Motion + + +``` +$ ionic plugin add cordova-plugin-device-motion +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/devicemotion/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-device-motion](https://github.com/apache/cordova-plugin-device-motion) + + +Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please see the [Device Motion docs](https://github.com/apache/cordova-plugin-device-motion). + + + diff --git a/src/@ionic-native/plugins/deviceorientation/readme.md b/src/@ionic-native/plugins/deviceorientation/readme.md new file mode 100644 index 000000000..8227e6835 --- /dev/null +++ b/src/@ionic-native/plugins/deviceorientation/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Device Orientation + + +``` +$ ionic plugin add cordova-plugin-device-orientation +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/deviceorientation/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-device-orientation](https://github.com/apache/cordova-plugin-device-orientation) + + +Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, please see the [Device Orientation docs](https://github.com/apache/cordova-plugin-device-orientation). + + + diff --git a/src/@ionic-native/plugins/diagnostic/readme.md b/src/@ionic-native/plugins/diagnostic/readme.md new file mode 100644 index 000000000..d3a929f26 --- /dev/null +++ b/src/@ionic-native/plugins/diagnostic/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Diagnostic + + +``` +$ ionic plugin add cordova.plugins.diagnostic +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/diagnostic/) + +Cordova Repo: [https://github.com/dpa99c/cordova-diagnostic-plugin](https://github.com/dpa99c/cordova-diagnostic-plugin) + + +Checks whether device hardware features are enabled or available to the app, e.g. camera, GPS, wifi + + + diff --git a/src/@ionic-native/plugins/dialogs/readme.md b/src/@ionic-native/plugins/dialogs/readme.md new file mode 100644 index 000000000..65c8b1273 --- /dev/null +++ b/src/@ionic-native/plugins/dialogs/readme.md @@ -0,0 +1,23 @@ + + + Improve this doc + + +# Dialogs + + +``` +$ ionic plugin add cordova-plugin-dialogs +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/dialogs/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-dialogs.git](https://github.com/apache/cordova-plugin-dialogs.git) + + +This plugin gives you ability to access and customize the device native dialogs. + +Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the [Dialogs plugin docs](https://github.com/apache/cordova-plugin-dialogs). + + + diff --git a/src/@ionic-native/plugins/emailcomposer/readme.md b/src/@ionic-native/plugins/emailcomposer/readme.md new file mode 100644 index 000000000..d067725df --- /dev/null +++ b/src/@ionic-native/plugins/emailcomposer/readme.md @@ -0,0 +1,38 @@ + + + Improve this doc + + +# Email Composer + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-email +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/emailcomposer/) + +Cordova Repo: [https://github.com/hypery2k/cordova-email-plugin](https://github.com/hypery2k/cordova-email-plugin) + + +Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the [Email Composer plugin docs](https://github.com/hypery2k/cordova-email-plugin). + +DISCLAIMER: This plugin is experiencing issues with the latest versions of Cordova. Use at your own risk. Functionality is not guaranteed. Please stay tuned for a more stable version. +A good alternative to this plugin is the social sharing plugin. + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/estimote-beacons/readme.md b/src/@ionic-native/plugins/estimote-beacons/readme.md new file mode 100644 index 000000000..740cdf86a --- /dev/null +++ b/src/@ionic-native/plugins/estimote-beacons/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# EstimoteBeacons + + +``` +$ ionic plugin add cordova-plugin-estimote +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/estimote-beacons/) + +Cordova Repo: [https://github.com/evothings/phonegap-estimotebeacons](https://github.com/evothings/phonegap-estimotebeacons) + + +This plugin enables communication between a phone and Estimote Beacons peripherals. + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/facebook/readme.md b/src/@ionic-native/plugins/facebook/readme.md new file mode 100644 index 000000000..fd4e3fe35 --- /dev/null +++ b/src/@ionic-native/plugins/facebook/readme.md @@ -0,0 +1,84 @@ + + + Improve this doc + + +# Facebook + + +``` +$ ionic plugin add cordova-plugin-facebook4 --variable APP_ID="123456789" --variable APP_NAME="myApplication" +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/facebook/) + +Cordova Repo: [https://github.com/jeduan/cordova-plugin-facebook4](https://github.com/jeduan/cordova-plugin-facebook4) + + +Use the Facebook Connect plugin to obtain access to the native FB application on iOS and Android. + +Requires Cordova plugin: `cordova-plugin-facebook4`. For more info, please see the [Facebook Connect](https://github.com/jeduan/cordova-plugin-facebook4). + +#### Installation + + To use the FB plugin, you first have to create a new Facebook App inside of the Facebook developer portal at [https://developers.facebook.com/apps](https://developers.facebook.com/apps). + +[![fb-getstarted-1](/img/docs/native/Facebook/1.png)](https://developers.facebook.com/apps/) + +Retrieve the `App ID` and `App Name`. + +[![fb-getstarted-2](/img/docs/native/Facebook/2.png)](https://developers.facebook.com/apps/) + +Then type in the following command in your Terminal, where APP_ID and APP_NAME are the values from the Facebook Developer portal. + +```bash + ionic plugin add cordova-plugin-facebook4 --save --variable APP_ID="123456789" --variable APP_NAME="myApplication" +``` + +After, you'll need to add the native platforms you'll be using to your app in the Facebook Developer portal under your app's Settings: + +[![fb-getstarted-3](/img/docs/native/Facebook/3.png)](https://developers.facebook.com/apps/) + +Click `'Add Platform'`. + +[![fb-getstarted-4](/img/docs/native/Facebook/4.png)](https://developers.facebook.com/apps/) + +At this point you'll need to open your project's [`config.xml`](https://cordova.apache.org/docs/en/latest/config_ref/index.html) file, found in the root directory of your project. + +Take note of the `id` for the next step: +``` + +``` + +You can also edit the `id` to whatever you'd like it to be. + +#### iOS Install +Under 'Bundle ID', add the `id` from your `config.xml` file: + +[![fb-getstarted-5](/img/docs/native/Facebook/5.png)](https://developers.facebook.com/apps/) + + +#### Android Install +Under 'Google Play Package Name', add the `id` from your `config.xml` file: + +[![fb-getstarted-6](/img/docs/native/Facebook/6.png)](https://developers.facebook.com/apps/) + + +And that's it! You can now make calls to Facebook using the plugin. + +## Events + +App events allow you to understand the makeup of users engaging with your app, measure the performance of your Facebook mobile app ads, and reach specific sets of your users with Facebook mobile app ads. + +- [iOS] [https://developers.facebook.com/docs/ios/app-events](https://developers.facebook.com/docs/ios/app-events) +- [Android] [https://developers.facebook.com/docs/android/app-events](https://developers.facebook.com/docs/android/app-events) +- [JS] Does not have an Events API, so the plugin functions are empty and will return an automatic success + +Activation events are automatically tracked for you in the plugin. + +Events are listed on the [insights page](https://www.facebook.com/insights/). + +For tracking events, see `logEvent` and `logPurchase`. + + + diff --git a/src/@ionic-native/plugins/file-chooser/readme.md b/src/@ionic-native/plugins/file-chooser/readme.md new file mode 100644 index 000000000..6f529348d --- /dev/null +++ b/src/@ionic-native/plugins/file-chooser/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# FileChooser + + +``` +$ ionic plugin add http://github.com/don/cordova-filechooser.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/file-chooser/) + +Cordova Repo: [https://github.com/don/cordova-filechooser](https://github.com/don/cordova-filechooser) + + +Opens the file picker on Android for the user to select a file, returns a file URI. + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/file-opener/readme.md b/src/@ionic-native/plugins/file-opener/readme.md new file mode 100644 index 000000000..ffe0aed01 --- /dev/null +++ b/src/@ionic-native/plugins/file-opener/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# FileOpener + + +``` +$ ionic plugin add cordova-plugin-file-opener2 +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/file-opener/) + +Cordova Repo: [https://github.com/pwlin/cordova-plugin-file-opener2](https://github.com/pwlin/cordova-plugin-file-opener2) + + +This plugin will open a file on your device file system with its default application. + + + diff --git a/src/@ionic-native/plugins/file/readme.md b/src/@ionic-native/plugins/file/readme.md new file mode 100644 index 000000000..e5c93e234 --- /dev/null +++ b/src/@ionic-native/plugins/file/readme.md @@ -0,0 +1,37 @@ + + + Improve this doc + + +# File + + +``` +$ ionic plugin add cordova-plugin-file +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/file/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-file](https://github.com/apache/cordova-plugin-file) + + +This plugin implements a File API allowing read/write access to files residing on the device. + +The File class implements static convenience functions to access files and directories. + +Example: +``` +import { File } from 'ionic-native'; + +declare var cordova: any; +const fs:string = cordova.file.dataDirectory; +File.checkDir(this.fs, 'mydir').then(_ => console.log('yay')).catch(err => console.log('boooh')); +``` + + This plugin is based on several specs, including : The HTML5 File API http://www.w3.org/TR/FileAPI/ + The (now-defunct) Directories and System extensions Latest: http://www.w3.org/TR/2012/WD-file-system-api-20120417/ + Although most of the plugin code was written when an earlier spec was current: http://www.w3.org/TR/2011/WD-file-system-api-20110419/ + It also implements the FileWriter spec : http://dev.w3.org/2009/dap/file-system/file-writer.html + + + diff --git a/src/@ionic-native/plugins/filepath/readme.md b/src/@ionic-native/plugins/filepath/readme.md new file mode 100644 index 000000000..f5333f52a --- /dev/null +++ b/src/@ionic-native/plugins/filepath/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# FilePath + + +``` +$ ionic plugin add cordova-plugin-filepath +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/filepath/) + +Cordova Repo: [https://github.com/hiddentao/cordova-plugin-filepath](https://github.com/hiddentao/cordova-plugin-filepath) + + +This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the aFileChooser library. + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/filetransfer/readme.md b/src/@ionic-native/plugins/filetransfer/readme.md new file mode 100644 index 000000000..b8aad85a4 --- /dev/null +++ b/src/@ionic-native/plugins/filetransfer/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Transfer + + +``` +$ ionic plugin add cordova-plugin-file-transfer +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/filetransfer/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-file-transfer](https://github.com/apache/cordova-plugin-file-transfer) + + +This plugin allows you to upload and download files. + + + diff --git a/src/@ionic-native/plugins/fingerprint-aio/readme.md b/src/@ionic-native/plugins/fingerprint-aio/readme.md new file mode 100644 index 000000000..579f924d2 --- /dev/null +++ b/src/@ionic-native/plugins/fingerprint-aio/readme.md @@ -0,0 +1,36 @@ + + + Improve this doc + + +# FingerprintAIO + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-fingerprint-aio +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/fingerprint-aio/) + +Cordova Repo: [https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio](https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio) + + +Use simple fingerprint authentication on Android and iOS. +Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plugin, vist: https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/firebase/readme.md b/src/@ionic-native/plugins/firebase/readme.md new file mode 100644 index 000000000..648a8b28b --- /dev/null +++ b/src/@ionic-native/plugins/firebase/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# Firebase + + +``` +$ ionic plugin add cordova-plugin-firebase +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/firebase/) + +Cordova Repo: [https://github.com/arnesson/cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) + + +This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/flashlight/readme.md b/src/@ionic-native/plugins/flashlight/readme.md new file mode 100644 index 000000000..3d3c62b75 --- /dev/null +++ b/src/@ionic-native/plugins/flashlight/readme.md @@ -0,0 +1,23 @@ + + + Improve this doc + + +# Flashlight + + +``` +$ ionic plugin add cordova-plugin-flashlight +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/flashlight/) + +Cordova Repo: [https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin.git](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin.git) + + +This plugin allows you to switch the flashlight / torch of the device on and off. + +Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see the [Flashlight plugin docs](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin). + + + diff --git a/src/@ionic-native/plugins/geofence/readme.md b/src/@ionic-native/plugins/geofence/readme.md new file mode 100644 index 000000000..b6e2f7655 --- /dev/null +++ b/src/@ionic-native/plugins/geofence/readme.md @@ -0,0 +1,32 @@ + + + Improve this doc + + +# Geofence + + +``` +$ ionic plugin add cordova-plugin-geofence +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/geofence/) + +Cordova Repo: [https://github.com/cowbell/cordova-plugin-geofence/](https://github.com/cowbell/cordova-plugin-geofence/) + + +Monitors circular geofences around latitude/longitude coordinates, and sends a notification to the user when the boundary of a geofence is crossed. Notifications can be sent when the user enters and/or exits a geofence. +Geofences persist after device reboot. Geofences will be monitored even when the app is not running. + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 +- Windows Phone + + + + + diff --git a/src/@ionic-native/plugins/geolocation/readme.md b/src/@ionic-native/plugins/geolocation/readme.md new file mode 100644 index 000000000..4cffa4551 --- /dev/null +++ b/src/@ionic-native/plugins/geolocation/readme.md @@ -0,0 +1,23 @@ + + + Improve this doc + + +# Geolocation + + +``` +$ ionic plugin add cordova-plugin-geolocation +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/geolocation/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-geolocation](https://github.com/apache/cordova-plugin-geolocation) + + +This plugin provides information about the device's location, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. + + This API is based on the W3C Geolocation API Specification, and only executes on devices that don't already provide an implementation. + + + diff --git a/src/@ionic-native/plugins/globalization/readme.md b/src/@ionic-native/plugins/globalization/readme.md new file mode 100644 index 000000000..9d828ef13 --- /dev/null +++ b/src/@ionic-native/plugins/globalization/readme.md @@ -0,0 +1,35 @@ + + + Improve this doc + + +# Globalization + + +``` +$ ionic plugin add cordova-plugin-globalization +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/globalization/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-globalization](https://github.com/apache/cordova-plugin-globalization) + + + + + +## Supported platforms + +- Amazon Fire OS +- Android +- BlackBerry 10 +- Firefox OS +- iOS +- Windows Phone 8 +- Widnows +- Browser + + + + + diff --git a/src/@ionic-native/plugins/google-plus/readme.md b/src/@ionic-native/plugins/google-plus/readme.md new file mode 100644 index 000000000..29626cce3 --- /dev/null +++ b/src/@ionic-native/plugins/google-plus/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Google Plus + + +``` +$ ionic plugin add cordova-plugin-googleplus --variable REVERSED_CLIENT_ID=myreversedclientid +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/google-plus/) + +Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) + + + + + +## Supported platforms + +- Web +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/googleanalytics/readme.md b/src/@ionic-native/plugins/googleanalytics/readme.md new file mode 100644 index 000000000..ceee5c4a4 --- /dev/null +++ b/src/@ionic-native/plugins/googleanalytics/readme.md @@ -0,0 +1,34 @@ + + + Improve this doc + + +# Google Analytics + + +``` +$ ionic plugin add cordova-plugin-google-analytics +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/googleanalytics/) + +Cordova Repo: [https://github.com/danwilson/google-analytics-plugin](https://github.com/danwilson/google-analytics-plugin) + + +This plugin connects to Google's native Universal Analytics SDK +Prerequisites: +- A Cordova 3.0+ project for iOS and/or Android +- A Mobile App property through the Google Analytics Admin Console +- (Android) Google Play Services SDK installed via [Android SDK Manager](https://developer.android.com/sdk/installing/adding-packages.html) + + +## Supported platforms + +- Android +- iOS +- Browser + + + + + diff --git a/src/@ionic-native/plugins/googlemap/readme.md b/src/@ionic-native/plugins/googlemap/readme.md new file mode 100644 index 000000000..89f83ffa5 --- /dev/null +++ b/src/@ionic-native/plugins/googlemap/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Google Maps + + +``` +$ ionic plugin add cordova-plugin-googlemaps --variable API_KEY_FOR_ANDROID="YOUR_ANDROID_API_KEY_IS_HERE" --variable API_KEY_FOR_IOS="YOUR_IOS_API_KEY_IS_HERE" +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/googlemap/) + +Cordova Repo: [https://github.com/mapsplugin/cordova-plugin-googlemaps](https://github.com/mapsplugin/cordova-plugin-googlemaps) + + +This plugin uses the native Google Maps SDK + + + diff --git a/src/@ionic-native/plugins/headercolor/readme.md b/src/@ionic-native/plugins/headercolor/readme.md new file mode 100644 index 000000000..d65a042b4 --- /dev/null +++ b/src/@ionic-native/plugins/headercolor/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# HeaderColor + + +``` +$ ionic plugin add cordova-plugin-headercolor +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/headercolor/) + +Cordova Repo: [https://github.com/tomloprod/cordova-plugin-headercolor](https://github.com/tomloprod/cordova-plugin-headercolor) + + +Cordova plugin to change color of header in multitask view + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/hotspot/readme.md b/src/@ionic-native/plugins/hotspot/readme.md new file mode 100644 index 000000000..4abf6df46 --- /dev/null +++ b/src/@ionic-native/plugins/hotspot/readme.md @@ -0,0 +1,34 @@ + + + Improve this doc + + +# Hotspot + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-hotspot +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/hotspot/) + +Cordova Repo: [https://github.com/hypery2k/cordova-hotspot-plugin](https://github.com/hypery2k/cordova-hotspot-plugin) + + + + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/http/readme.md b/src/@ionic-native/plugins/http/readme.md new file mode 100644 index 000000000..7b7d90bcf --- /dev/null +++ b/src/@ionic-native/plugins/http/readme.md @@ -0,0 +1,33 @@ + + + Improve this doc + + +# HTTP + + +``` +$ ionic plugin add cordova-plugin-http +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/http/) + +Cordova Repo: [https://github.com/wymsee/cordova-HTTP](https://github.com/wymsee/cordova-HTTP) + + +Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. + +Advantages over Javascript requests: +- Background threading - all requests are done in a background thread +- SSL Pinning + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/httpd/readme.md b/src/@ionic-native/plugins/httpd/readme.md new file mode 100644 index 000000000..fad975e31 --- /dev/null +++ b/src/@ionic-native/plugins/httpd/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# Httpd + + +``` +$ ionic plugin add https://github.com/floatinghotpot/cordova-httpd.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/httpd/) + +Cordova Repo: [https://github.com/floatinghotpot/cordova-httpd](https://github.com/floatinghotpot/cordova-httpd) + + +Embedded httpd for Cordova apps. Light weight HTTP server. + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/ibeacon/readme.md b/src/@ionic-native/plugins/ibeacon/readme.md new file mode 100644 index 000000000..51e4487d4 --- /dev/null +++ b/src/@ionic-native/plugins/ibeacon/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# IBeacon + + +``` +$ ionic plugin add cordova-plugin-ibeacon +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/ibeacon/) + +Cordova Repo: [https://github.com/petermetz/cordova-plugin-ibeacon](https://github.com/petermetz/cordova-plugin-ibeacon) + + +This plugin provides functions for working with iBeacons. + + The plugin's API closely mimics the one exposed through the [CLLocationManager](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html) introduced in iOS 7. + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/imagepicker/readme.md b/src/@ionic-native/plugins/imagepicker/readme.md new file mode 100644 index 000000000..d9e8eb150 --- /dev/null +++ b/src/@ionic-native/plugins/imagepicker/readme.md @@ -0,0 +1,24 @@ + + + Improve this doc + + +# Image Picker + + +``` +$ ionic plugin add https://github.com/Telerik-Verified-Plugins/ImagePicker +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/imagepicker/) + +Cordova Repo: [https://github.com/Telerik-Verified-Plugins/ImagePicker](https://github.com/Telerik-Verified-Plugins/ImagePicker) + + +Cordova Plugin For Multiple Image Selection + +Requires Cordova plugin: `cordova-plugin-image-picker`. +For more info, please see the https://github.com/wymsee/cordova-imagePicker + + + diff --git a/src/@ionic-native/plugins/imageresizer/readme.md b/src/@ionic-native/plugins/imageresizer/readme.md new file mode 100644 index 000000000..f4b65bce6 --- /dev/null +++ b/src/@ionic-native/plugins/imageresizer/readme.md @@ -0,0 +1,26 @@ + + + Improve this doc + + +# ImageResizer + + +``` +$ ionic plugin add https://github.com/protonet/cordova-plugin-image-resizer.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/imageresizer/) + +Cordova Repo: [https://github.com/protonet/cordova-plugin-image-resizer](https://github.com/protonet/cordova-plugin-image-resizer) + + +Cordova Plugin For Image Resize + +Requires plugin `info.protonet.imageresizer` - use the Ionic CLI and type in the following command: +`ionic plugin add https://github.com/protonet/cordova-plugin-image-resizer.git` + +For more info, please see the https://github.com/protonet/cordova-plugin-image-resizer + + + diff --git a/src/@ionic-native/plugins/inappbrowser/readme.md b/src/@ionic-native/plugins/inappbrowser/readme.md new file mode 100644 index 000000000..cc326ffd5 --- /dev/null +++ b/src/@ionic-native/plugins/inappbrowser/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# InAppBrowser + + +``` +$ ionic plugin add cordova-plugin-inappbrowser +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/inappbrowser/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-inappbrowser](https://github.com/apache/cordova-plugin-inappbrowser) + + +Launches in app Browser + + + diff --git a/src/@ionic-native/plugins/inapppurchase/readme.md b/src/@ionic-native/plugins/inapppurchase/readme.md new file mode 100644 index 000000000..6cc2b52cc --- /dev/null +++ b/src/@ionic-native/plugins/inapppurchase/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# InAppPurchase + + +``` +$ ionic plugin add cordova-plugin-inapppurchase +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/inapppurchase/) + +Cordova Repo: [https://github.com/AlexDisler/cordova-plugin-inapppurchase](https://github.com/AlexDisler/cordova-plugin-inapppurchase) + + +A lightweight Cordova plugin for in app purchases on iOS/Android. + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/insomnia/readme.md b/src/@ionic-native/plugins/insomnia/readme.md new file mode 100644 index 000000000..cac56e0a2 --- /dev/null +++ b/src/@ionic-native/plugins/insomnia/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Insomnia + + +``` +$ ionic plugin add https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/insomnia/) + +Cordova Repo: [https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin) + + +Prevent the screen of the mobile device from falling asleep. + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/instagram/readme.md b/src/@ionic-native/plugins/instagram/readme.md new file mode 100644 index 000000000..c1462bb7b --- /dev/null +++ b/src/@ionic-native/plugins/instagram/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Instagram + + +``` +$ ionic plugin add cordova-instagram-plugin +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/instagram/) + +Cordova Repo: [https://github.com/vstirbu/InstagramPlugin](https://github.com/vstirbu/InstagramPlugin) + + +Share a photo with the instagram app + + + diff --git a/src/@ionic-native/plugins/is-debug/readme.md b/src/@ionic-native/plugins/is-debug/readme.md new file mode 100644 index 000000000..31e11ba11 --- /dev/null +++ b/src/@ionic-native/plugins/is-debug/readme.md @@ -0,0 +1,22 @@ + + + Improve this doc + + +# IsDebug + + +``` +$ ionic plugin add cordova-plugin-is-debug +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/is-debug/) + +Cordova Repo: [https://github.com/mattlewis92/cordova-plugin-is-debug](https://github.com/mattlewis92/cordova-plugin-is-debug) + + +Detect if the app is running in debug mode or not. +Debug mode is when the app is built and installed locally via xcode / eclipse / the cordova cli etc, compared to release mode when the app was downloaded from the app / play store via an end user. + + + diff --git a/src/@ionic-native/plugins/keyboard/readme.md b/src/@ionic-native/plugins/keyboard/readme.md new file mode 100644 index 000000000..4b2ed6cbe --- /dev/null +++ b/src/@ionic-native/plugins/keyboard/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Keyboard + + +``` +$ ionic plugin add ionic-plugin-keyboard +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/keyboard/) + +Cordova Repo: [https://github.com/driftyco/ionic-plugin-keyboard](https://github.com/driftyco/ionic-plugin-keyboard) + + + + + + diff --git a/src/@ionic-native/plugins/launch-review/readme.md b/src/@ionic-native/plugins/launch-review/readme.md new file mode 100644 index 000000000..95b26dd79 --- /dev/null +++ b/src/@ionic-native/plugins/launch-review/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# LaunchReview + + +``` +$ ionic plugin add cordova-launch-review +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/launch-review/) + +Cordova Repo: [https://github.com/dpa99c/cordova-launch-review](https://github.com/dpa99c/cordova-launch-review) + + +This launches the native store app in order for the user to leave a review. +On Android, the plugin opens the the app's storepage in the Play Store where the user can leave a review by pressing the stars to give a rating. +On iOS, the plugin opens the app's storepage in the App Store and focuses the Review tab, where the user can leave a review by pressing "Write a review". + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/launchnavigator/readme.md b/src/@ionic-native/plugins/launchnavigator/readme.md new file mode 100644 index 000000000..9ad88c8a1 --- /dev/null +++ b/src/@ionic-native/plugins/launchnavigator/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Launch Navigator + + +``` +$ ionic plugin add uk.co.workingedge.phonegap.plugin.launchnavigator +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/launchnavigator/) + +Cordova Repo: [https://github.com/dpa99c/phonegap-launch-navigator.git](https://github.com/dpa99c/phonegap-launch-navigator.git) + + +Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For more info, please see the [LaunchNavigator plugin docs](https://github.com/dpa99c/phonegap-launch-navigator). + + + diff --git a/src/@ionic-native/plugins/localnotifications/readme.md b/src/@ionic-native/plugins/localnotifications/readme.md new file mode 100644 index 000000000..87d70f2d2 --- /dev/null +++ b/src/@ionic-native/plugins/localnotifications/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Local Notifications + + +``` +$ ionic plugin add de.appplant.cordova.plugin.local-notification +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/localnotifications/) + +Cordova Repo: [https://github.com/katzer/cordova-plugin-local-notifications](https://github.com/katzer/cordova-plugin-local-notifications) + + +This plugin allows you to display local notifications on the device + + + diff --git a/src/@ionic-native/plugins/location-accuracy/readme.md b/src/@ionic-native/plugins/location-accuracy/readme.md new file mode 100644 index 000000000..e371ec111 --- /dev/null +++ b/src/@ionic-native/plugins/location-accuracy/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# LocationAccuracy + + +``` +$ ionic plugin add cordova-plugin-request-location-accuracy +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/location-accuracy/) + +Cordova Repo: [https://github.com/dpa99c/cordova-plugin-request-location-accuracy](https://github.com/dpa99c/cordova-plugin-request-location-accuracy) + + +This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually. + + + diff --git a/src/@ionic-native/plugins/market/readme.md b/src/@ionic-native/plugins/market/readme.md new file mode 100644 index 000000000..b79b39293 --- /dev/null +++ b/src/@ionic-native/plugins/market/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Market + + +``` +$ ionic plugin add cordova-plugin-market +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/market/) + +Cordova Repo: [https://github.com/xmartlabs/cordova-plugin-market](https://github.com/xmartlabs/cordova-plugin-market) + + +Opens an app's page in the market place (Google Play, App Store) + + + diff --git a/src/@ionic-native/plugins/media-capture/readme.md b/src/@ionic-native/plugins/media-capture/readme.md new file mode 100644 index 000000000..0ceafbc96 --- /dev/null +++ b/src/@ionic-native/plugins/media-capture/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Media Capture + + +``` +$ ionic plugin add cordova-plugin-media-capture +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/media-capture/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-media-capture](https://github.com/apache/cordova-plugin-media-capture) + + + + + + diff --git a/src/@ionic-native/plugins/media/readme.md b/src/@ionic-native/plugins/media/readme.md new file mode 100644 index 000000000..abcc0e24f --- /dev/null +++ b/src/@ionic-native/plugins/media/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# MediaPlugin + + +``` +$ ionic plugin add cordova-plugin-media +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/media/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-media](https://github.com/apache/cordova-plugin-media) + + + + + + diff --git a/src/@ionic-native/plugins/mixpanel/readme.md b/src/@ionic-native/plugins/mixpanel/readme.md new file mode 100644 index 000000000..b10751bfc --- /dev/null +++ b/src/@ionic-native/plugins/mixpanel/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Mixpanel + + +``` +$ ionic plugin add cordova-plugin-mixpanel +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/mixpanel/) + +Cordova Repo: [https://github.com/samzilverberg/cordova-mixpanel-plugin](https://github.com/samzilverberg/cordova-mixpanel-plugin) + + +Cordova Plugin that wraps Mixpanel SDK for Android and iOS + + + diff --git a/src/@ionic-native/plugins/music-controls/readme.md b/src/@ionic-native/plugins/music-controls/readme.md new file mode 100644 index 000000000..594f7646b --- /dev/null +++ b/src/@ionic-native/plugins/music-controls/readme.md @@ -0,0 +1,23 @@ + + + Improve this doc + + +# MusicControls + + +``` +$ ionic plugin add cordova-plugin-music-controls +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/music-controls/) + +Cordova Repo: [https://github.com/homerours/cordova-music-controls-plugin](https://github.com/homerours/cordova-music-controls-plugin) + + +Music controls for Cordova applications. +Display a 'media' notification with play/pause, previous, next buttons, allowing the user to control the play. +Handle also headset event (plug, unplug, headset button). + + + diff --git a/src/@ionic-native/plugins/native-audio/readme.md b/src/@ionic-native/plugins/native-audio/readme.md new file mode 100644 index 000000000..ef6b194a4 --- /dev/null +++ b/src/@ionic-native/plugins/native-audio/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# NativeAudio + + +``` +$ ionic plugin add cordova-plugin-nativeaudio +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/native-audio/) + +Cordova Repo: [https://github.com/floatinghotpot/cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio) + + +Native Audio Playback + + + diff --git a/src/@ionic-native/plugins/native-geocoder/readme.md b/src/@ionic-native/plugins/native-geocoder/readme.md new file mode 100644 index 000000000..7c63f69ac --- /dev/null +++ b/src/@ionic-native/plugins/native-geocoder/readme.md @@ -0,0 +1,35 @@ + + + Improve this doc + + +# NativeGeocoder + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-nativegeocoder +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/native-geocoder/) + +Cordova Repo: [https://github.com/sebastianbaar/cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) + + +Cordova plugin for native forward and reverse geocoding + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/native-page-transitions/readme.md b/src/@ionic-native/plugins/native-page-transitions/readme.md new file mode 100644 index 000000000..83231a6d7 --- /dev/null +++ b/src/@ionic-native/plugins/native-page-transitions/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# NativePageTransitions + + +``` +$ ionic plugin add com.telerik.plugins.nativepagetransitions +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/native-page-transitions/) + +Cordova Repo: [https://github.com/Telerik-Verified-Plugins/NativePageTransitions](https://github.com/Telerik-Verified-Plugins/NativePageTransitions) + + +The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction. + + +## Supported platforms + +- iOS +- Android +- Windows Phone + + + + + diff --git a/src/@ionic-native/plugins/nativestorage/readme.md b/src/@ionic-native/plugins/nativestorage/readme.md new file mode 100644 index 000000000..2634f9c36 --- /dev/null +++ b/src/@ionic-native/plugins/nativestorage/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# NativeStorage + + +``` +$ ionic plugin add cordova-plugin-nativestorage +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/nativestorage/) + +Cordova Repo: [https://github.com/TheCocoaProject/cordova-plugin-nativestorage](https://github.com/TheCocoaProject/cordova-plugin-nativestorage) + + +Native storage of variables in Android and iOS + + + diff --git a/src/@ionic-native/plugins/navigationbar/readme.md b/src/@ionic-native/plugins/navigationbar/readme.md new file mode 100644 index 000000000..a5dd6f2c6 --- /dev/null +++ b/src/@ionic-native/plugins/navigationbar/readme.md @@ -0,0 +1,34 @@ + + + Improve this doc + + +# NavigationBar + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-navigationbar +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/navigationbar/) + +Cordova Repo: [https://github.com/cranberrygame/cordova-plugin-navigationbar](https://github.com/cranberrygame/cordova-plugin-navigationbar) + + +The NavigationBar plugin can you to hide and auto hide the android navigation bar. + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/network/readme.md b/src/@ionic-native/plugins/network/readme.md new file mode 100644 index 000000000..15b9a2156 --- /dev/null +++ b/src/@ionic-native/plugins/network/readme.md @@ -0,0 +1,36 @@ + + + Improve this doc + + +# Network + + +``` +$ ionic plugin add cordova-plugin-network-information +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/network/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-network-information](https://github.com/apache/cordova-plugin-network-information) + + +Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin docs](https://github.com/apache/cordova-plugin-network-information). + + +## Supported platforms + +- Amazon Fire OS +- iOS +- Android +- BlackBerry 10 +- Windows Phone 7 +- Windows Phone 8 +- Windows +- Firefox OS +- Browser + + + + + diff --git a/src/@ionic-native/plugins/nfc/readme.md b/src/@ionic-native/plugins/nfc/readme.md new file mode 100644 index 000000000..4fcb6e802 --- /dev/null +++ b/src/@ionic-native/plugins/nfc/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# NFC + + +``` +$ ionic plugin add phonegap-nfc +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/nfc/) + +Cordova Repo: [https://github.com/chariotsolutions/phonegap-nfc](https://github.com/chariotsolutions/phonegap-nfc) + + +The NFC plugin allows you to read and write NFC tags. You can also beam to, and receive from, other NFC enabled devices. + +Use to +- read data from NFC tags +- write data to NFC tags +- send data to other NFC enabled devices +- receive data from NFC devices + +This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems. + + + diff --git a/src/@ionic-native/plugins/onesignal/readme.md b/src/@ionic-native/plugins/onesignal/readme.md new file mode 100644 index 000000000..39a39a173 --- /dev/null +++ b/src/@ionic-native/plugins/onesignal/readme.md @@ -0,0 +1,34 @@ + + + Improve this doc + + +# OneSignal + + +``` +$ ionic plugin add onesignal-cordova-plugin +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/onesignal/) + +Cordova Repo: [https://github.com/OneSignal/OneSignal-Cordova-SDK](https://github.com/OneSignal/OneSignal-Cordova-SDK) + + +The OneSignal plugin is an client implementation for using the [OneSignal](https://onesignal.com/) Service. +OneSignal is a simple implementation for delivering push notifications. + +Requires Cordova plugin: `onesignal-cordova-plugin`. For more info, please see the [OneSignal Cordova Docs](https://documentation.onesignal.com/docs/phonegap-sdk-installation). + + +## Supported platforms + +- Android +- iOS +- Windows +- FireOS + + + + + diff --git a/src/@ionic-native/plugins/pay-pal/readme.md b/src/@ionic-native/plugins/pay-pal/readme.md new file mode 100644 index 000000000..032a12562 --- /dev/null +++ b/src/@ionic-native/plugins/pay-pal/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# PayPal + + +``` +$ ionic plugin add com.paypal.cordova.mobilesdk +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/pay-pal/) + +Cordova Repo: [https://github.com/paypal/PayPal-Cordova-Plugin](https://github.com/paypal/PayPal-Cordova-Plugin) + + +PayPal plugin for Cordova/Ionic Applications + + + diff --git a/src/@ionic-native/plugins/photo-viewer/readme.md b/src/@ionic-native/plugins/photo-viewer/readme.md new file mode 100644 index 000000000..2eed5ab8f --- /dev/null +++ b/src/@ionic-native/plugins/photo-viewer/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Photo Viewer + + +``` +$ ionic plugin add com-sarriaroman-photoviewer +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/photo-viewer/) + +Cordova Repo: [https://github.com/sarriaroman/photoviewer](https://github.com/sarriaroman/photoviewer) + + +This plugin can display your image in full screen with the ability to pan, zoom, and share the image. + + + diff --git a/src/@ionic-native/plugins/pin-dialog/readme.md b/src/@ionic-native/plugins/pin-dialog/readme.md new file mode 100644 index 000000000..b2f9ce52d --- /dev/null +++ b/src/@ionic-native/plugins/pin-dialog/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Pin Dialog + + +``` +$ ionic plugin add cordova-plugin-pin-dialog +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/pin-dialog/) + +Cordova Repo: [https://github.com/Paldom/PinDialog](https://github.com/Paldom/PinDialog) + + + + + + diff --git a/src/@ionic-native/plugins/pinterest/readme.md b/src/@ionic-native/plugins/pinterest/readme.md new file mode 100644 index 000000000..9e3b292af --- /dev/null +++ b/src/@ionic-native/plugins/pinterest/readme.md @@ -0,0 +1,35 @@ + + + Improve this doc + + +# Pinterest + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-pinterest --variable APP_ID=YOUR_APP_ID +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/pinterest/) + +Cordova Repo: [https://github.com/zyramedia/cordova-plugin-pinterest](https://github.com/zyramedia/cordova-plugin-pinterest) + + +Cordova plugin for Pinterest + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/power-management/readme.md b/src/@ionic-native/plugins/power-management/readme.md new file mode 100644 index 000000000..58bbde832 --- /dev/null +++ b/src/@ionic-native/plugins/power-management/readme.md @@ -0,0 +1,22 @@ + + + Improve this doc + + +# PowerManagement + + +``` +$ ionic plugin add cordova-plugin-powermanagement-orig +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/power-management/) + +Cordova Repo: [https://github.com/Viras-/cordova-plugin-powermanagement](https://github.com/Viras-/cordova-plugin-powermanagement) + + +The PowerManagement plugin offers access to the devices power-management functionality. +It should be used for applications which keep running for a long time without any user interaction. + + + diff --git a/src/@ionic-native/plugins/printer/readme.md b/src/@ionic-native/plugins/printer/readme.md new file mode 100644 index 000000000..7b8417d06 --- /dev/null +++ b/src/@ionic-native/plugins/printer/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# Printer + + +``` +$ ionic plugin add de.appplant.cordova.plugin.printer +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/printer/) + +Cordova Repo: [https://github.com/katzer/cordova-plugin-printer.git](https://github.com/katzer/cordova-plugin-printer.git) + + +Prints documents or HTML rendered content + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/push/readme.md b/src/@ionic-native/plugins/push/readme.md new file mode 100644 index 000000000..ad1aad6fb --- /dev/null +++ b/src/@ionic-native/plugins/push/readme.md @@ -0,0 +1,25 @@ + + + Improve this doc + + +# Push + + +``` +$ ionic plugin add phonegap-plugin-push --variable SENDER_ID=XXXXXXXXX +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/push/) + +Cordova Repo: [https://github.com/phonegap/phonegap-plugin-push](https://github.com/phonegap/phonegap-plugin-push) + + +Register and receive push notifications. + +Requires Cordova plugin: `phonegap-plugin-push`. For more info, please see the [Push plugin docs](https://github.com/phonegap/phonegap-plugin-push). + +For TypeScript users, see the [Push plugin docs about using TypeScript for custom notifications](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/TYPESCRIPT.md). + + + diff --git a/src/@ionic-native/plugins/rollbar/readme.md b/src/@ionic-native/plugins/rollbar/readme.md new file mode 100644 index 000000000..451f4b227 --- /dev/null +++ b/src/@ionic-native/plugins/rollbar/readme.md @@ -0,0 +1,35 @@ + + + Improve this doc + + +# Rollbar + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add resgrid-cordova-plugins-rollbar --variable ROLLBAR_ACCESS_TOKEN="YOUR_ROLLBAR_ACCEESS_TOKEN" --variable ROLLBAR_ENVIRONMENT="ROLLBAR_ENVIRONMENT" +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/rollbar/) + +Cordova Repo: [https://github.com/Resgrid/cordova-plugins-rollbar](https://github.com/Resgrid/cordova-plugins-rollbar) + + +This plugin adds Rollbar App monitoring to your application + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/safari-view-controller/readme.md b/src/@ionic-native/plugins/safari-view-controller/readme.md new file mode 100644 index 000000000..fb05efa35 --- /dev/null +++ b/src/@ionic-native/plugins/safari-view-controller/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# SafariViewController + + +``` +$ ionic plugin add cordova-plugin-safariviewcontroller +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/safari-view-controller/) + +Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller](https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller) + + + + + +## Supported platforms + +- iOS +- Android + + + + + diff --git a/src/@ionic-native/plugins/screen-orientation/readme.md b/src/@ionic-native/plugins/screen-orientation/readme.md new file mode 100644 index 000000000..c1d984632 --- /dev/null +++ b/src/@ionic-native/plugins/screen-orientation/readme.md @@ -0,0 +1,33 @@ + + + Improve this doc + + +# Screen Orientation + + +``` +$ ionic plugin add cordova-plugin-screen-orientation +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/screen-orientation/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-screen-orientation](https://github.com/apache/cordova-plugin-screen-orientation) + + +Cordova plugin to set/lock the screen orientation in a common way for iOS, Android, WP8 and Blackberry 10. +This plugin is based on an early version of Screen Orientation API so the api does not currently match the current spec. + +Requires Cordova plugin: `cordova-plugin-screen-orientation`. For more info, please see the [Screen Orientation plugin docs](https://github.com/apache/cordova-plugin-screen-orientation). + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/screenshot/readme.md b/src/@ionic-native/plugins/screenshot/readme.md new file mode 100644 index 000000000..816365d7c --- /dev/null +++ b/src/@ionic-native/plugins/screenshot/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Screenshot + + +``` +$ ionic plugin add https://github.com/gitawego/cordova-screenshot.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/screenshot/) + +Cordova Repo: [https://github.com/gitawego/cordova-screenshot.git](https://github.com/gitawego/cordova-screenshot.git) + + +Captures a screen shot + + + diff --git a/src/@ionic-native/plugins/securestorage/readme.md b/src/@ionic-native/plugins/securestorage/readme.md new file mode 100644 index 000000000..8283d2592 --- /dev/null +++ b/src/@ionic-native/plugins/securestorage/readme.md @@ -0,0 +1,33 @@ + + + Improve this doc + + +# Secure Storage + + +``` +$ ionic plugin add cordova-plugin-secure-storage +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/securestorage/) + +Cordova Repo: [https://github.com/Crypho/cordova-plugin-secure-storage](https://github.com/Crypho/cordova-plugin-secure-storage) + + +This plugin gets, sets and removes key,value pairs from a device's secure storage. + +Requires Cordova plugin: `cordova-plugin-secure-storage`. For more info, please see the [Cordova Secure Storage docs](https://github.com/Crypho/cordova-plugin-secure-storage). + + +## Supported platforms + +- Android +- iOS +- Windows Phone +- Browser + + + + + diff --git a/src/@ionic-native/plugins/serial/readme.md b/src/@ionic-native/plugins/serial/readme.md new file mode 100644 index 000000000..db51d368f --- /dev/null +++ b/src/@ionic-native/plugins/serial/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# Serial + + +``` +$ ionic plugin add cordovarduino +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/serial/) + +Cordova Repo: [https://github.com/xseignard/cordovarduino](https://github.com/xseignard/cordovarduino) + + +This plugin provides functions for working with Serial connections + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/shake/readme.md b/src/@ionic-native/plugins/shake/readme.md new file mode 100644 index 000000000..de84f750f --- /dev/null +++ b/src/@ionic-native/plugins/shake/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Shake + + +``` +$ ionic plugin add cordova-plugin-shake +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/shake/) + +Cordova Repo: [https://github.com/leecrossley/cordova-plugin-shake](https://github.com/leecrossley/cordova-plugin-shake) + + +Handles shake gesture + + + diff --git a/src/@ionic-native/plugins/sim/readme.md b/src/@ionic-native/plugins/sim/readme.md new file mode 100644 index 000000000..9fc8302da --- /dev/null +++ b/src/@ionic-native/plugins/sim/readme.md @@ -0,0 +1,32 @@ + + + Improve this doc + + +# Sim + + +``` +$ ionic plugin add cordova-plugin-sim +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/sim/) + +Cordova Repo: [https://github.com/pbakondy/cordova-plugin-sim](https://github.com/pbakondy/cordova-plugin-sim) + + +Gets info from the Sim card like the carrier name, mcc, mnc and country code and other system dependent info. + +Requires Cordova plugin: `cordova-plugin-sim`. For more info, please see the [Cordova Sim docs](https://github.com/pbakondy/cordova-plugin-sim). + + +## Supported platforms + +- Android +- iOS +- Windows Phone + + + + + diff --git a/src/@ionic-native/plugins/sms/readme.md b/src/@ionic-native/plugins/sms/readme.md new file mode 100644 index 000000000..7c5c75a8e --- /dev/null +++ b/src/@ionic-native/plugins/sms/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# SMS + + +``` +$ ionic plugin add cordova-sms-plugin +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/sms/) + +Cordova Repo: [https://github.com/cordova-sms/cordova-sms-plugin](https://github.com/cordova-sms/cordova-sms-plugin) + + +Requires Cordova plugin: cordova-plugin-sms. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin). + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/socialsharing/readme.md b/src/@ionic-native/plugins/socialsharing/readme.md new file mode 100644 index 000000000..15ebcf94d --- /dev/null +++ b/src/@ionic-native/plugins/socialsharing/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Social Sharing + + +``` +$ ionic plugin add cordova-plugin-x-socialsharing +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/socialsharing/) + +Cordova Repo: [https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin](https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin) + + +Share text, files, images, and links via social networks, sms, and email. + + +## Supported platforms + +- iOS +- Android +- Windows Phone + + + + + diff --git a/src/@ionic-native/plugins/speech-recognition/readme.md b/src/@ionic-native/plugins/speech-recognition/readme.md new file mode 100644 index 000000000..62805e28f --- /dev/null +++ b/src/@ionic-native/plugins/speech-recognition/readme.md @@ -0,0 +1,35 @@ + + + Improve this doc + + +# SpeechRecognition + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-speechrecognition +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/speech-recognition/) + +Cordova Repo: [https://github.com/pbakondy/cordova-plugin-speechrecognition](https://github.com/pbakondy/cordova-plugin-speechrecognition) + + +This plugin does speech recognition using cloud services + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/spinnerdialog/readme.md b/src/@ionic-native/plugins/spinnerdialog/readme.md new file mode 100644 index 000000000..98aa9667a --- /dev/null +++ b/src/@ionic-native/plugins/spinnerdialog/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# Spinner Dialog + + +``` +$ ionic plugin add cordova-plugin-spinner-dialog +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/spinnerdialog/) + +Cordova Repo: [https://github.com/Paldom/SpinnerDialog](https://github.com/Paldom/SpinnerDialog) + + + + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/splashscreen/readme.md b/src/@ionic-native/plugins/splashscreen/readme.md new file mode 100644 index 000000000..fc9e8deea --- /dev/null +++ b/src/@ionic-native/plugins/splashscreen/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Splashscreen + + +``` +$ ionic plugin add cordova-plugin-splashscreen +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/splashscreen/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-splashscreen](https://github.com/apache/cordova-plugin-splashscreen) + + +This plugin displays and hides a splash screen during application launch. The methods below allows showing and hiding the splashscreen after the app has loaded. + + + diff --git a/src/@ionic-native/plugins/sqlite/readme.md b/src/@ionic-native/plugins/sqlite/readme.md new file mode 100644 index 000000000..f74c8b779 --- /dev/null +++ b/src/@ionic-native/plugins/sqlite/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# SQLite + + +``` +$ ionic plugin add cordova-sqlite-storage +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/sqlite/) + +Cordova Repo: [https://github.com/litehelpers/Cordova-sqlite-storage](https://github.com/litehelpers/Cordova-sqlite-storage) + + +Access SQLite databases on the device. + + + diff --git a/src/@ionic-native/plugins/statusbar/readme.md b/src/@ionic-native/plugins/statusbar/readme.md new file mode 100644 index 000000000..348da1e8a --- /dev/null +++ b/src/@ionic-native/plugins/statusbar/readme.md @@ -0,0 +1,34 @@ + + + Improve this doc + + +# Status Bar + + +``` +$ ionic plugin add cordova-plugin-statusbar +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/statusbar/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-statusbar](https://github.com/apache/cordova-plugin-statusbar) + + +Manage the appearance of the native status bar. + +Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar). + + +## Supported platforms + +- iOS +- Android +- Windows Phone 8 +- Windows 8 +- Windows 10 + + + + + diff --git a/src/@ionic-native/plugins/stepcounter/readme.md b/src/@ionic-native/plugins/stepcounter/readme.md new file mode 100644 index 000000000..3cfee9ead --- /dev/null +++ b/src/@ionic-native/plugins/stepcounter/readme.md @@ -0,0 +1,32 @@ + + + Improve this doc + + +# Stepcounter + + +``` +$ ionic plugin add https://github.com/Slidee/cordova-plugin-stepcounter +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/stepcounter/) + +Cordova Repo: [https://github.com/Slidee/cordova-plugin-stepcounter](https://github.com/Slidee/cordova-plugin-stepcounter) + + +Cordova plugin for using device's stepcounter on Android (API > 19) + +Use to +- start and stop stepcounter service +- read device's stepcounter data + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/streaming-media/readme.md b/src/@ionic-native/plugins/streaming-media/readme.md new file mode 100644 index 000000000..308e28934 --- /dev/null +++ b/src/@ionic-native/plugins/streaming-media/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# StreamingMedia + + +``` +$ ionic plugin add cordova-plugin-streaming-media +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/streaming-media/) + +Cordova Repo: [https://github.com/nchutchind/cordova-plugin-streaming-media](https://github.com/nchutchind/cordova-plugin-streaming-media) + + +This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android. + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/stripe/readme.md b/src/@ionic-native/plugins/stripe/readme.md new file mode 100644 index 000000000..0e5481ad0 --- /dev/null +++ b/src/@ionic-native/plugins/stripe/readme.md @@ -0,0 +1,27 @@ + + + Improve this doc + + +# Stripe + + +

    + This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

    + +``` +$ ionic plugin add cordova-plugin-stripe +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/stripe/) + +Cordova Repo: [https://github.com/zyramedia/cordova-plugin-stripe](https://github.com/zyramedia/cordova-plugin-stripe) + + +A plugin that allows you to use Stripe's Native SDKs for Android and iOS. + + + diff --git a/src/@ionic-native/plugins/text-to-speech/readme.md b/src/@ionic-native/plugins/text-to-speech/readme.md new file mode 100644 index 000000000..39ab0408c --- /dev/null +++ b/src/@ionic-native/plugins/text-to-speech/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# TextToSpeech + + +``` +$ ionic plugin add cordova-plugin-tts +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/text-to-speech/) + +Cordova Repo: [https://github.com/vilic/cordova-plugin-tts](https://github.com/vilic/cordova-plugin-tts) + + +Text to Speech plugin + + + diff --git a/src/@ionic-native/plugins/themeable-browser/readme.md b/src/@ionic-native/plugins/themeable-browser/readme.md new file mode 100644 index 000000000..98eab661f --- /dev/null +++ b/src/@ionic-native/plugins/themeable-browser/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# ThemeableBrowser + + +``` +$ ionic plugin add cordova-plugin-themeablebrowser +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/themeable-browser/) + +Cordova Repo: [https://github.com/initialxy/cordova-plugin-themeablebrowser](https://github.com/initialxy/cordova-plugin-themeablebrowser) + + +In-app browser that allows styling. + + + diff --git a/src/@ionic-native/plugins/toast/readme.md b/src/@ionic-native/plugins/toast/readme.md new file mode 100644 index 000000000..f19015035 --- /dev/null +++ b/src/@ionic-native/plugins/toast/readme.md @@ -0,0 +1,32 @@ + + + Improve this doc + + +# Toast + + +``` +$ ionic plugin add cordova-plugin-x-toast +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/toast/) + +Cordova Repo: [https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin) + + +This plugin allows you to show a native Toast (a little text popup) on iOS, Android and WP8. It's great for showing a non intrusive native notification which is guaranteed always in the viewport of the browser. + +Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the [Toast plugin docs](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin). + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/touchid/readme.md b/src/@ionic-native/plugins/touchid/readme.md new file mode 100644 index 000000000..79865f443 --- /dev/null +++ b/src/@ionic-native/plugins/touchid/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# TouchID + + +``` +$ ionic plugin add cordova-plugin-touch-id +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/touchid/) + +Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-touch-id](https://github.com/EddyVerbruggen/cordova-plugin-touch-id) + + +Scan the fingerprint of a user with the TouchID sensor. + +Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see the [TouchID plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-touch-id). + + +## Supported platforms + +- iOS + + + + + diff --git a/src/@ionic-native/plugins/twitter-connect/readme.md b/src/@ionic-native/plugins/twitter-connect/readme.md new file mode 100644 index 000000000..121883c34 --- /dev/null +++ b/src/@ionic-native/plugins/twitter-connect/readme.md @@ -0,0 +1,41 @@ + + + Improve this doc + + +# Twitter Connect + + +``` +$ ionic plugin add twitter-connect-plugin --variable FABRIC_KEY=fabric_API_key +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/twitter-connect/) + +Cordova Repo: [https://github.com/ManifestWebDesign/twitter-connect-plugin](https://github.com/ManifestWebDesign/twitter-connect-plugin) + + +Plugin to use Twitter Single Sign On +Uses Twitter's Fabric SDK +```typescript +import {TwitterConnect} from 'ionic-native'; + +function onSuccess(response) { + console.log(response); + + // Will console log something like: + // { + // userName: 'myuser', + // userId: '12358102', + // secret: 'tokenSecret' + // token: 'accessTokenHere' + // } +} + +TwitterConnect.login().then(onSuccess, onError); + +TwitterConnect.logout().then(onLogoutSuccess, onLogoutError); +``` + + + diff --git a/src/@ionic-native/plugins/vibration/readme.md b/src/@ionic-native/plugins/vibration/readme.md new file mode 100644 index 000000000..c37dceed7 --- /dev/null +++ b/src/@ionic-native/plugins/vibration/readme.md @@ -0,0 +1,32 @@ + + + Improve this doc + + +# Vibration + + +``` +$ ionic plugin add cordova-plugin-vibration +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/vibration/) + +Cordova Repo: [https://github.com/apache/cordova-plugin-vibration](https://github.com/apache/cordova-plugin-vibration) + + +Vibrates the device + + +## Supported platforms + +- Android +- iOS +- Windows 8.1 Phone +- Windows 8.1 +- Windows 10 + + + + + diff --git a/src/@ionic-native/plugins/video-editor/readme.md b/src/@ionic-native/plugins/video-editor/readme.md new file mode 100644 index 000000000..9fb18a61c --- /dev/null +++ b/src/@ionic-native/plugins/video-editor/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# VideoEditor + + +``` +$ ionic plugin add cordova-plugin-video-editor +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/video-editor/) + +Cordova Repo: [https://github.com/jbavari/cordova-plugin-video-editor](https://github.com/jbavari/cordova-plugin-video-editor) + + +Edit videos using native device APIs + + +## Supported platforms + +- Android +- iOS +- Windows Phone 8 + + + + + diff --git a/src/@ionic-native/plugins/video-player/readme.md b/src/@ionic-native/plugins/video-player/readme.md new file mode 100644 index 000000000..8de675c2a --- /dev/null +++ b/src/@ionic-native/plugins/video-player/readme.md @@ -0,0 +1,30 @@ + + + Improve this doc + + +# VideoPlayer + + +``` +$ ionic plugin add https://github.com/moust/cordova-plugin-videoplayer +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/video-player/) + +Cordova Repo: [https://github.com/moust/cordova-plugin-videoplayer](https://github.com/moust/cordova-plugin-videoplayer) + + +A Codova plugin that simply allows you to immediately play a video in fullscreen mode. + +Requires Cordova plugin: `com.moust.cordova.videoplayer`. For more info, please see the [VideoPlayer plugin docs](https://github.com/moust/cordova-plugin-videoplayer). + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/webintent/readme.md b/src/@ionic-native/plugins/webintent/readme.md new file mode 100644 index 000000000..735fe86f3 --- /dev/null +++ b/src/@ionic-native/plugins/webintent/readme.md @@ -0,0 +1,28 @@ + + + Improve this doc + + +# WebIntent + + +``` +$ ionic plugin add https://github.com/Initsogar/cordova-webintent.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/webintent/) + +Cordova Repo: [https://github.com/Initsogar/cordova-webintent.git](https://github.com/Initsogar/cordova-webintent.git) + + + + + +## Supported platforms + +- Android + + + + + diff --git a/src/@ionic-native/plugins/youtube-video-player/readme.md b/src/@ionic-native/plugins/youtube-video-player/readme.md new file mode 100644 index 000000000..4a5cb9c61 --- /dev/null +++ b/src/@ionic-native/plugins/youtube-video-player/readme.md @@ -0,0 +1,29 @@ + + + Improve this doc + + +# YoutubeVideoPlayer + + +``` +$ ionic plugin add https://github.com/Glitchbone/CordovaYoutubeVideoPlayer.git +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/youtube-video-player/) + +Cordova Repo: [https://github.com/Glitchbone/CordovaYoutubeVideoPlayer](https://github.com/Glitchbone/CordovaYoutubeVideoPlayer) + + +Plays YouTube videos in Native YouTube App + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/z-bar/readme.md b/src/@ionic-native/plugins/z-bar/readme.md new file mode 100644 index 000000000..0502a445c --- /dev/null +++ b/src/@ionic-native/plugins/z-bar/readme.md @@ -0,0 +1,31 @@ + + + Improve this doc + + +# ZBar + + +``` +$ ionic plugin add cordova-plugin-cszbar +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/z-bar/) + +Cordova Repo: [https://github.com/tjwoon/csZBar](https://github.com/tjwoon/csZBar) + + +The ZBar Scanner Plugin allows you to scan 2d barcodes. + +Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the [zBar plugin docs](https://github.com/tjwoon/csZBar). + + +## Supported platforms + +- Android +- iOS + + + + + diff --git a/src/@ionic-native/plugins/zip/readme.md b/src/@ionic-native/plugins/zip/readme.md new file mode 100644 index 000000000..7bfc33fc1 --- /dev/null +++ b/src/@ionic-native/plugins/zip/readme.md @@ -0,0 +1,21 @@ + + + Improve this doc + + +# Zip + + +``` +$ ionic plugin add cordova-plugin-zip +``` + +## [Usage Documentation](https://ionicframework.com/docs/v2/native/zip/) + +Cordova Repo: [https://github.com/MobileChromeApps/cordova-plugin-zip](https://github.com/MobileChromeApps/cordova-plugin-zip) + + +A Cordova plugin to unzip files in Android and iOS. + + +