From 76b4e03d04e394a1798da054307b2102bf62060a Mon Sep 17 00:00:00 2001 From: Daniel Sogl Date: Sat, 21 Mar 2026 15:10:30 -0700 Subject: [PATCH] feat!: replace dgeni/gulp with TypeDoc for README generation Replace the legacy dgeni/gulp documentation pipeline with TypeDoc and typedoc-plugin-markdown. Generates plugin README files with extracted @Plugin() decorator metadata. Register custom JSDoc tags used by plugin source files. --- docs/plugins/abbyy-rtr/README.md | 4 +- docs/plugins/action-sheet/README.md | 10 +- docs/plugins/adjust/README.md | 10 +- docs/plugins/admob-plus/README.md | 14 +- docs/plugins/admob-pro/README.md | 6 +- docs/plugins/admob/README.md | 6 +- docs/plugins/advanced-image-picker/README.md | 4 +- docs/plugins/aes-256/README.md | 4 +- docs/plugins/airship/README.md | 18 ++ docs/plugins/all-in-one-sdk/README.md | 4 +- docs/plugins/analytics-firebase/README.md | 4 +- docs/plugins/android-exoplayer/README.md | 2 - docs/plugins/android-full-screen/README.md | 2 - docs/plugins/android-notch/README.md | 2 - docs/plugins/android-permissions/README.md | 2 - docs/plugins/anyline/README.md | 4 +- docs/plugins/app-availability/README.md | 4 +- docs/plugins/app-center-analytics/README.md | 4 +- docs/plugins/app-center-crashes/README.md | 4 +- docs/plugins/app-center-low-memory/README.md | 4 +- docs/plugins/app-center-push/README.md | 4 +- docs/plugins/app-center-shared/README.md | 4 +- docs/plugins/app-preferences/README.md | 14 +- docs/plugins/app-rate/README.md | 8 +- docs/plugins/app-review/README.md | 4 +- docs/plugins/app-version/README.md | 6 +- docs/plugins/apple-wallet/README.md | 2 - docs/plugins/applovin/README.md | 4 +- docs/plugins/approov-advanced-http/README.md | 8 +- docs/plugins/appsflyer/README.md | 4 +- docs/plugins/audio-management/README.md | 18 ++ docs/plugins/background-fetch/README.md | 2 - docs/plugins/background-mode/README.md | 10 +- docs/plugins/background-upload/README.md | 4 +- docs/plugins/badge/README.md | 8 +- docs/plugins/barcode-scanner/README.md | 10 +- docs/plugins/barkoder/README.md | 16 + docs/plugins/battery-status/README.md | 8 +- docs/plugins/biocatch/README.md | 4 +- docs/plugins/biometric-wrapper/README.md | 6 +- docs/plugins/ble/README.md | 4 +- docs/plugins/blinkid/README.md | 4 +- .../bluetooth-classic-serial-port/README.md | 6 +- docs/plugins/bluetooth-le/README.md | 4 +- docs/plugins/bluetooth-serial/README.md | 6 +- docs/plugins/branch-io/README.md | 4 +- docs/plugins/brightness/README.md | 4 +- docs/plugins/broadcaster/README.md | 6 +- docs/plugins/browser-tab/README.md | 4 +- docs/plugins/build-info/README.md | 12 +- docs/plugins/calendar/README.md | 4 +- docs/plugins/call-directory/README.md | 2 - docs/plugins/call-number/README.md | 4 +- docs/plugins/camera-preview/README.md | 11 +- docs/plugins/camera/README.md | 8 +- docs/plugins/cashfree-pg/README.md | 12 +- docs/plugins/checkout/README.md | 6 +- docs/plugins/chooser-simple-file/README.md | 4 +- docs/plugins/chooser/README.md | 4 +- docs/plugins/clevertap/README.md | 4 +- docs/plugins/clipboard/README.md | 6 +- docs/plugins/cloud-settings/README.md | 6 +- docs/plugins/code-push/README.md | 4 +- docs/plugins/contacts/README.md | 25 ++ docs/plugins/core/README.md | 273 ++++++++++++++++++ docs/plugins/crop-plugin-privacy/README.md | 2 - docs/plugins/custom-ui-sdk/README.md | 15 + docs/plugins/custom-uisdk/README.md | 4 +- docs/plugins/deeplinks/README.md | 6 +- docs/plugins/device-accounts/README.md | 2 - docs/plugins/device-motion/README.md | 18 +- docs/plugins/device-orientation/README.md | 20 +- docs/plugins/device/README.md | 10 +- docs/plugins/dfu-update/README.md | 4 +- docs/plugins/diagnostic/README.md | 6 +- docs/plugins/dialogs/README.md | 10 +- docs/plugins/dns/README.md | 2 - docs/plugins/document-picker/README.md | 2 - docs/plugins/document-scanner/README.md | 4 +- docs/plugins/document-viewer/README.md | 6 +- docs/plugins/downloader/README.md | 17 ++ .../dynamsoft-barcode-scanner/README.md | 6 +- docs/plugins/email-composer/README.md | 12 +- docs/plugins/fabric/README.md | 8 +- docs/plugins/facebook/README.md | 6 +- docs/plugins/fbsdk/README.md | 6 +- docs/plugins/fcm/README.md | 4 +- docs/plugins/ffmpeg/README.md | 4 +- docs/plugins/file-chooser/README.md | 2 - docs/plugins/file-md5/README.md | 4 +- docs/plugins/file-opener/README.md | 8 +- docs/plugins/file-path/README.md | 2 - docs/plugins/file-transfer/README.md | 14 +- docs/plugins/file/README.md | 10 +- docs/plugins/fingerprint-aio/README.md | 4 +- docs/plugins/firebase-analytics/README.md | 11 +- .../plugins/firebase-authentication/README.md | 4 +- docs/plugins/firebase-config/README.md | 11 +- docs/plugins/firebase-crash/README.md | 4 +- docs/plugins/firebase-crashlytics/README.md | 4 +- docs/plugins/firebase-dynamic-links/README.md | 11 +- docs/plugins/firebase-messaging/README.md | 11 +- docs/plugins/firebase-model/README.md | 12 +- docs/plugins/firebase-vision/README.md | 4 +- docs/plugins/firebase-x/README.md | 4 +- docs/plugins/firebase/README.md | 4 +- docs/plugins/flashlight/README.md | 6 +- docs/plugins/foreground-service/README.md | 2 - docs/plugins/ftp/README.md | 4 +- docs/plugins/gao-de-location/README.md | 4 +- docs/plugins/gcdwebserver/README.md | 4 +- docs/plugins/ge-tui-sdk-plugin/README.md | 4 +- docs/plugins/genius-scan/README.md | 16 + docs/plugins/geolocation/README.md | 10 +- docs/plugins/globalization/README.md | 10 +- docs/plugins/google-analytics/README.md | 8 +- docs/plugins/google-nearby/README.md | 2 - docs/plugins/google-plus/README.md | 6 +- docs/plugins/header-color/README.md | 2 - docs/plugins/health-kit/README.md | 2 - docs/plugins/health/README.md | 4 +- docs/plugins/http/README.md | 4 +- docs/plugins/hyper-track/README.md | 11 +- docs/plugins/i-root/README.md | 30 +- docs/plugins/iamport-cordova/README.md | 4 +- docs/plugins/ibeacon/README.md | 4 +- docs/plugins/image-picker/README.md | 4 +- docs/plugins/image-resizer/README.md | 4 +- docs/plugins/imap/README.md | 4 +- docs/plugins/in-app-browser/README.md | 12 +- docs/plugins/in-app-purchase-2/README.md | 7 +- docs/plugins/in-app-purchase-3/README.md | 45 +++ docs/plugins/in-app-review/README.md | 2 - docs/plugins/in-app-update/README.md | 2 - docs/plugins/insomnia/README.md | 12 +- docs/plugins/instagram/README.md | 4 +- docs/plugins/intercom/README.md | 6 +- docs/plugins/ionic-webview/README.md | 4 +- .../README.md | 2 - docs/plugins/is-debug/README.md | 4 +- docs/plugins/keyboard/README.md | 4 +- docs/plugins/keychain/README.md | 2 - docs/plugins/kommunicate/README.md | 6 +- docs/plugins/launch-navigator/README.md | 8 +- docs/plugins/launch-review/README.md | 4 +- docs/plugins/lets-cooee/README.md | 4 +- docs/plugins/line-login/README.md | 4 +- docs/plugins/local-backup/README.md | 4 +- docs/plugins/local-notifications/README.md | 6 +- docs/plugins/location-accuracy/README.md | 4 +- docs/plugins/lottie-splash-screen/README.md | 6 +- docs/plugins/magnetometer/README.md | 4 +- docs/plugins/market/README.md | 4 +- docs/plugins/media-capture/README.md | 8 +- docs/plugins/media/README.md | 8 +- docs/plugins/metrix/README.md | 2 - docs/plugins/mixpanel/README.md | 6 +- docs/plugins/mlkit-translate/README.md | 4 +- docs/plugins/mobile-accessibility/README.md | 8 +- docs/plugins/mobile-messaging/README.md | 4 +- .../multiple-document-picker/README.md | 4 +- docs/plugins/music-controls/README.md | 6 +- docs/plugins/native-audio/README.md | 6 +- docs/plugins/native-geocoder/README.md | 4 +- docs/plugins/native-keyboard/README.md | 4 +- .../plugins/native-page-transitions/README.md | 6 +- docs/plugins/native-storage/README.md | 10 +- docs/plugins/native-view/README.md | 6 +- docs/plugins/network-interface/README.md | 12 +- docs/plugins/network-permission/README.md | 17 ++ docs/plugins/network/README.md | 10 +- docs/plugins/newrelic/README.md | 4 +- docs/plugins/nfc/README.md | 6 +- docs/plugins/ocr/README.md | 4 +- docs/plugins/onesignal/README.md | 8 +- docs/plugins/open-native-settings/README.md | 4 +- docs/plugins/openalpr/README.md | 4 +- docs/plugins/openinstall/README.md | 16 + docs/plugins/paytabs/README.md | 4 +- docs/plugins/pdf-generator/README.md | 4 +- docs/plugins/photo-library/README.md | 6 +- docs/plugins/photo-viewer/README.md | 4 +- docs/plugins/play-install-referrer/README.md | 4 - docs/plugins/pollfish/README.md | 4 +- docs/plugins/power-management/README.md | 4 +- docs/plugins/power-optimization/README.md | 2 - docs/plugins/preview-any-file/README.md | 8 +- docs/plugins/printer/README.md | 6 +- docs/plugins/pspdfkit-cordova/README.md | 4 +- docs/plugins/purchases/README.md | 4 +- docs/plugins/push/README.md | 8 +- docs/plugins/pushape-push/README.md | 12 +- docs/plugins/safari-view-controller/README.md | 4 +- docs/plugins/save-dialog/README.md | 12 +- docs/plugins/screen-orientation/README.md | 6 +- docs/plugins/screenshot/README.md | 18 ++ docs/plugins/secure-storage-echo/README.md | 8 +- docs/plugins/secure-storage/README.md | 8 +- docs/plugins/service-discovery/README.md | 4 +- docs/plugins/shake/README.md | 2 - docs/plugins/shortcuts-android/README.md | 21 ++ docs/plugins/sign-in-with-apple/README.md | 8 +- docs/plugins/smartlook/README.md | 4 +- docs/plugins/sms-retriever-api/README.md | 2 - docs/plugins/sms-retriever/README.md | 2 - docs/plugins/sms/README.md | 8 +- docs/plugins/smtp-client/README.md | 3 +- docs/plugins/social-sharing/README.md | 10 +- docs/plugins/sockets-tcp/README.md | 18 ++ docs/plugins/sockets-udp/README.md | 18 ++ docs/plugins/speech-recognition/README.md | 4 +- docs/plugins/spinner-dialog/README.md | 8 +- docs/plugins/splash-screen/README.md | 8 +- docs/plugins/spotify-auth/README.md | 4 +- docs/plugins/sqlite-db-copy/README.md | 4 +- docs/plugins/sqlite-porter/README.md | 16 +- docs/plugins/sqlite/README.md | 8 +- .../plugins/ssl-certificate-checker/README.md | 9 +- docs/plugins/star-prnt/README.md | 4 +- docs/plugins/status-bar/README.md | 6 +- docs/plugins/streaming-media/README.md | 6 +- docs/plugins/stripe/README.md | 6 +- docs/plugins/sum-up/README.md | 4 +- .../system-alert-window-permission/README.md | 2 - docs/plugins/taptic-engine/README.md | 2 - docs/plugins/tealium-adidentifier/README.md | 6 +- .../plugins/tealium-installreferrer/README.md | 4 +- docs/plugins/tealium/README.md | 10 +- .../plugins/text-to-speech-advanced/README.md | 4 +- docs/plugins/theme-detection/README.md | 11 +- docs/plugins/three-dee-touch/README.md | 6 +- docs/plugins/toast/README.md | 10 +- docs/plugins/touch-id/README.md | 2 - docs/plugins/unique-device-id/README.md | 8 +- docs/plugins/unvired-cordova-sdk/README.md | 16 +- docs/plugins/uptime/README.md | 4 +- docs/plugins/urbanairship/README.md | 4 +- docs/plugins/usabilla-cordova-sdk/README.md | 4 +- docs/plugins/vibes/README.md | 4 +- docs/plugins/vibration/README.md | 6 +- docs/plugins/video-editor/README.md | 8 +- docs/plugins/video-player/README.md | 2 - docs/plugins/we-cap-inbox/README.md | 18 ++ docs/plugins/web-intent/README.md | 2 - docs/plugins/web-server/README.md | 4 +- docs/plugins/web-socket-server/README.md | 4 +- docs/plugins/webengage/README.md | 4 +- docs/plugins/webim/README.md | 6 +- docs/plugins/wechat/README.md | 4 +- docs/plugins/wheel-selector/README.md | 11 +- docs/plugins/wifi-wizard-2/README.md | 4 +- docs/plugins/wonderpush/README.md | 7 +- docs/plugins/youtube-video-player/README.md | 4 +- docs/plugins/zbar/README.md | 4 +- docs/plugins/zeroconf/README.md | 4 +- docs/plugins/zip/README.md | 4 +- docs/plugins/zoom/README.md | 4 +- scripts/docs/config.json | 4 - scripts/docs/dgeni/configs/links.js | 3 - scripts/docs/dgeni/configs/log.js | 3 - scripts/docs/dgeni/configs/tag-defs.js | 3 - .../docs/dgeni/configs/template-filters.js | 12 - scripts/docs/dgeni/configs/template-tags.js | 9 - scripts/docs/dgeni/dgeni-config.js | 75 ----- scripts/docs/dgeni/dgeni-readmes-config.js | 74 ----- scripts/docs/dgeni/filters/capital.js | 5 - scripts/docs/dgeni/filters/code.js | 24 -- scripts/docs/dgeni/filters/dashify.js | 5 - scripts/docs/dgeni/filters/dump.js | 5 - scripts/docs/dgeni/processors/debug.js | 39 --- .../docs/dgeni/processors/hide-private-api.js | 9 - scripts/docs/dgeni/processors/jekyll.js | 63 ---- .../docs/dgeni/processors/mark-properties.js | 16 - scripts/docs/dgeni/processors/npm-id.js | 20 -- .../docs/dgeni/processors/parse-optional.js | 22 -- scripts/docs/dgeni/processors/readmes.js | 19 -- .../processors/remove-private-members.js | 22 -- scripts/docs/dgeni/tag-defs/tag-defs.js | 11 - .../docs/dgeni/templates/common.template.html | 192 ------------ .../dgeni/templates/native_menu.template.html | 14 - .../docs/dgeni/templates/readme.template.md | 36 --- scripts/docs/generate-readmes.ts | 257 +++++++++++++++++ scripts/docs/gulp-tasks.js | 36 --- 283 files changed, 1249 insertions(+), 1704 deletions(-) create mode 100644 docs/plugins/airship/README.md create mode 100644 docs/plugins/audio-management/README.md create mode 100644 docs/plugins/barkoder/README.md create mode 100644 docs/plugins/contacts/README.md create mode 100644 docs/plugins/core/README.md create mode 100644 docs/plugins/custom-ui-sdk/README.md create mode 100644 docs/plugins/downloader/README.md create mode 100644 docs/plugins/genius-scan/README.md create mode 100644 docs/plugins/in-app-purchase-3/README.md create mode 100644 docs/plugins/network-permission/README.md create mode 100644 docs/plugins/openinstall/README.md create mode 100644 docs/plugins/screenshot/README.md create mode 100644 docs/plugins/shortcuts-android/README.md create mode 100644 docs/plugins/sockets-tcp/README.md create mode 100644 docs/plugins/sockets-udp/README.md create mode 100644 docs/plugins/we-cap-inbox/README.md delete mode 100644 scripts/docs/config.json delete mode 100644 scripts/docs/dgeni/configs/links.js delete mode 100644 scripts/docs/dgeni/configs/log.js delete mode 100644 scripts/docs/dgeni/configs/tag-defs.js delete mode 100644 scripts/docs/dgeni/configs/template-filters.js delete mode 100644 scripts/docs/dgeni/configs/template-tags.js delete mode 100644 scripts/docs/dgeni/dgeni-config.js delete mode 100644 scripts/docs/dgeni/dgeni-readmes-config.js delete mode 100644 scripts/docs/dgeni/filters/capital.js delete mode 100644 scripts/docs/dgeni/filters/code.js delete mode 100644 scripts/docs/dgeni/filters/dashify.js delete mode 100644 scripts/docs/dgeni/filters/dump.js delete mode 100644 scripts/docs/dgeni/processors/debug.js delete mode 100644 scripts/docs/dgeni/processors/hide-private-api.js delete mode 100644 scripts/docs/dgeni/processors/jekyll.js delete mode 100644 scripts/docs/dgeni/processors/mark-properties.js delete mode 100644 scripts/docs/dgeni/processors/npm-id.js delete mode 100644 scripts/docs/dgeni/processors/parse-optional.js delete mode 100644 scripts/docs/dgeni/processors/readmes.js delete mode 100644 scripts/docs/dgeni/processors/remove-private-members.js delete mode 100644 scripts/docs/dgeni/tag-defs/tag-defs.js delete mode 100644 scripts/docs/dgeni/templates/common.template.html delete mode 100644 scripts/docs/dgeni/templates/native_menu.template.html delete mode 100644 scripts/docs/dgeni/templates/readme.template.md create mode 100644 scripts/docs/generate-readmes.ts delete mode 100644 scripts/docs/gulp-tasks.js diff --git a/docs/plugins/abbyy-rtr/README.md b/docs/plugins/abbyy-rtr/README.md index fa5b87f4d..cdd525fa4 100644 --- a/docs/plugins/abbyy-rtr/README.md +++ b/docs/plugins/abbyy-rtr/README.md @@ -15,7 +15,5 @@ ABBYY Real-Time Recognition SDK (RTR SDK) in apps. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/action-sheet/README.md b/docs/plugins/action-sheet/README.md index 29da3b0db..facbbbfd6 100644 --- a/docs/plugins/action-sheet/README.md +++ b/docs/plugins/action-sheet/README.md @@ -16,10 +16,8 @@ Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see ## Supported platforms - Android - - Browser - - iOS - - Windows - - Windows Phone 8 - - +- Browser +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/adjust/README.md b/docs/plugins/adjust/README.md index 3b0fd1eef..0a483500b 100644 --- a/docs/plugins/adjust/README.md +++ b/docs/plugins/adjust/README.md @@ -1,5 +1,7 @@ -# AdjustThirdPartySharing -ova plugin add com.adjust.sdk +# Adjust + +``` +$ ionic cordova plugin add com.adjust.sdk $ npm install @awesome-cordova-plugins/adjust ``` @@ -14,7 +16,5 @@ Requires Cordova plugin: `com.adjust.sdk`. For more info, please see the [Adjust ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/admob-plus/README.md b/docs/plugins/admob-plus/README.md index f39a9c28e..3b87ad062 100644 --- a/docs/plugins/admob-plus/README.md +++ b/docs/plugins/admob-plus/README.md @@ -1,4 +1,4 @@ -# RewardVideo +# AdMob ``` $ ionic cordova plugin add cordova-admob-plus @@ -7,18 +7,10 @@ $ npm install @awesome-cordova-plugins/admob-plus ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/admob-plus/) -Plugin Repo: []() - - - -github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus) - -AdMob Plus is the successor of cordova-plugin-admob-free, which provides a cleaner API and build with modern tools. +Plugin Repo: [https://github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus) ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/admob-pro/README.md b/docs/plugins/admob-pro/README.md index e7b631ea7..dac68991b 100644 --- a/docs/plugins/admob-pro/README.md +++ b/docs/plugins/admob-pro/README.md @@ -16,8 +16,6 @@ IMPORTANT NOTICE: this plugin takes a percentage out of your earnings if you pro ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/admob/README.md b/docs/plugins/admob/README.md index 77d5ff579..ccd1c355e 100644 --- a/docs/plugins/admob/README.md +++ b/docs/plugins/admob/README.md @@ -21,8 +21,6 @@ Supports:** ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/advanced-image-picker/README.md b/docs/plugins/advanced-image-picker/README.md index 5937ff35c..0440427e0 100644 --- a/docs/plugins/advanced-image-picker/README.md +++ b/docs/plugins/advanced-image-picker/README.md @@ -14,7 +14,5 @@ This Cordova Plugin is for a better (multiple) ImagePicker with more options. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/aes-256/README.md b/docs/plugins/aes-256/README.md index 11c878a72..2c2607bec 100644 --- a/docs/plugins/aes-256/README.md +++ b/docs/plugins/aes-256/README.md @@ -16,7 +16,5 @@ The encryption and decryption are performed on the device native layer so that t ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/airship/README.md b/docs/plugins/airship/README.md new file mode 100644 index 000000000..fee42999e --- /dev/null +++ b/docs/plugins/airship/README.md @@ -0,0 +1,18 @@ +# Airship + +``` +$ ionic cordova plugin add @ua/cordova-airship +$ npm install @awesome-cordova-plugins/airship +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/airship/) + +Plugin Repo: [https://www.npmjs.com/package/@ua/cordova-airship](https://www.npmjs.com/package/@ua/cordova-airship) + +This plugin does something + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/all-in-one-sdk/README.md b/docs/plugins/all-in-one-sdk/README.md index f80b20e02..c6721a95c 100644 --- a/docs/plugins/all-in-one-sdk/README.md +++ b/docs/plugins/all-in-one-sdk/README.md @@ -17,7 +17,5 @@ For more information about Paytm All-in-One SDK, please visit https://developer. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/analytics-firebase/README.md b/docs/plugins/analytics-firebase/README.md index 6698c2bb8..de2e1625a 100644 --- a/docs/plugins/analytics-firebase/README.md +++ b/docs/plugins/analytics-firebase/README.md @@ -14,7 +14,5 @@ Google Analytics Firebase plugin for Ionic Native apps. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/android-exoplayer/README.md b/docs/plugins/android-exoplayer/README.md index fb005f279..90c6ab738 100644 --- a/docs/plugins/android-exoplayer/README.md +++ b/docs/plugins/android-exoplayer/README.md @@ -16,6 +16,4 @@ https://github.com/google/ExoPlayer ## Supported platforms - Android - - diff --git a/docs/plugins/android-full-screen/README.md b/docs/plugins/android-full-screen/README.md index d6818f3a1..49cbdb7d7 100644 --- a/docs/plugins/android-full-screen/README.md +++ b/docs/plugins/android-full-screen/README.md @@ -16,6 +16,4 @@ In Android 4.4+, however, you can now enter true full screen, fully interactive ## Supported platforms - Android - - diff --git a/docs/plugins/android-notch/README.md b/docs/plugins/android-notch/README.md index 1d5d1ca10..84ecb8ea2 100644 --- a/docs/plugins/android-notch/README.md +++ b/docs/plugins/android-notch/README.md @@ -16,6 +16,4 @@ This plugin works on all android versions, but we can only detect notches starti ## Supported platforms - Android - - diff --git a/docs/plugins/android-permissions/README.md b/docs/plugins/android-permissions/README.md index d29ad16d8..0a4266a82 100644 --- a/docs/plugins/android-permissions/README.md +++ b/docs/plugins/android-permissions/README.md @@ -16,6 +16,4 @@ You can find all permissions here: https://developer.android.com/reference/andro ## Supported platforms - Android - - diff --git a/docs/plugins/anyline/README.md b/docs/plugins/anyline/README.md index df9d5078e..185bf97b1 100644 --- a/docs/plugins/anyline/README.md +++ b/docs/plugins/anyline/README.md @@ -14,7 +14,5 @@ Anyline provides an easy-to-use SDK for applications to enable Optical Character ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-availability/README.md b/docs/plugins/app-availability/README.md index e594555be..737472b48 100644 --- a/docs/plugins/app-availability/README.md +++ b/docs/plugins/app-availability/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: cordova-plugin-appavailability. For more info, please s ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-center-analytics/README.md b/docs/plugins/app-center-analytics/README.md index e81ed5791..af29ee6a8 100644 --- a/docs/plugins/app-center-analytics/README.md +++ b/docs/plugins/app-center-analytics/README.md @@ -19,7 +19,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/analyti ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-center-crashes/README.md b/docs/plugins/app-center-crashes/README.md index e831a704a..be6441aea 100644 --- a/docs/plugins/app-center-crashes/README.md +++ b/docs/plugins/app-center-crashes/README.md @@ -19,7 +19,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/crashes ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-center-low-memory/README.md b/docs/plugins/app-center-low-memory/README.md index 088fb2477..340df885a 100644 --- a/docs/plugins/app-center-low-memory/README.md +++ b/docs/plugins/app-center-low-memory/README.md @@ -15,7 +15,5 @@ For more info, please see: https://github.com/Microsoft/appcenter-sdk-cordova/tr ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-center-push/README.md b/docs/plugins/app-center-push/README.md index 06acfc7cd..2eab3f2b1 100644 --- a/docs/plugins/app-center-push/README.md +++ b/docs/plugins/app-center-push/README.md @@ -14,7 +14,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/push/co ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-center-shared/README.md b/docs/plugins/app-center-shared/README.md index c68b54a44..a84db09e9 100644 --- a/docs/plugins/app-center-shared/README.md +++ b/docs/plugins/app-center-shared/README.md @@ -16,7 +16,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/other-a ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-preferences/README.md b/docs/plugins/app-preferences/README.md index 1928e89c1..8793412c2 100644 --- a/docs/plugins/app-preferences/README.md +++ b/docs/plugins/app-preferences/README.md @@ -14,12 +14,10 @@ This plugin allows you to read and write app preferences ## Supported platforms - Android - - BlackBerry 10 - - Browser - - iOS - - macOS - - Windows 8 - - Windows Phone - - +- BlackBerry 10 +- Browser +- iOS +- macOS +- Windows 8 +- Windows Phone diff --git a/docs/plugins/app-rate/README.md b/docs/plugins/app-rate/README.md index 5dd8b8e31..8b1b8eb05 100644 --- a/docs/plugins/app-rate/README.md +++ b/docs/plugins/app-rate/README.md @@ -16,9 +16,7 @@ Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [ ## Supported platforms - Android - - BlackBerry 10 - - iOS - - Windows - - +- BlackBerry 10 +- iOS +- Windows diff --git a/docs/plugins/app-review/README.md b/docs/plugins/app-review/README.md index 6f3f33803..04d6a3736 100644 --- a/docs/plugins/app-review/README.md +++ b/docs/plugins/app-review/README.md @@ -14,7 +14,5 @@ Cordova plugin to review app ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/app-version/README.md b/docs/plugins/app-version/README.md index ed6399a89..f7df80c79 100644 --- a/docs/plugins/app-version/README.md +++ b/docs/plugins/app-version/README.md @@ -16,8 +16,6 @@ Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/apple-wallet/README.md b/docs/plugins/apple-wallet/README.md index ac378c15c..2efc89fc7 100644 --- a/docs/plugins/apple-wallet/README.md +++ b/docs/plugins/apple-wallet/README.md @@ -14,6 +14,4 @@ A Cordova plugin that enables users from Add Payment Cards to their Apple Wallet ## Supported platforms - iOS - - diff --git a/docs/plugins/applovin/README.md b/docs/plugins/applovin/README.md index 1625d299b..b7c08f096 100644 --- a/docs/plugins/applovin/README.md +++ b/docs/plugins/applovin/README.md @@ -14,7 +14,5 @@ This plugin allows you to easily configure, integrate and interact with Applovin ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/approov-advanced-http/README.md b/docs/plugins/approov-advanced-http/README.md index b2d5a5a77..a3d5a3496 100644 --- a/docs/plugins/approov-advanced-http/README.md +++ b/docs/plugins/approov-advanced-http/README.md @@ -1,13 +1,13 @@ # HTTP ``` -$ ionic cordova plugin add cordova-approov-advanced-http +$ ionic cordova plugin add @approov/cordova-plugin-advanced-http $ npm install @awesome-cordova-plugins/approov-advanced-http ``` ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/approov-advanced-http/) -Plugin Repo: [https://github.com/approov/quickstart-ionic-advancedhttp](https://github.com/approov/quickstart-ionic-advancedhttp) +Plugin Repo: [https://github.com/approov/quickstart-cordova-advancedhttp](https://github.com/approov/quickstart-cordova-advancedhttp) Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. @@ -22,7 +22,5 @@ we have only added approov functionality on top of it. All credit goes to the ac ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/appsflyer/README.md b/docs/plugins/appsflyer/README.md index 9bfb00f77..863d1bba0 100644 --- a/docs/plugins/appsflyer/README.md +++ b/docs/plugins/appsflyer/README.md @@ -14,7 +14,5 @@ Appsflyer Cordova SDK support for Attribution ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/audio-management/README.md b/docs/plugins/audio-management/README.md new file mode 100644 index 000000000..4de48a74f --- /dev/null +++ b/docs/plugins/audio-management/README.md @@ -0,0 +1,18 @@ +# Audio Management + +``` +$ ionic cordova plugin add clovelced-plugin-audiomanagement +$ npm install @awesome-cordova-plugins/audio-management +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/audio-management/) + +Plugin Repo: [https://github.com/clovelCed/cordova-plugin-audiomanagement](https://github.com/clovelCed/cordova-plugin-audiomanagement) + +A Cordova plugin to manage volume of audio streams for: ring, music, notification and system. Possible +ringer values for those streams are: silent, vibrate and normal. + +## Supported platforms + +- Android + diff --git a/docs/plugins/background-fetch/README.md b/docs/plugins/background-fetch/README.md index d2089c55e..004f14beb 100644 --- a/docs/plugins/background-fetch/README.md +++ b/docs/plugins/background-fetch/README.md @@ -16,6 +16,4 @@ For more detail, please see https://github.com/transistorsoft/cordova-plugin-bac ## Supported platforms - iOS - - diff --git a/docs/plugins/background-mode/README.md b/docs/plugins/background-mode/README.md index 1e1f64fc8..fc237cc8f 100644 --- a/docs/plugins/background-mode/README.md +++ b/docs/plugins/background-mode/README.md @@ -15,10 +15,8 @@ Requires Cordova plugin: cordova-plugin-background-mode. For more info about plu ## Supported platforms - AmazonFire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/background-upload/README.md b/docs/plugins/background-upload/README.md index 4506ef17d..4a8f3a869 100644 --- a/docs/plugins/background-upload/README.md +++ b/docs/plugins/background-upload/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/badge/README.md b/docs/plugins/badge/README.md index a0098d408..8c6448d14 100644 --- a/docs/plugins/badge/README.md +++ b/docs/plugins/badge/README.md @@ -18,9 +18,7 @@ Android Note: Badges have historically only been a feature implemented by third ## Supported platforms - Android - - Browser - - iOS - - Windows - - +- Browser +- iOS +- Windows diff --git a/docs/plugins/barcode-scanner/README.md b/docs/plugins/barcode-scanner/README.md index ac852dac9..b560b1071 100644 --- a/docs/plugins/barcode-scanner/README.md +++ b/docs/plugins/barcode-scanner/README.md @@ -16,10 +16,8 @@ Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please ## Supported platforms - Android - - BlackBerry 10 - - Browser - - iOS - - Windows - - +- BlackBerry 10 +- Browser +- iOS +- Windows diff --git a/docs/plugins/barkoder/README.md b/docs/plugins/barkoder/README.md new file mode 100644 index 000000000..04e5708b9 --- /dev/null +++ b/docs/plugins/barkoder/README.md @@ -0,0 +1,16 @@ +# Barkoder + +``` +$ ionic cordova plugin add barkoder-cordova +$ npm install @awesome-cordova-plugins/barkoder +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/barkoder/) + +The barKoder Barcode Scanner SDK cordova plugin grants an easy to use solution with a great and completely customizable interface that can be instantly integrated in both iOS and Android apps. + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/battery-status/README.md b/docs/plugins/battery-status/README.md index 544055b64..0a66c2b68 100644 --- a/docs/plugins/battery-status/README.md +++ b/docs/plugins/battery-status/README.md @@ -14,9 +14,7 @@ Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see ## Supported platforms - iOS - - Android - - Windows - - Browser - - +- Android +- Windows +- Browser diff --git a/docs/plugins/biocatch/README.md b/docs/plugins/biocatch/README.md index 8c314af6b..80dcefe78 100644 --- a/docs/plugins/biocatch/README.md +++ b/docs/plugins/biocatch/README.md @@ -14,7 +14,5 @@ BioCatch SDK Cordova support ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/biometric-wrapper/README.md b/docs/plugins/biometric-wrapper/README.md index 46368b779..b8b740c83 100644 --- a/docs/plugins/biometric-wrapper/README.md +++ b/docs/plugins/biometric-wrapper/README.md @@ -1,20 +1,16 @@ # BiometricWrapper ``` -$ '' +$ $ npm install @awesome-cordova-plugins/biometric-wrapper ``` ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/biometric-wrapper/) -Plugin Repo: ['']('') - This plugin capture biometric(Iris and Fingerprint) and validate the user. May be used in Banking domain ## Supported platforms - Android - - diff --git a/docs/plugins/ble/README.md b/docs/plugins/ble/README.md index deae88cdf..1ff1047b7 100644 --- a/docs/plugins/ble/README.md +++ b/docs/plugins/ble/README.md @@ -26,7 +26,5 @@ Simultaneous connections to multiple peripherals are supported. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/blinkid/README.md b/docs/plugins/blinkid/README.md index 291ee1108..1c12f16fa 100644 --- a/docs/plugins/blinkid/README.md +++ b/docs/plugins/blinkid/README.md @@ -15,7 +15,5 @@ blinkid-phonegap repository for available recognizers and other settings ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/bluetooth-classic-serial-port/README.md b/docs/plugins/bluetooth-classic-serial-port/README.md index fc16cd019..5c0a21343 100644 --- a/docs/plugins/bluetooth-classic-serial-port/README.md +++ b/docs/plugins/bluetooth-classic-serial-port/README.md @@ -14,8 +14,6 @@ This plugin is written using the iOS Accessory Framework (MFi) to support Classi ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/bluetooth-le/README.md b/docs/plugins/bluetooth-le/README.md index 4e1482465..3fd723af9 100644 --- a/docs/plugins/bluetooth-le/README.md +++ b/docs/plugins/bluetooth-le/README.md @@ -16,7 +16,5 @@ It supports peripheral **and** central modes and covers most of the API methods ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/bluetooth-serial/README.md b/docs/plugins/bluetooth-serial/README.md index 33d99a7f7..d49a1c65d 100644 --- a/docs/plugins/bluetooth-serial/README.md +++ b/docs/plugins/bluetooth-serial/README.md @@ -14,8 +14,6 @@ This plugin enables serial communication over Bluetooth. It was written for comm ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/branch-io/README.md b/docs/plugins/branch-io/README.md index 3726fb954..d23e3b318 100644 --- a/docs/plugins/branch-io/README.md +++ b/docs/plugins/branch-io/README.md @@ -14,7 +14,5 @@ Branch.io is an attribution service for deeplinking and invitation links ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/brightness/README.md b/docs/plugins/brightness/README.md index ebd4c50ac..58efa7829 100644 --- a/docs/plugins/brightness/README.md +++ b/docs/plugins/brightness/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/broadcaster/README.md b/docs/plugins/broadcaster/README.md index 70416583e..d2469831f 100644 --- a/docs/plugins/broadcaster/README.md +++ b/docs/plugins/broadcaster/README.md @@ -14,8 +14,6 @@ This plugin adds exchanging events between native code and your app. ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/browser-tab/README.md b/docs/plugins/browser-tab/README.md index 18715b05d..3aff2cec6 100644 --- a/docs/plugins/browser-tab/README.md +++ b/docs/plugins/browser-tab/README.md @@ -14,7 +14,5 @@ This plugin provides an interface to in-app browser tabs that exist on some mobi ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/build-info/README.md b/docs/plugins/build-info/README.md index dcf832df2..31b36dfa1 100644 --- a/docs/plugins/build-info/README.md +++ b/docs/plugins/build-info/README.md @@ -14,11 +14,9 @@ This plugin provides build information. ## Supported platforms - Android - - iOS - - Windows - - macOS - - browser - - Electron - - +- iOS +- Windows +- macOS +- browser +- Electron diff --git a/docs/plugins/calendar/README.md b/docs/plugins/calendar/README.md index e5a27965e..a36807cf1 100644 --- a/docs/plugins/calendar/README.md +++ b/docs/plugins/calendar/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see th ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/call-directory/README.md b/docs/plugins/call-directory/README.md index 5629753d0..7690bd09a 100644 --- a/docs/plugins/call-directory/README.md +++ b/docs/plugins/call-directory/README.md @@ -15,6 +15,4 @@ to process the changes in the call directory extension. ## Supported platforms - iOS - - diff --git a/docs/plugins/call-number/README.md b/docs/plugins/call-number/README.md index 385bdd7f9..a0c0330ea 100644 --- a/docs/plugins/call-number/README.md +++ b/docs/plugins/call-number/README.md @@ -15,7 +15,5 @@ NOTE**: The iOS Simulator (and maybe Android Simulators) do not provide access t ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/camera-preview/README.md b/docs/plugins/camera-preview/README.md index 6066c289b..25acf2f91 100644 --- a/docs/plugins/camera-preview/README.md +++ b/docs/plugins/camera-preview/README.md @@ -1,12 +1,5 @@ # Camera Preview -

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

- - ``` $ ionic cordova plugin add cordova-plugin-camera-preview $ npm install @awesome-cordova-plugins/camera-preview @@ -23,7 +16,5 @@ Requires Cordova plugin: `https://github.com/cordova-plugin-camera-preview/cordo ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/camera/README.md b/docs/plugins/camera/README.md index 400e127e4..67c5bca1c 100644 --- a/docs/plugins/camera/README.md +++ b/docs/plugins/camera/README.md @@ -24,9 +24,7 @@ inside of the ` { + + // get position + this.geolocation.getCurrentPosition().then(pos => { + console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`) + }); + + + // watch position + const watch = geolocation.watchPosition().subscribe(pos => { + console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`) + }); + + // to stop watching + watch.unsubscribe(); + }); + + } + +} +``` + +#### Ionic/React apps + +React apps must use Capacitor to build native mobile apps. However, Awesome Cordova Plugins (and therefore, Cordova plugins) can still be used. + +```bash +# Install Core library (once per project) +npm install @awesome-cordova-plugins/core + +# Install Awesome Cordova Plugins TypeScript wrapper +npm install @awesome-cordova-plugins/barcode-scanner + +# Install Cordova plugin +npm install phonegap-plugin-barcodescanner + +# Update native platform project(s) to include newly added plugin +ionic cap sync +``` + +Import the plugin object then use its static methods: + +```typescript +import { BarcodeScanner } from '@awesome-cordova-plugins/barcode-scanner'; + +const Tab1: React.FC = () => { + const openScanner = async () => { + const data = await BarcodeScanner.scan(); + console.log(`Barcode data: ${data.text}`); + }; + return ( + + + + Tab 1 + + + + Scan barcode + + + ); +}; +``` + +#### ES2015+/TypeScript + +These modules can work in any ES2015+/TypeScript app (including Angular/Ionic apps). To use any plugin, import the class from the appropriate package, and use it's static methods. + +```js +import { Camera } from '@awesome-cordova-plugins/camera'; + +document.addEventListener('deviceready', () => { + Camera.getPicture() + .then((data) => console.log('Took a picture!', data)) + .catch((e) => console.log('Error occurred while taking a picture', e)); +}); +``` + +#### AngularJS + +Awesome Cordova Plugins generates an AngularJS module in runtime and prepares a service for each plugin. To use the plugins in your AngularJS app: + +1. Download the latest bundle from the [Github releases](https://github.com/danielsogl/awesome-cordova-plugins/releases) page. +2. Include it in `index.html` before your app's code. +3. Inject `ionic.native` module in your app. +4. Inject any plugin you would like to use with a `$cordova` prefix. + +```js +angular.module('myApp', ['ionic.native']).controller('MyPageController', function ($cordovaCamera) { + $cordovaCamera.getPicture().then( + function (data) { + console.log('Took a picture!', data); + }, + function (err) { + console.log('Error occurred while taking a picture', err); + } + ); +}); +``` + +#### Vanilla JS + +To use Awesome Cordova Plugins in any other setup: + +1. Download the latest bundle from the [Github releases](https://github.com/danielsogl/awesome-cordova-plugins/releases) page. +2. Include it in `index.html` before your app's code. +3. Access any plugin using the global `IonicNative` variable. + +```js +document.addEventListener('deviceready', function () { + IonicNative.Camera.getPicture().then( + function (data) { + console.log('Took a picture!', data); + }, + function (err) { + console.log('Error occurred while taking a picture', err); + } + ); +}); +``` + +### Mocking and Browser Development (Ionic/Angular apps only) + +Awesome Cordova Plugins makes it possible to mock plugins and develop nearly the entirety of your app in the browser or in `ionic serve`. + +To do this, you need to provide a mock implementation of the plugins you wish to use. Here's an example of mocking the `Camera` plugin to return a stock image while in development: + +First import the `Camera` class in your `src/app/app.module.ts` file: + +```typescript +import { Camera } from '@awesome-cordova-plugins/camera/ngx'; +``` + +Then create a new class that extends the `Camera` class with a mock implementation: + +```typescript +class CameraMock extends Camera { + getPicture(options) { + return new Promise((resolve, reject) => { + resolve('BASE_64_ENCODED_DATA_GOES_HERE'); + }); + } +} +``` + +Finally, override the previous `Camera` class in your `providers` for this module: + +```typescript +providers: [{ provide: Camera, useClass: CameraMock }]; +``` + +Here's the full example: + +```typescript +import { ErrorHandler, NgModule } from '@angular/core'; +import { BrowserModule } from '@angular/platform-browser'; +import { IonicApp, IonicModule, IonicErrorHandler } from 'ionic-angular'; +import { MyApp } from './app.component'; +import { HomePage } from '../pages/home/home'; + +import { Camera } from '@awesome-cordova-plugins/camera/ngx'; + +import { HomePage } from '../pages/home/home'; +import { MyApp } from './app.component'; + +class CameraMock extends Camera { + getPicture(options) { + return new Promise((resolve, reject) => { + resolve('BASE_64_ENCODED_DATA_GOES_HERE'); + }); + } +} + +@NgModule({ + declarations: [MyApp, HomePage], + imports: [BrowserModule, IonicModule.forRoot(MyApp)], + bootstrap: [IonicApp], + entryComponents: [MyApp, HomePage], + providers: [ + { provide: ErrorHandler, useClass: IonicErrorHandler }, + { provide: Camera, useClass: CameraMock }, + ], +}) +export class AppModule {} +``` + +### Runtime Diagnostics + +Spent way too long diagnosing an issue only to realize a plugin wasn't firing or installed? Awesome Cordova Plugins lets you know what the issue is and how you can resolve it. + +![img](https://ionic-io-assets.s3.amazonaws.com/ionic-native-console.png) + +## Plugin Missing? + +Let us know or submit a PR! Take a look at [the Developer Guide](https://github.com/danielsogl/awesome-cordova-plugins/blob/master/DEVELOPER.md) for more on how to contribute. :heart: + +# Credits + +Ibby Hadeed - [@ihadeed](https://github.com/ihadeed) + +Daniel Sogl - [@sogldaniel](https://twitter.com/sogldaniel) + +Tim Lancina - [@timlancina](https://twitter.com/timlancina) + +Mike Hartington - [@mhartington](https://twitter.com/mhartington) + +Max Lynch - [@maxlynch](https://twitter.com/maxlynch) + +Rob Wormald - [@robwormald](https://twitter.com/robwormald) diff --git a/docs/plugins/crop-plugin-privacy/README.md b/docs/plugins/crop-plugin-privacy/README.md index c8af19032..cadcb5270 100644 --- a/docs/plugins/crop-plugin-privacy/README.md +++ b/docs/plugins/crop-plugin-privacy/README.md @@ -14,6 +14,4 @@ This plugin does something ## Supported platforms - Android - - diff --git a/docs/plugins/custom-ui-sdk/README.md b/docs/plugins/custom-ui-sdk/README.md new file mode 100644 index 000000000..4d95fee22 --- /dev/null +++ b/docs/plugins/custom-ui-sdk/README.md @@ -0,0 +1,15 @@ +# CustomUiSdk + +``` +$ +$ npm install @awesome-cordova-plugins/custom-ui-sdk +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/custom-ui-sdk/) + +This plugin is used to access Paytmpayments native CustomUiSdk framework's apis. + +## Supported platforms + +- Android, iOS + diff --git a/docs/plugins/custom-uisdk/README.md b/docs/plugins/custom-uisdk/README.md index 91b773a36..8bafa09ef 100644 --- a/docs/plugins/custom-uisdk/README.md +++ b/docs/plugins/custom-uisdk/README.md @@ -1,7 +1,7 @@ # CustomUISDK ``` -$ '' +$ $ npm install @awesome-cordova-plugins/custom-uisdk ``` @@ -14,6 +14,4 @@ This plugin is used to access Paytm's native CustomUISDK framework's apis. ## Supported platforms - Android, iOS - - diff --git a/docs/plugins/deeplinks/README.md b/docs/plugins/deeplinks/README.md index 80abfe4b2..5ae2e470c 100644 --- a/docs/plugins/deeplinks/README.md +++ b/docs/plugins/deeplinks/README.md @@ -18,8 +18,6 @@ You must add `universal-links` to your `config.xml` and set up Apple App Site As ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/device-accounts/README.md b/docs/plugins/device-accounts/README.md index fde125579..593194b88 100644 --- a/docs/plugins/device-accounts/README.md +++ b/docs/plugins/device-accounts/README.md @@ -14,6 +14,4 @@ Gets the Google accounts associated with the Android device ## Supported platforms - Android - - diff --git a/docs/plugins/device-motion/README.md b/docs/plugins/device-motion/README.md index d79ffefcf..cd92b2f07 100644 --- a/docs/plugins/device-motion/README.md +++ b/docs/plugins/device-motion/README.md @@ -14,14 +14,12 @@ Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please s ## Supported platforms - Android - - BlackBerry 10 - - Browser - - Firefox OS - - iOS - - Tizen - - Ubuntu - - Windows - - Windows Phone 8 - - +- BlackBerry 10 +- Browser +- Firefox OS +- iOS +- Tizen +- Ubuntu +- Windows +- Windows Phone 8 diff --git a/docs/plugins/device-orientation/README.md b/docs/plugins/device-orientation/README.md index 4adc83e34..a90e540d0 100644 --- a/docs/plugins/device-orientation/README.md +++ b/docs/plugins/device-orientation/README.md @@ -14,15 +14,13 @@ Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, ple ## Supported platforms - Amazon Fire OS - - Android - - BlackBerry 10 - - Browser - - Firefox OS - - iOS - - Tizen - - Ubuntu - - Windows - - Windows Phone - - +- Android +- BlackBerry 10 +- Browser +- Firefox OS +- iOS +- Tizen +- Ubuntu +- Windows +- Windows Phone diff --git a/docs/plugins/device/README.md b/docs/plugins/device/README.md index e06d26401..5530b65ca 100644 --- a/docs/plugins/device/README.md +++ b/docs/plugins/device/README.md @@ -14,10 +14,8 @@ Access information about the underlying device and platform. ## Supported platforms - Android - - Browser - - iOS - - macOS - - Windows - - +- Browser +- iOS +- macOS +- Windows diff --git a/docs/plugins/dfu-update/README.md b/docs/plugins/dfu-update/README.md index 1abd2d7c6..364cfc889 100644 --- a/docs/plugins/dfu-update/README.md +++ b/docs/plugins/dfu-update/README.md @@ -14,7 +14,5 @@ This plugin is a Wrapper to use Nordic Semiconductor's Device Firmware Update (D ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/diagnostic/README.md b/docs/plugins/diagnostic/README.md index cf77b4ff7..7e7aee797 100644 --- a/docs/plugins/diagnostic/README.md +++ b/docs/plugins/diagnostic/README.md @@ -14,8 +14,6 @@ Checks whether device hardware features are enabled or available to the app, e.g ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/dialogs/README.md b/docs/plugins/dialogs/README.md index 5d56427c8..69d804490 100644 --- a/docs/plugins/dialogs/README.md +++ b/docs/plugins/dialogs/README.md @@ -16,10 +16,8 @@ Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/dns/README.md b/docs/plugins/dns/README.md index e4c7b6f55..f48d02456 100644 --- a/docs/plugins/dns/README.md +++ b/docs/plugins/dns/README.md @@ -14,6 +14,4 @@ A plugin for Apache Cordova that enables applications to manually resolve hostna ## Supported platforms - Android - - diff --git a/docs/plugins/document-picker/README.md b/docs/plugins/document-picker/README.md index a916763c2..869626410 100644 --- a/docs/plugins/document-picker/README.md +++ b/docs/plugins/document-picker/README.md @@ -15,6 +15,4 @@ Allows the user to upload files from iCloud ## Supported platforms - iOS - - diff --git a/docs/plugins/document-scanner/README.md b/docs/plugins/document-scanner/README.md index adecef241..fed5dc007 100644 --- a/docs/plugins/document-scanner/README.md +++ b/docs/plugins/document-scanner/README.md @@ -14,7 +14,5 @@ This plugin processes images of documents, compensating for perspective. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/document-viewer/README.md b/docs/plugins/document-viewer/README.md index 3063c1302..97a080757 100644 --- a/docs/plugins/document-viewer/README.md +++ b/docs/plugins/document-viewer/README.md @@ -14,8 +14,6 @@ This plugin offers a slim API to view PDF files which are either stored in the a ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/downloader/README.md b/docs/plugins/downloader/README.md new file mode 100644 index 000000000..59b3549b1 --- /dev/null +++ b/docs/plugins/downloader/README.md @@ -0,0 +1,17 @@ +# Document Downloader + +``` +$ ionic cordova plugin add integrator-cordova-plugin-downloader +$ npm install @awesome-cordova-plugins/downloader +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/downloader/) + +Plugin Repo: [https://github.com/Luka313/integrator-cordova-plugin-downloader.git](https://github.com/Luka313/integrator-cordova-plugin-downloader.git) + +This plugin is designed to support downloading files using Android DownloadManager. + +## Supported platforms + +- Android + diff --git a/docs/plugins/dynamsoft-barcode-scanner/README.md b/docs/plugins/dynamsoft-barcode-scanner/README.md index 166ea0124..720b892be 100755 --- a/docs/plugins/dynamsoft-barcode-scanner/README.md +++ b/docs/plugins/dynamsoft-barcode-scanner/README.md @@ -1,7 +1,7 @@ # dynamsoft-barcode-scanner ``` -$ '' +$ $ npm install @awesome-cordova-plugins/dynamsoft-barcode-scanner ``` @@ -14,7 +14,5 @@ This plugin scans barcodes using Dynamsoft Barcode Reader ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/email-composer/README.md b/docs/plugins/email-composer/README.md index 1ee78954c..4742307a9 100644 --- a/docs/plugins/email-composer/README.md +++ b/docs/plugins/email-composer/README.md @@ -14,11 +14,9 @@ Requires Cordova plugin: cordova-plugin-email-composer. For more info, please se ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - macOS - - +- Android +- Browser +- iOS +- Windows +- macOS diff --git a/docs/plugins/fabric/README.md b/docs/plugins/fabric/README.md index 6b0435dc4..0d894a505 100644 --- a/docs/plugins/fabric/README.md +++ b/docs/plugins/fabric/README.md @@ -1,4 +1,4 @@ -# Crashlytics +# Answers ``` $ ionic cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx @@ -9,14 +9,12 @@ $ npm install @awesome-cordova-plugins/fabric Plugin Repo: [https://www.npmjs.com/package/cordova-fabric-plugin](https://www.npmjs.com/package/cordova-fabric-plugin) -API for interacting with the Crashlytics kit. +API for interacting with the Answers kit. https://docs.fabric.io/crashlytics/index.html ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/facebook/README.md b/docs/plugins/facebook/README.md index db825c8b0..b17b361ce 100644 --- a/docs/plugins/facebook/README.md +++ b/docs/plugins/facebook/README.md @@ -77,8 +77,6 @@ For tracking events, see `logEvent` and `logPurchase`. ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/fbsdk/README.md b/docs/plugins/fbsdk/README.md index cecd17751..41b9ce648 100644 --- a/docs/plugins/fbsdk/README.md +++ b/docs/plugins/fbsdk/README.md @@ -82,8 +82,6 @@ For tracking events, see `logEvent` and `logPurchase`. ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/fcm/README.md b/docs/plugins/fcm/README.md index 19da035ea..ee3fa6c7b 100644 --- a/docs/plugins/fcm/README.md +++ b/docs/plugins/fcm/README.md @@ -14,7 +14,5 @@ Provides basic functionality for Firebase Cloud Messaging ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/ffmpeg/README.md b/docs/plugins/ffmpeg/README.md index 7605c0e79..66a8b93b3 100644 --- a/docs/plugins/ffmpeg/README.md +++ b/docs/plugins/ffmpeg/README.md @@ -14,7 +14,5 @@ Simple plugin that binds mobile ffmpeg to execute ffmpeg commands ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/file-chooser/README.md b/docs/plugins/file-chooser/README.md index 9217d24a1..51171718e 100644 --- a/docs/plugins/file-chooser/README.md +++ b/docs/plugins/file-chooser/README.md @@ -14,6 +14,4 @@ Cordova FileChooser Plugin ## Supported platforms - Android - - diff --git a/docs/plugins/file-md5/README.md b/docs/plugins/file-md5/README.md index 22ba9c86c..1538c0a96 100644 --- a/docs/plugins/file-md5/README.md +++ b/docs/plugins/file-md5/README.md @@ -14,7 +14,5 @@ This plugin reads large files in chunks and build the md5sum incrementally. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/file-opener/README.md b/docs/plugins/file-opener/README.md index 137c7495c..034428477 100644 --- a/docs/plugins/file-opener/README.md +++ b/docs/plugins/file-opener/README.md @@ -14,9 +14,7 @@ This plugin will open a file on your device file system with its default applica ## Supported platforms - Android - - iOS - - Windows - - Windows Phone 8 - - +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/file-path/README.md b/docs/plugins/file-path/README.md index 2e9f7462e..15cb28a52 100644 --- a/docs/plugins/file-path/README.md +++ b/docs/plugins/file-path/README.md @@ -14,6 +14,4 @@ This plugin allows you to resolve the native filesystem path for Android content ## Supported platforms - Android - - diff --git a/docs/plugins/file-transfer/README.md b/docs/plugins/file-transfer/README.md index 926ff889f..b94f6be57 100644 --- a/docs/plugins/file-transfer/README.md +++ b/docs/plugins/file-transfer/README.md @@ -14,12 +14,10 @@ This plugin allows you to upload and download files. ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Ubuntu - - Windows - - Windows Phone - - +- Android +- Browser +- iOS +- Ubuntu +- Windows +- Windows Phone diff --git a/docs/plugins/file/README.md b/docs/plugins/file/README.md index 9d0a00bbe..5156ccfe1 100644 --- a/docs/plugins/file/README.md +++ b/docs/plugins/file/README.md @@ -35,10 +35,8 @@ this.file.checkDir(this.file.dataDirectory, 'mydir').then(_ => console.log('Dire ## Supported platforms - Android - - Browser - - iOS - - macOS - - Windows - - +- Browser +- iOS +- macOS +- Windows diff --git a/docs/plugins/fingerprint-aio/README.md b/docs/plugins/fingerprint-aio/README.md index acbec1476..b82529aed 100644 --- a/docs/plugins/fingerprint-aio/README.md +++ b/docs/plugins/fingerprint-aio/README.md @@ -15,7 +15,5 @@ Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plu ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-analytics/README.md b/docs/plugins/firebase-analytics/README.md index b8144a09a..9d2dc7cad 100644 --- a/docs/plugins/firebase-analytics/README.md +++ b/docs/plugins/firebase-analytics/README.md @@ -1,12 +1,5 @@ # Firebase Analytics -

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

- - ``` $ ionic cordova plugin add cordova-plugin-firebase-analytics $ npm install @awesome-cordova-plugins/firebase-analytics @@ -41,7 +34,5 @@ And in the same file, you'll have to add `xmlns:tools="http://schemas.android.co ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-authentication/README.md b/docs/plugins/firebase-authentication/README.md index 44926a90b..1ebb3d360 100644 --- a/docs/plugins/firebase-authentication/README.md +++ b/docs/plugins/firebase-authentication/README.md @@ -14,7 +14,5 @@ Cordova plugin for Firebase Authentication ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-config/README.md b/docs/plugins/firebase-config/README.md index a18dd257c..a25b52c13 100644 --- a/docs/plugins/firebase-config/README.md +++ b/docs/plugins/firebase-config/README.md @@ -1,12 +1,5 @@ # Firebase Config -

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

- - ``` $ ionic cordova plugin add cordova-plugin-firebase-config $ npm install @awesome-cordova-plugins/firebase-config @@ -21,7 +14,5 @@ Cordova plugin for Firebase Config ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-crash/README.md b/docs/plugins/firebase-crash/README.md index 9b8f72fc3..99b56790f 100644 --- a/docs/plugins/firebase-crash/README.md +++ b/docs/plugins/firebase-crash/README.md @@ -14,7 +14,5 @@ This plugin brings crash reporting from Google Firebase to your Cordova project! ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-crashlytics/README.md b/docs/plugins/firebase-crashlytics/README.md index a5ff503b2..b68d69cf5 100644 --- a/docs/plugins/firebase-crashlytics/README.md +++ b/docs/plugins/firebase-crashlytics/README.md @@ -14,7 +14,5 @@ A Google Firebase Crashlytics plugin to enable capture of crash reports. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-dynamic-links/README.md b/docs/plugins/firebase-dynamic-links/README.md index 10217acc3..b3e1f9802 100644 --- a/docs/plugins/firebase-dynamic-links/README.md +++ b/docs/plugins/firebase-dynamic-links/README.md @@ -1,12 +1,5 @@ # Firebase Dynamic Links -

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

- - ``` $ ionic cordova plugin add cordova-plugin-firebase-dynamiclinks --save --variable APP_DOMAIN="example.com" --variable APP_PATH="/" $ npm install @awesome-cordova-plugins/firebase-dynamic-links @@ -39,7 +32,5 @@ config.xml: ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-messaging/README.md b/docs/plugins/firebase-messaging/README.md index c75f0343f..13b466721 100644 --- a/docs/plugins/firebase-messaging/README.md +++ b/docs/plugins/firebase-messaging/README.md @@ -1,12 +1,5 @@ # Firebase Messaging -

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

- - ``` $ ionic cordova plugin add cordova-plugin-firebase-messaging $ npm install @awesome-cordova-plugins/firebase-messaging @@ -21,7 +14,5 @@ Cordova plugin for Firebase Messaging ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-model/README.md b/docs/plugins/firebase-model/README.md index 3ca641076..d741b5c42 100644 --- a/docs/plugins/firebase-model/README.md +++ b/docs/plugins/firebase-model/README.md @@ -1,14 +1,12 @@ -# FirebaseModelInput -Result -t -cordova plugin add cordova-plugin-firebase-model +# Firebase Model + +``` +$ ionic cordova plugin add cordova-plugin-firebase-model $ npm install @awesome-cordova-plugins/firebase-model ``` ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/firebase-model/) -Plugin Repo: ['']('') - This plugin downloads the TensorFlow model from firebase and classify the images. ```typescript @@ -40,6 +38,4 @@ catch (e) { ## Supported platforms - iOS - - diff --git a/docs/plugins/firebase-vision/README.md b/docs/plugins/firebase-vision/README.md index 59173966e..763e61755 100644 --- a/docs/plugins/firebase-vision/README.md +++ b/docs/plugins/firebase-vision/README.md @@ -14,7 +14,5 @@ Cordova plugin for Firebase MLKit Vision ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-x/README.md b/docs/plugins/firebase-x/README.md index 716a7aa2d..fa0c50153 100644 --- a/docs/plugins/firebase-x/README.md +++ b/docs/plugins/firebase-x/README.md @@ -15,7 +15,5 @@ It is a maintained fork from unmaintained ionic-navite plugin called Firebase. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase/README.md b/docs/plugins/firebase/README.md index 86efe703b..ca130b873 100644 --- a/docs/plugins/firebase/README.md +++ b/docs/plugins/firebase/README.md @@ -14,7 +14,5 @@ This plugin brings push notifications, analytics, event tracking, crash reportin ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/flashlight/README.md b/docs/plugins/flashlight/README.md index 1b0377b1f..b05a90a32 100644 --- a/docs/plugins/flashlight/README.md +++ b/docs/plugins/flashlight/README.md @@ -16,8 +16,6 @@ Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/foreground-service/README.md b/docs/plugins/foreground-service/README.md index 360bf2325..7bf15d204 100644 --- a/docs/plugins/foreground-service/README.md +++ b/docs/plugins/foreground-service/README.md @@ -27,6 +27,4 @@ For android API 28+, the following xml snippet should be inserted into ```config ## Supported platforms - Android - - diff --git a/docs/plugins/ftp/README.md b/docs/plugins/ftp/README.md index 540302252..c53359fa6 100644 --- a/docs/plugins/ftp/README.md +++ b/docs/plugins/ftp/README.md @@ -14,7 +14,5 @@ This cordova plugin is created to use ftp (client) in web/js. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/gao-de-location/README.md b/docs/plugins/gao-de-location/README.md index b0fb1097c..3360bfad4 100644 --- a/docs/plugins/gao-de-location/README.md +++ b/docs/plugins/gao-de-location/README.md @@ -15,7 +15,5 @@ Gaode location can directly return address informationGaode location can directl ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/gcdwebserver/README.md b/docs/plugins/gcdwebserver/README.md index 78792d815..3c1de1538 100755 --- a/docs/plugins/gcdwebserver/README.md +++ b/docs/plugins/gcdwebserver/README.md @@ -1,7 +1,7 @@ # gcdwebserver ``` -$ '' +$ $ npm install @awesome-cordova-plugins/gcdwebserver ``` @@ -14,6 +14,4 @@ This plugin can start an HTTP server using GCDWebServer ## Supported platforms - iOS - - diff --git a/docs/plugins/ge-tui-sdk-plugin/README.md b/docs/plugins/ge-tui-sdk-plugin/README.md index 407689c90..5d773bb57 100644 --- a/docs/plugins/ge-tui-sdk-plugin/README.md +++ b/docs/plugins/ge-tui-sdk-plugin/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/genius-scan/README.md b/docs/plugins/genius-scan/README.md new file mode 100644 index 000000000..b4ddabcae --- /dev/null +++ b/docs/plugins/genius-scan/README.md @@ -0,0 +1,16 @@ +# Genius Scan + +``` +$ ionic cordova plugin add @thegrizzlylabs/cordova-plugin-genius-scan +$ npm install @awesome-cordova-plugins/genius-scan +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/genius-scan/) + +Plugin allows you to access the Genius Scan SDK core features from a Ionic application + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/geolocation/README.md b/docs/plugins/geolocation/README.md index fa4ffc056..965f64710 100644 --- a/docs/plugins/geolocation/README.md +++ b/docs/plugins/geolocation/README.md @@ -23,10 +23,8 @@ For iOS you have to add this configuration to your configuration.xml file ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/globalization/README.md b/docs/plugins/globalization/README.md index 5277ea797..6f0db4985 100644 --- a/docs/plugins/globalization/README.md +++ b/docs/plugins/globalization/README.md @@ -14,10 +14,8 @@ This plugin obtains information and performs operations specific to the user's l ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/google-analytics/README.md b/docs/plugins/google-analytics/README.md index 7245356e8..191b3ad13 100644 --- a/docs/plugins/google-analytics/README.md +++ b/docs/plugins/google-analytics/README.md @@ -18,9 +18,7 @@ Prerequisites: ## Supported platforms - Android - - Browser - - iOS - - Windows Phone 8 - - +- Browser +- iOS +- Windows Phone 8 diff --git a/docs/plugins/google-nearby/README.md b/docs/plugins/google-nearby/README.md index 87778e95e..2d21e68e0 100644 --- a/docs/plugins/google-nearby/README.md +++ b/docs/plugins/google-nearby/README.md @@ -14,6 +14,4 @@ This plugin adds support for the Google Nearby Messages API. ## Supported platforms - Android - - diff --git a/docs/plugins/google-plus/README.md b/docs/plugins/google-plus/README.md index a3fab1964..611d01fc4 100644 --- a/docs/plugins/google-plus/README.md +++ b/docs/plugins/google-plus/README.md @@ -9,12 +9,8 @@ $ npm install @awesome-cordova-plugins/google-plus Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) - - ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/header-color/README.md b/docs/plugins/header-color/README.md index c8fbccb90..4be58fdf3 100644 --- a/docs/plugins/header-color/README.md +++ b/docs/plugins/header-color/README.md @@ -14,6 +14,4 @@ Cordova plugin to change color of header in Android Multitask View ## Supported platforms - Android - - diff --git a/docs/plugins/health-kit/README.md b/docs/plugins/health-kit/README.md index 8b8a7bdf1..95562faf9 100644 --- a/docs/plugins/health-kit/README.md +++ b/docs/plugins/health-kit/README.md @@ -15,6 +15,4 @@ Any data saved shows up in the iOS Health app and is available for other iOS app ## Supported platforms - iOS - - diff --git a/docs/plugins/health/README.md b/docs/plugins/health/README.md index d2bac2c06..97b5b0a72 100644 --- a/docs/plugins/health/README.md +++ b/docs/plugins/health/README.md @@ -14,7 +14,5 @@ A plugin that abstracts fitness and health repositories like Apple HealthKit or ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/http/README.md b/docs/plugins/http/README.md index be1ec56d4..b78eed033 100644 --- a/docs/plugins/http/README.md +++ b/docs/plugins/http/README.md @@ -19,7 +19,5 @@ Advantages over Javascript requests: ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/hyper-track/README.md b/docs/plugins/hyper-track/README.md index d1a04f840..1d4febf12 100644 --- a/docs/plugins/hyper-track/README.md +++ b/docs/plugins/hyper-track/README.md @@ -1,6 +1,7 @@ -# Coordinates -alidationError -ic cordova plugin add cordova-plugin-hypertrack-v3 +# HyperTrackPlugin + +``` +$ ionic cordova plugin add cordova-plugin-hypertrack-v3 $ npm install @awesome-cordova-plugins/hyper-track ``` @@ -8,11 +9,7 @@ $ npm install @awesome-cordova-plugins/hyper-track Plugin Repo: [https://github.com/hypertrack/cordova-plugin-hypertrack.git](https://github.com/hypertrack/cordova-plugin-hypertrack.git) - - ## Supported platforms - Android, iOS - - diff --git a/docs/plugins/i-root/README.md b/docs/plugins/i-root/README.md index 403364d54..b6a7cf0fb 100644 --- a/docs/plugins/i-root/README.md +++ b/docs/plugins/i-root/README.md @@ -1,36 +1,18 @@ # IRoot -```text -$ ionic cordova plugin add cordova-plugin-iroot +``` +$ ionic cordova plugin add cordova-plugin-IRoot $ npm install @awesome-cordova-plugins/i-root ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/iroot/) +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/i-root/) -Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-iroot](https://github.com/WuglyakBolgoink/cordova-plugin-iroot) +Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-IRoot](https://github.com/WuglyakBolgoink/cordova-plugin-IRoot) Use this plugin to add an extra layer of security for your app by detecting if the device was rooted (on android) or jailbreaked (on iOS). ## Supported platforms -* Android -* iOS +- Android +- iOS -## Original Plugin Notes - -### iOS - Postinstall - -To avoid errors like - -> -canOpenURL: failed for URL: "cydia://package/com.example.package" - error: "This app is not allowed to query for scheme cydia" - -don’t forget to add `"cydia"` in `LSApplicationQueriesSchemes` key of `info.plist`. Otherwise `canOpenURL` will always return `false`. - -```xml - - LSApplicationQueriesSchemes - - cydia - - -``` \ No newline at end of file diff --git a/docs/plugins/iamport-cordova/README.md b/docs/plugins/iamport-cordova/README.md index 01f8a36c0..4d1976bed 100644 --- a/docs/plugins/iamport-cordova/README.md +++ b/docs/plugins/iamport-cordova/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - ios - - android - - +- android diff --git a/docs/plugins/ibeacon/README.md b/docs/plugins/ibeacon/README.md index 572c9fc5d..ad25a3d81 100644 --- a/docs/plugins/ibeacon/README.md +++ b/docs/plugins/ibeacon/README.md @@ -16,7 +16,5 @@ This plugin provides functions for working with iBeacons. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/image-picker/README.md b/docs/plugins/image-picker/README.md index 3f20f40d0..cfd15f186 100644 --- a/docs/plugins/image-picker/README.md +++ b/docs/plugins/image-picker/README.md @@ -17,7 +17,5 @@ For more info, please see the https://github.com/Telerik-Verified-Plugins/ImageP ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/image-resizer/README.md b/docs/plugins/image-resizer/README.md index 014d76de3..8eb399248 100644 --- a/docs/plugins/image-resizer/README.md +++ b/docs/plugins/image-resizer/README.md @@ -14,7 +14,5 @@ Cordova Plugin For Image Resize ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/imap/README.md b/docs/plugins/imap/README.md index 6aabbab07..3bab511a8 100644 --- a/docs/plugins/imap/README.md +++ b/docs/plugins/imap/README.md @@ -16,7 +16,5 @@ To enable the IMAP features on Android, this plugin uses the framework [Java Mai ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/in-app-browser/README.md b/docs/plugins/in-app-browser/README.md index d3ff44aa3..f9bc43f34 100644 --- a/docs/plugins/in-app-browser/README.md +++ b/docs/plugins/in-app-browser/README.md @@ -14,11 +14,9 @@ Launches in app Browser ## Supported platforms - AmazonFire OS - - Android - - Browser - - iOS - - macOS - - Windows - - +- Android +- Browser +- iOS +- macOS +- Windows diff --git a/docs/plugins/in-app-purchase-2/README.md b/docs/plugins/in-app-purchase-2/README.md index 5eaf00432..af69b12f7 100644 --- a/docs/plugins/in-app-purchase-2/README.md +++ b/docs/plugins/in-app-purchase-2/README.md @@ -33,12 +33,11 @@ Supports: - **macOS** version 10 - **Xbox One** - (and any platform supporting Microsoft's UWP) + - **cordova-plugin-purchase** version 12 or lower. ## Supported platforms - iOS - - Android - - Windows - - +- Android +- Windows diff --git a/docs/plugins/in-app-purchase-3/README.md b/docs/plugins/in-app-purchase-3/README.md new file mode 100644 index 000000000..ea68500e7 --- /dev/null +++ b/docs/plugins/in-app-purchase-3/README.md @@ -0,0 +1,45 @@ +# "In App Purchase 3" + +``` +$ ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="" +$ npm install @awesome-cordova-plugins/in-app-purchase-3 +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/in-app-purchase-3/) + +Plugin Repo: [https://github.com/j3k0/cordova-plugin-purchase](https://github.com/j3k0/cordova-plugin-purchase) + +In-App Purchase on iOS, Android, Windows, macOS and XBox. + +This plugin replace the previous InAppPurchase2, due to backward compatibility issue with the wrapped +cordova-plugin-purchase version 13.0 + +## Features + +| | ios | android | win-8 | win-10/uwp | mac | +|--|--|--|--|--|--| +| consumables | ✅ | ✅ | ✅ | ✅ | ✅ | +| non consumables | ✅ | ✅ | ✅ | ✅ | ✅ | +| subscriptions | ✅ | ✅ | ✅ | ✅ | ✅ | +| restore purchases | ✅ | ✅ | ✅ | ✅ | ✅ | +| receipt validations | ✅ | ✅ | | ✅ | ✅ | +| introductory prices | ✅ | ✅ | | ✅ | ✅ | + +Supports: + + - **iOS** version 7.0 or higher. + - **Android** version 2.2 (API level 8) or higher + - with Google Play client version 3.9.16 or higher + - **Windows** Store/Phone 8.1 or higher + - **Windows 10 Mobile** + - **macOS** version 10 + - **Xbox One** + - (and any platform supporting Microsoft's UWP) + - **cordova-plugin-purchase** version 13.0 or higher + +## Supported platforms + +- iOS +- Android +- Windows + diff --git a/docs/plugins/in-app-review/README.md b/docs/plugins/in-app-review/README.md index 124b4e0a7..730511f99 100644 --- a/docs/plugins/in-app-review/README.md +++ b/docs/plugins/in-app-review/README.md @@ -16,6 +16,4 @@ This functionality only works on iOS devices ## Supported platforms - iOS - - diff --git a/docs/plugins/in-app-update/README.md b/docs/plugins/in-app-update/README.md index 7d42a034c..0a38f2305 100644 --- a/docs/plugins/in-app-update/README.md +++ b/docs/plugins/in-app-update/README.md @@ -14,6 +14,4 @@ This pluging enabels In app update For cordova. ## Supported platforms - Android - - diff --git a/docs/plugins/insomnia/README.md b/docs/plugins/insomnia/README.md index e01a73b63..4f5174097 100644 --- a/docs/plugins/insomnia/README.md +++ b/docs/plugins/insomnia/README.md @@ -14,11 +14,9 @@ Prevent the screen of the mobile device from falling asleep. ## Supported platforms - Android - - Browser - - Firefox OS - - iOS - - Windows - - Windows Phone 8 - - +- Browser +- Firefox OS +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/instagram/README.md b/docs/plugins/instagram/README.md index e38252b85..4ecf2abe8 100644 --- a/docs/plugins/instagram/README.md +++ b/docs/plugins/instagram/README.md @@ -14,7 +14,5 @@ Share a photo with the instagram app ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/intercom/README.md b/docs/plugins/intercom/README.md index a4b8fde70..6acb1b065 100644 --- a/docs/plugins/intercom/README.md +++ b/docs/plugins/intercom/README.md @@ -10,12 +10,10 @@ $ npm install @awesome-cordova-plugins/intercom Plugin Repo: [https://github.com/intercom/intercom-cordova](https://github.com/intercom/intercom-cordova) This is a plugin that allows your Ionic app to use Intercom for iOS and/or Intercom for Android. -Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/docs/cordova-phonegap-configuration +Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/installing-intercom/cordova-phonegap/installation ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/ionic-webview/README.md b/docs/plugins/ionic-webview/README.md index 08878b553..0004c7221 100644 --- a/docs/plugins/ionic-webview/README.md +++ b/docs/plugins/ionic-webview/README.md @@ -16,7 +16,5 @@ Requires the Cordova plugin: `cordova-plugin-ionic-webview` > 2.0. For more info ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/ios-aswebauthenticationsession-api/README.md b/docs/plugins/ios-aswebauthenticationsession-api/README.md index 7a5072d34..59f230cec 100644 --- a/docs/plugins/ios-aswebauthenticationsession-api/README.md +++ b/docs/plugins/ios-aswebauthenticationsession-api/README.md @@ -14,6 +14,4 @@ Plugin for iOS 12 ASWebAuthenticationSession API ## Supported platforms - iOS - - diff --git a/docs/plugins/is-debug/README.md b/docs/plugins/is-debug/README.md index 32ed04487..af2922955 100644 --- a/docs/plugins/is-debug/README.md +++ b/docs/plugins/is-debug/README.md @@ -15,7 +15,5 @@ Debug mode is when the app is built and installed locally via xcode / eclipse / ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/keyboard/README.md b/docs/plugins/keyboard/README.md index 46937c76c..dd5fee778 100644 --- a/docs/plugins/keyboard/README.md +++ b/docs/plugins/keyboard/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-ionic-keyboard`. For more info, please ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/keychain/README.md b/docs/plugins/keychain/README.md index 1d9de930c..619963407 100644 --- a/docs/plugins/keychain/README.md +++ b/docs/plugins/keychain/README.md @@ -18,6 +18,4 @@ See also [Secure Storage](https://ionic.io/docs/secure-storage) for more support ## Supported platforms - iOS - - diff --git a/docs/plugins/kommunicate/README.md b/docs/plugins/kommunicate/README.md index 685082944..1c968faa3 100644 --- a/docs/plugins/kommunicate/README.md +++ b/docs/plugins/kommunicate/README.md @@ -17,8 +17,6 @@ For documentation: TODO: insert link ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/launch-navigator/README.md b/docs/plugins/launch-navigator/README.md index 5cc233acb..655a7698e 100644 --- a/docs/plugins/launch-navigator/README.md +++ b/docs/plugins/launch-navigator/README.md @@ -14,9 +14,7 @@ Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For ## Supported platforms - Android - - iOS - - Windows - - Windows Phone 8 - - +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/launch-review/README.md b/docs/plugins/launch-review/README.md index 1b613a86d..86c3a85a4 100644 --- a/docs/plugins/launch-review/README.md +++ b/docs/plugins/launch-review/README.md @@ -16,7 +16,5 @@ Assists in leaving user reviews/ratings in the App Stores. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/lets-cooee/README.md b/docs/plugins/lets-cooee/README.md index af6fdf122..8e343568f 100644 --- a/docs/plugins/lets-cooee/README.md +++ b/docs/plugins/lets-cooee/README.md @@ -14,7 +14,5 @@ AI driven Personalised Notifications for Better Customer Engagement ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/line-login/README.md b/docs/plugins/line-login/README.md index a5e0ff06d..a0ef91759 100644 --- a/docs/plugins/line-login/README.md +++ b/docs/plugins/line-login/README.md @@ -14,7 +14,5 @@ The function login, logs out, acquires, verifies, and refreshes the access token ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/local-backup/README.md b/docs/plugins/local-backup/README.md index fa08fa3e0..bd28140e9 100644 --- a/docs/plugins/local-backup/README.md +++ b/docs/plugins/local-backup/README.md @@ -14,7 +14,5 @@ This plugin to create local backup ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/local-notifications/README.md b/docs/plugins/local-notifications/README.md index 28fa55f67..c096dccb6 100644 --- a/docs/plugins/local-notifications/README.md +++ b/docs/plugins/local-notifications/README.md @@ -14,8 +14,6 @@ This plugin allows you to display local notifications on the device ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/location-accuracy/README.md b/docs/plugins/location-accuracy/README.md index b4cf410c8..ad95e0f88 100644 --- a/docs/plugins/location-accuracy/README.md +++ b/docs/plugins/location-accuracy/README.md @@ -14,7 +14,5 @@ This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/lottie-splash-screen/README.md b/docs/plugins/lottie-splash-screen/README.md index e312ab473..63299c935 100644 --- a/docs/plugins/lottie-splash-screen/README.md +++ b/docs/plugins/lottie-splash-screen/README.md @@ -1,7 +1,7 @@ # Lottie Splash Screen ``` -$ '' +$ $ npm install @awesome-cordova-plugins/lottie-splash-screen ``` @@ -14,7 +14,5 @@ Cordova plugin to show bodymovin/Lottie animations as the splash screen with Air ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/magnetometer/README.md b/docs/plugins/magnetometer/README.md index 67af5b68c..0bdae01b1 100644 --- a/docs/plugins/magnetometer/README.md +++ b/docs/plugins/magnetometer/README.md @@ -14,7 +14,5 @@ Requires Cordova plugin: `cordova-plugin-magnetometer`. For more info, please se ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/market/README.md b/docs/plugins/market/README.md index 30539a27d..6cf5f5df8 100644 --- a/docs/plugins/market/README.md +++ b/docs/plugins/market/README.md @@ -14,7 +14,5 @@ Opens an app's page in the market place (Google Play, App Store) ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/media-capture/README.md b/docs/plugins/media-capture/README.md index b15a9a63a..d9ac63597 100644 --- a/docs/plugins/media-capture/README.md +++ b/docs/plugins/media-capture/README.md @@ -16,9 +16,7 @@ Requires Cordova plugin: `cordova-plugin-media-capture`. For more info, please s ## Supported platforms - Android - - Browser - - iOS - - Windows - - +- Browser +- iOS +- Windows diff --git a/docs/plugins/media/README.md b/docs/plugins/media/README.md index d16a768e0..554786c46 100644 --- a/docs/plugins/media/README.md +++ b/docs/plugins/media/README.md @@ -14,9 +14,7 @@ This plugin provides the ability to record and play back audio files on a device ## Supported platforms - Android - - Browser - - iOS - - Windows - - +- Browser +- iOS +- Windows diff --git a/docs/plugins/metrix/README.md b/docs/plugins/metrix/README.md index 08d6eb4b6..a249eeca2 100644 --- a/docs/plugins/metrix/README.md +++ b/docs/plugins/metrix/README.md @@ -16,6 +16,4 @@ Requires Cordova plugin: `ir.metrix.sdk`. For more info, please see the [Metrix ## Supported platforms - Android - - diff --git a/docs/plugins/mixpanel/README.md b/docs/plugins/mixpanel/README.md index 7d2f5bb86..092ad90fd 100644 --- a/docs/plugins/mixpanel/README.md +++ b/docs/plugins/mixpanel/README.md @@ -14,8 +14,6 @@ Cordova Plugin that wraps Mixpanel SDK for Android and iOS ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/mlkit-translate/README.md b/docs/plugins/mlkit-translate/README.md index 13ddbe739..755a16aae 100644 --- a/docs/plugins/mlkit-translate/README.md +++ b/docs/plugins/mlkit-translate/README.md @@ -14,7 +14,5 @@ Plugin that implements MLKit Translation and Language Identification features. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/mobile-accessibility/README.md b/docs/plugins/mobile-accessibility/README.md index ebc17bb3e..9c85154f4 100644 --- a/docs/plugins/mobile-accessibility/README.md +++ b/docs/plugins/mobile-accessibility/README.md @@ -1,7 +1,7 @@ # Mobile Accessibility ``` -$ '' +$ $ npm install @awesome-cordova-plugins/mobile-accessibility ``` @@ -15,8 +15,6 @@ It also allows an application to send a string to be spoken by the screen reader ## Supported platforms - Android - - iOS - - Amazon Fire OS - - +- iOS +- Amazon Fire OS diff --git a/docs/plugins/mobile-messaging/README.md b/docs/plugins/mobile-messaging/README.md index acfcfd6ca..190201132 100644 --- a/docs/plugins/mobile-messaging/README.md +++ b/docs/plugins/mobile-messaging/README.md @@ -18,7 +18,5 @@ For more info see [Cordova plugin docs](https://github.com/infobip/mobile-messag ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/multiple-document-picker/README.md b/docs/plugins/multiple-document-picker/README.md index e55890c7f..f28a08371 100644 --- a/docs/plugins/multiple-document-picker/README.md +++ b/docs/plugins/multiple-document-picker/README.md @@ -14,7 +14,5 @@ This plugin allows users to pick multiple documents/images at once ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/music-controls/README.md b/docs/plugins/music-controls/README.md index 4c52a932d..4dcb3fe39 100644 --- a/docs/plugins/music-controls/README.md +++ b/docs/plugins/music-controls/README.md @@ -16,8 +16,6 @@ Handle also headset event (plug, unplug, headset button). ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/native-audio/README.md b/docs/plugins/native-audio/README.md index 5c224a00a..b17a359bf 100644 --- a/docs/plugins/native-audio/README.md +++ b/docs/plugins/native-audio/README.md @@ -14,8 +14,6 @@ Native Audio Playback ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/native-geocoder/README.md b/docs/plugins/native-geocoder/README.md index 0622494a0..993b7385c 100644 --- a/docs/plugins/native-geocoder/README.md +++ b/docs/plugins/native-geocoder/README.md @@ -14,7 +14,5 @@ Cordova plugin for native forward and reverse geocoding ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/native-keyboard/README.md b/docs/plugins/native-keyboard/README.md index 5a306ce97..4c1f54874 100644 --- a/docs/plugins/native-keyboard/README.md +++ b/docs/plugins/native-keyboard/README.md @@ -14,7 +14,5 @@ A cross platform WhatsApp / Messenger / Slack -style keyboard even. For your Cor ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/native-page-transitions/README.md b/docs/plugins/native-page-transitions/README.md index cef92dedb..e48074639 100644 --- a/docs/plugins/native-page-transitions/README.md +++ b/docs/plugins/native-page-transitions/README.md @@ -14,8 +14,6 @@ The Native Page Transitions plugin uses native hardware acceleration to animate ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/native-storage/README.md b/docs/plugins/native-storage/README.md index ff21193e9..65642c601 100644 --- a/docs/plugins/native-storage/README.md +++ b/docs/plugins/native-storage/README.md @@ -14,10 +14,8 @@ Native storage of variables in Android and iOS ## Supported platforms - Android - - Browser - - iOS - - macOS - - Windows - - +- Browser +- iOS +- macOS +- Windows diff --git a/docs/plugins/native-view/README.md b/docs/plugins/native-view/README.md index bdac98fd7..0021cce65 100644 --- a/docs/plugins/native-view/README.md +++ b/docs/plugins/native-view/README.md @@ -9,12 +9,8 @@ $ npm install @awesome-cordova-plugins/native-view Plugin Repo: [https://github.com/mfdeveloper/cordova-plugin-nativeview](https://github.com/mfdeveloper/cordova-plugin-nativeview) - - ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/network-interface/README.md b/docs/plugins/network-interface/README.md index 7c76eadee..18db8ba61 100644 --- a/docs/plugins/network-interface/README.md +++ b/docs/plugins/network-interface/README.md @@ -14,11 +14,9 @@ Network interface information plugin for Cordova/PhoneGap that supports Android, ## Supported platforms - Android - - BlackBerry 10 - - Browser - - iOS - - Windows - - Windows Phone - - +- BlackBerry 10 +- Browser +- iOS +- Windows +- Windows Phone diff --git a/docs/plugins/network-permission/README.md b/docs/plugins/network-permission/README.md new file mode 100644 index 000000000..02f3e570f --- /dev/null +++ b/docs/plugins/network-permission/README.md @@ -0,0 +1,17 @@ +# Network Permission + +``` +$ ionic cordova plugin add cordova-plugin-network-permission +$ npm install @awesome-cordova-plugins/network-permission +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/network-permission/) + +Plugin Repo: [https://github.com/j5int/cordova-plugin-network-permission](https://github.com/j5int/cordova-plugin-network-permission) + +Requires Cordova plugin: cordova-plugin-network-permission. For more info, please see the [Network permission plugin docs](https://github.com/j5int/cordova-plugin-network-permission). + +## Supported platforms + +- iOS + diff --git a/docs/plugins/network/README.md b/docs/plugins/network/README.md index 6634de2eb..239a0ab8c 100644 --- a/docs/plugins/network/README.md +++ b/docs/plugins/network/README.md @@ -14,10 +14,8 @@ Requires Cordova plugin: cordova-plugin-network-information. For more info, plea ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/newrelic/README.md b/docs/plugins/newrelic/README.md index fc7c0dde0..68e9b4ef9 100644 --- a/docs/plugins/newrelic/README.md +++ b/docs/plugins/newrelic/README.md @@ -14,7 +14,5 @@ This NewRelic plugin collect crashes, network traffic, and other information for ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/nfc/README.md b/docs/plugins/nfc/README.md index 158c32e13..191a485c1 100644 --- a/docs/plugins/nfc/README.md +++ b/docs/plugins/nfc/README.md @@ -22,8 +22,6 @@ This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty betwee ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/ocr/README.md b/docs/plugins/ocr/README.md index 54c92c3b2..351c930b5 100644 --- a/docs/plugins/ocr/README.md +++ b/docs/plugins/ocr/README.md @@ -17,7 +17,5 @@ For more info, please see the following Github issue [Google Mobile Vision relyi ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/onesignal/README.md b/docs/plugins/onesignal/README.md index e3c3182aa..37a874f08 100644 --- a/docs/plugins/onesignal/README.md +++ b/docs/plugins/onesignal/README.md @@ -80,9 +80,7 @@ module.exports = function(context) { ## Supported platforms - Amazon Fire OS - - Android - - iOS - - Windows - - +- Android +- iOS +- Windows diff --git a/docs/plugins/open-native-settings/README.md b/docs/plugins/open-native-settings/README.md index 154d34ad3..42140509a 100644 --- a/docs/plugins/open-native-settings/README.md +++ b/docs/plugins/open-native-settings/README.md @@ -14,7 +14,5 @@ Plugin to open native screens of iOS/android settings ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/openalpr/README.md b/docs/plugins/openalpr/README.md index 628c222a5..93a2f668d 100644 --- a/docs/plugins/openalpr/README.md +++ b/docs/plugins/openalpr/README.md @@ -14,7 +14,5 @@ This Cordova plugin adds support for the OpenALPR (Automatic License Plate Recog ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/openinstall/README.md b/docs/plugins/openinstall/README.md new file mode 100644 index 000000000..5b264990a --- /dev/null +++ b/docs/plugins/openinstall/README.md @@ -0,0 +1,16 @@ +# OpenInstall + +``` +$ ionic cordova plugin add cordova-plugin-openinstall +$ npm install @awesome-cordova-plugins/openinstall +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/openinstall/) + +Plugin Repo: [https://github.com/openinstall/cordova-plugin-openinstall](https://github.com/openinstall/cordova-plugin-openinstall) + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/paytabs/README.md b/docs/plugins/paytabs/README.md index 3e1974985..df627da37 100644 --- a/docs/plugins/paytabs/README.md +++ b/docs/plugins/paytabs/README.md @@ -14,7 +14,5 @@ A plugin that allows you to use PayTabs's Native SDKs for Android and iOS. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/pdf-generator/README.md b/docs/plugins/pdf-generator/README.md index c509b032d..4de0e7540 100644 --- a/docs/plugins/pdf-generator/README.md +++ b/docs/plugins/pdf-generator/README.md @@ -14,7 +14,5 @@ Simple plugin to generate (offline) pdf. The plugin transforms HTML to PDF and a ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/photo-library/README.md b/docs/plugins/photo-library/README.md index a62bab122..0d3eb913c 100644 --- a/docs/plugins/photo-library/README.md +++ b/docs/plugins/photo-library/README.md @@ -16,8 +16,6 @@ cdvphotolibrary urls should be trusted by Angular. See plugin homepage to learn ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/photo-viewer/README.md b/docs/plugins/photo-viewer/README.md index b8dfbb078..dbf6ef36e 100644 --- a/docs/plugins/photo-viewer/README.md +++ b/docs/plugins/photo-viewer/README.md @@ -14,7 +14,5 @@ This plugin can display your image in full screen with the ability to pan, zoom, ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/play-install-referrer/README.md b/docs/plugins/play-install-referrer/README.md index 84c768d70..999c515b2 100644 --- a/docs/plugins/play-install-referrer/README.md +++ b/docs/plugins/play-install-referrer/README.md @@ -9,11 +9,7 @@ $ npm install @awesome-cordova-plugins/play-install-referrer Plugin Repo: [https://github.com/swayangjit/cordova-plugin-play-installreferrer](https://github.com/swayangjit/cordova-plugin-play-installreferrer) - - ## Supported platforms - Android - - diff --git a/docs/plugins/pollfish/README.md b/docs/plugins/pollfish/README.md index 1503e4b61..d619f592d 100644 --- a/docs/plugins/pollfish/README.md +++ b/docs/plugins/pollfish/README.md @@ -14,7 +14,5 @@ Pollfish Ionic Native plugin wrapper ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/power-management/README.md b/docs/plugins/power-management/README.md index e5b435cbc..678a77f08 100644 --- a/docs/plugins/power-management/README.md +++ b/docs/plugins/power-management/README.md @@ -15,7 +15,5 @@ It should be used for applications which keep running for a long time without an ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/power-optimization/README.md b/docs/plugins/power-optimization/README.md index d97b8ca92..72ba37f06 100644 --- a/docs/plugins/power-optimization/README.md +++ b/docs/plugins/power-optimization/README.md @@ -15,6 +15,4 @@ The Power Optimization plugin give you android PowerManager methods with cordova ## Supported platforms - Android - - diff --git a/docs/plugins/preview-any-file/README.md b/docs/plugins/preview-any-file/README.md index b6f97ec80..d3513ab17 100644 --- a/docs/plugins/preview-any-file/README.md +++ b/docs/plugins/preview-any-file/README.md @@ -1,7 +1,7 @@ # PreviewAnyFile ``` -$ '' +$ $ npm install @awesome-cordova-plugins/preview-any-file ``` @@ -9,12 +9,8 @@ $ npm install @awesome-cordova-plugins/preview-any-file Plugin Repo: [https://github.com/mostafa-mansour1/previewAnyFile](https://github.com/mostafa-mansour1/previewAnyFile) - - ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/printer/README.md b/docs/plugins/printer/README.md index 4d2359790..564ced9b0 100644 --- a/docs/plugins/printer/README.md +++ b/docs/plugins/printer/README.md @@ -14,8 +14,6 @@ Prints documents or HTML rendered content ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/pspdfkit-cordova/README.md b/docs/plugins/pspdfkit-cordova/README.md index 07b000542..1d01d851d 100644 --- a/docs/plugins/pspdfkit-cordova/README.md +++ b/docs/plugins/pspdfkit-cordova/README.md @@ -14,7 +14,5 @@ The official plugin to use PSPDFKit with Cordova and Ionic. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/purchases/README.md b/docs/plugins/purchases/README.md index bfbab32da..108a0f768 100644 --- a/docs/plugins/purchases/README.md +++ b/docs/plugins/purchases/README.md @@ -48,7 +48,5 @@ or you can remove DEFERRED replacement options from your app. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/push/README.md b/docs/plugins/push/README.md index 76c4ab263..05cfa182a 100644 --- a/docs/plugins/push/README.md +++ b/docs/plugins/push/README.md @@ -18,9 +18,7 @@ For TypeScript users, see the [Push plugin docs about using TypeScript for custo ## Supported platforms - Android - - Browser - - iOS - - Windows - - +- Browser +- iOS +- Windows diff --git a/docs/plugins/pushape-push/README.md b/docs/plugins/pushape-push/README.md index febb77903..c75b49666 100644 --- a/docs/plugins/pushape-push/README.md +++ b/docs/plugins/pushape-push/README.md @@ -12,17 +12,11 @@ Plugin Repo: [https://github.com/gluelabs/pushape-cordova-push](https://github.c Register and receive push notifications. This plugin extends functionalities of Push native plugin in order to use it with Pushape service. -Pushape service: @link https://glue-labs.com/pushape-invio-notifiche-push-ios-android-api-sdk - -Requires Cordova plugin: `pushape-cordova-push`. For more info, please see the [Pushape plugin docs](https://github.com/gluelabs/pushape-cordova-push). - -For TypeScript users, see the [Pushape plugin docs about using TypeScript for custom notifications](https://github.com/gluelabs/pushape-cordova-push/blob/master/docs/PUSHAPE_TYPESCRIPT.md). +Pushape service: ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/safari-view-controller/README.md b/docs/plugins/safari-view-controller/README.md index 098774a1d..cf791593a 100644 --- a/docs/plugins/safari-view-controller/README.md +++ b/docs/plugins/safari-view-controller/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-safariviewcontroller`. For more info, p ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/save-dialog/README.md b/docs/plugins/save-dialog/README.md index d19e9a055..3fa721d63 100644 --- a/docs/plugins/save-dialog/README.md +++ b/docs/plugins/save-dialog/README.md @@ -1,6 +1,6 @@ -# Save Dialog +# SaveDialog -```text +``` $ ionic cordova plugin add cordova-plugin-save-dialog $ npm install @awesome-cordova-plugins/save-dialog ``` @@ -9,12 +9,10 @@ $ npm install @awesome-cordova-plugins/save-dialog Plugin Repo: [https://github.com/Amphiluke/cordova-plugin-save-dialog](https://github.com/Amphiluke/cordova-plugin-save-dialog) -This Cordova plugin displays the native Save dialog which allows users to store a file in the selected location. +Plugin displays the native Save dialog which allows users to store a file in the selected location. ## Supported platforms -* Android -* iOS - - +- Android +- iOS diff --git a/docs/plugins/screen-orientation/README.md b/docs/plugins/screen-orientation/README.md index e6da98d6b..c2319df76 100644 --- a/docs/plugins/screen-orientation/README.md +++ b/docs/plugins/screen-orientation/README.md @@ -16,8 +16,6 @@ Requires Cordova plugin: `cordova-plugin-screen-orientation`. For more info, ple ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/screenshot/README.md b/docs/plugins/screenshot/README.md new file mode 100644 index 000000000..f3ed92464 --- /dev/null +++ b/docs/plugins/screenshot/README.md @@ -0,0 +1,18 @@ +# Screenshot + +``` +$ ionic cordova plugin add @herdwatch/cordova-plugin-screenshot +$ npm install @awesome-cordova-plugins/screenshot +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/screenshot/) + +Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-screenshot](https://github.com/herdwatch-apps/cordova-plugin-screenshot) + +Captures a screen shot + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/secure-storage-echo/README.md b/docs/plugins/secure-storage-echo/README.md index b59c12f3c..1481edd26 100644 --- a/docs/plugins/secure-storage-echo/README.md +++ b/docs/plugins/secure-storage-echo/README.md @@ -18,9 +18,7 @@ The browser platform is supported as a mock only. Key/values are stored unencryp ## Supported platforms - Android - - Browser - - iOS - - Windows - - +- Browser +- iOS +- Windows diff --git a/docs/plugins/secure-storage/README.md b/docs/plugins/secure-storage/README.md index 3c698594f..9a0134b48 100644 --- a/docs/plugins/secure-storage/README.md +++ b/docs/plugins/secure-storage/README.md @@ -18,9 +18,7 @@ The browser platform is supported as a mock only. Key/values are stored unencryp ## Supported platforms - Android - - Browser - - iOS - - Windows - - +- Browser +- iOS +- Windows diff --git a/docs/plugins/service-discovery/README.md b/docs/plugins/service-discovery/README.md index 8bccdf6de..55034e221 100644 --- a/docs/plugins/service-discovery/README.md +++ b/docs/plugins/service-discovery/README.md @@ -14,7 +14,5 @@ Simple plugin to get any SSDP / UPnP / DLNA service on a local network ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/shake/README.md b/docs/plugins/shake/README.md index 2a7032b59..bf79fdf85 100644 --- a/docs/plugins/shake/README.md +++ b/docs/plugins/shake/README.md @@ -14,6 +14,4 @@ Handles shake gesture ## Supported platforms - iOS - - diff --git a/docs/plugins/shortcuts-android/README.md b/docs/plugins/shortcuts-android/README.md new file mode 100644 index 000000000..776d7c31f --- /dev/null +++ b/docs/plugins/shortcuts-android/README.md @@ -0,0 +1,21 @@ +# ShortcutsAndroid + +``` +$ ionic cordova plugin add cordova-plugin-shortcuts-android +$ npm install @awesome-cordova-plugins/shortcuts-android +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/shortcuts-android/) + +Plugin Repo: [https://github.com/avargaskun/cordova-plugin-shortcuts-android](https://github.com/avargaskun/cordova-plugin-shortcuts-android) + +Use this plugin to create shortcuts in Android. Use this plugin to handle Intents on your application. +For more information on Android App Shortcuts: https://developer.android.com/guide/topics/ui/shortcuts.html +For more information on Android Intents: https://developer.android.com/guide/components/intents-filters.html + +The work that went into creating this plug-in was inspired by the existing plugins: cordova-plugin-shortcut and cordova-plugin-webintent2. + +## Supported platforms + +- Android + diff --git a/docs/plugins/sign-in-with-apple/README.md b/docs/plugins/sign-in-with-apple/README.md index a2076b9c0..01807eb44 100644 --- a/docs/plugins/sign-in-with-apple/README.md +++ b/docs/plugins/sign-in-with-apple/README.md @@ -1,5 +1,7 @@ -# ASAuthorizationAppleIDRequest -c cordova plugin add cordova-plugin-sign-in-with-apple +# Sign In With Apple + +``` +$ ionic cordova plugin add cordova-plugin-sign-in-with-apple $ npm install @awesome-cordova-plugins/sign-in-with-apple ``` @@ -17,6 +19,4 @@ Source:* https://developer.apple.com/sign-in-with-apple/ ## Supported platforms - iOS - - diff --git a/docs/plugins/smartlook/README.md b/docs/plugins/smartlook/README.md index c0259a251..b54abab82 100644 --- a/docs/plugins/smartlook/README.md +++ b/docs/plugins/smartlook/README.md @@ -15,7 +15,5 @@ Full documentation can be found here: https://mobile.developer.smartlook.com/ref ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/sms-retriever-api/README.md b/docs/plugins/sms-retriever-api/README.md index 68cb7ad86..19e53d158 100644 --- a/docs/plugins/sms-retriever-api/README.md +++ b/docs/plugins/sms-retriever-api/README.md @@ -14,6 +14,4 @@ This plugin retries the SMS which arrive without requiring READ permissions. ## Supported platforms - Android - - diff --git a/docs/plugins/sms-retriever/README.md b/docs/plugins/sms-retriever/README.md index bce6e93e8..089461fe3 100644 --- a/docs/plugins/sms-retriever/README.md +++ b/docs/plugins/sms-retriever/README.md @@ -14,6 +14,4 @@ This plugin retrives the SMS which arrive without requiring READ permissions. ## Supported platforms - Android - - diff --git a/docs/plugins/sms/README.md b/docs/plugins/sms/README.md index a3773e2f4..1bfb9a2db 100644 --- a/docs/plugins/sms/README.md +++ b/docs/plugins/sms/README.md @@ -14,9 +14,7 @@ Requires Cordova plugin: cordova-sms-plugin. For more info, please see the [SMS ## Supported platforms - Android - - iOS - - Windows - - Windows Phone 8 - - +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/smtp-client/README.md b/docs/plugins/smtp-client/README.md index 564b8ebc4..380f81dc1 100644 --- a/docs/plugins/smtp-client/README.md +++ b/docs/plugins/smtp-client/README.md @@ -9,9 +9,8 @@ $ npm install @awesome-cordova-plugins/smtp-client Plugin Repo: [https://github.com/CWBudde/cordova-plugin-smtp-client](https://github.com/CWBudde/cordova-plugin-smtp-client) - - ## Supported platforms - Android - iOS + diff --git a/docs/plugins/social-sharing/README.md b/docs/plugins/social-sharing/README.md index b15211b8c..f13fb4ddd 100644 --- a/docs/plugins/social-sharing/README.md +++ b/docs/plugins/social-sharing/README.md @@ -16,10 +16,8 @@ For Browser usage check out the Web Share API docs: https://github.com/EddyVerbr ## Supported platforms - Android - - Browser - - iOS - - Windows - - Windows Phone - - +- Browser +- iOS +- Windows +- Windows Phone diff --git a/docs/plugins/sockets-tcp/README.md b/docs/plugins/sockets-tcp/README.md new file mode 100644 index 000000000..7c75017a9 --- /dev/null +++ b/docs/plugins/sockets-tcp/README.md @@ -0,0 +1,18 @@ +# SocketsTcp + +``` +$ ionic cordova plugin add https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp +$ npm install @awesome-cordova-plugins/sockets-tcp +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sockets-tcp/) + +Plugin Repo: [https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp](https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp) + +This plugin provides TCP client sockets for Android and iOS. + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/sockets-udp/README.md b/docs/plugins/sockets-udp/README.md new file mode 100644 index 000000000..dcdb8eb8a --- /dev/null +++ b/docs/plugins/sockets-udp/README.md @@ -0,0 +1,18 @@ +# SocketsUdp + +``` +$ ionic cordova plugin add cordova-plugin-chrome-apps-sockets-udp +$ npm install @awesome-cordova-plugins/sockets-udp +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sockets-udp/) + +Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp](https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp) + +This plugin provides UDP sockets for Android and iOS. + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/speech-recognition/README.md b/docs/plugins/speech-recognition/README.md index 64d82726f..4decd2046 100644 --- a/docs/plugins/speech-recognition/README.md +++ b/docs/plugins/speech-recognition/README.md @@ -14,7 +14,5 @@ This plugin does speech recognition using cloud services ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/spinner-dialog/README.md b/docs/plugins/spinner-dialog/README.md index 61034dbb6..e3b499efc 100644 --- a/docs/plugins/spinner-dialog/README.md +++ b/docs/plugins/spinner-dialog/README.md @@ -16,9 +16,7 @@ Requires Cordova plugin: `cordova-plugin-native-spinner`. For more info, please ## Supported platforms - Android - - iOS - - Windows Phone 8 - - Windows - - +- iOS +- Windows Phone 8 +- Windows diff --git a/docs/plugins/splash-screen/README.md b/docs/plugins/splash-screen/README.md index bf141d220..a1b204aae 100644 --- a/docs/plugins/splash-screen/README.md +++ b/docs/plugins/splash-screen/README.md @@ -14,9 +14,7 @@ This plugin displays and hides a splash screen during application launch. The me ## Supported platforms - Amazon Fire OS - - Android - - iOS - - Windows - - +- Android +- iOS +- Windows diff --git a/docs/plugins/spotify-auth/README.md b/docs/plugins/spotify-auth/README.md index 3eb30b7b3..37c309eb4 100644 --- a/docs/plugins/spotify-auth/README.md +++ b/docs/plugins/spotify-auth/README.md @@ -15,7 +15,5 @@ Cordova plugin for authenticating with Spotify ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/sqlite-db-copy/README.md b/docs/plugins/sqlite-db-copy/README.md index 507524846..7141cb98b 100644 --- a/docs/plugins/sqlite-db-copy/README.md +++ b/docs/plugins/sqlite-db-copy/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/sqlite-porter/README.md b/docs/plugins/sqlite-porter/README.md index 4b07fa88d..ee56cf0f4 100644 --- a/docs/plugins/sqlite-porter/README.md +++ b/docs/plugins/sqlite-porter/README.md @@ -14,13 +14,11 @@ This Cordova/Phonegap plugin can be used to import/export to/from a SQLite datab ## Supported platforms - Amazon Fire OS - - Android - - BlackBerry 10 - - Browser - - iOS - - Tizen - - Windows - - Windows Phone - - +- Android +- BlackBerry 10 +- Browser +- iOS +- Tizen +- Windows +- Windows Phone diff --git a/docs/plugins/sqlite/README.md b/docs/plugins/sqlite/README.md index c7b8637ec..bdfa4a08c 100644 --- a/docs/plugins/sqlite/README.md +++ b/docs/plugins/sqlite/README.md @@ -14,9 +14,7 @@ Access SQLite databases on the device. ## Supported platforms - Android - - iOS - - macOS - - Windows - - +- iOS +- macOS +- Windows diff --git a/docs/plugins/ssl-certificate-checker/README.md b/docs/plugins/ssl-certificate-checker/README.md index 866454fcb..b2c065dd2 100644 --- a/docs/plugins/ssl-certificate-checker/README.md +++ b/docs/plugins/ssl-certificate-checker/README.md @@ -1,7 +1,7 @@ # SSLCertificateChecker ``` -$ ionic cordova plugin add cordova-plugin-sslcertificatechecker +$ ionic cordova plugin add SSLCertificateChecker-PhoneGap-Plugin $ npm install @awesome-cordova-plugins/ssl-certificate-checker ``` @@ -11,7 +11,8 @@ Plugin Repo: [https://github.com/EddyVerbruggen/SSLCertificateChecker-PhoneGap-P Cordova plugin to check SSL certificates on Android and iOS. -## Supported Platforms +## Supported platforms + +- Android +- iOS -* Android -* iOS diff --git a/docs/plugins/star-prnt/README.md b/docs/plugins/star-prnt/README.md index 33916b420..7c6421a06 100644 --- a/docs/plugins/star-prnt/README.md +++ b/docs/plugins/star-prnt/README.md @@ -14,7 +14,5 @@ Ionic Native wrappers for the starprnt cordova plugin for Star Micronics Bluetoo ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/status-bar/README.md b/docs/plugins/status-bar/README.md index 68cef8dce..120c02fb8 100644 --- a/docs/plugins/status-bar/README.md +++ b/docs/plugins/status-bar/README.md @@ -16,8 +16,6 @@ Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see t ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/streaming-media/README.md b/docs/plugins/streaming-media/README.md index b03808bbe..3692e3722 100644 --- a/docs/plugins/streaming-media/README.md +++ b/docs/plugins/streaming-media/README.md @@ -14,8 +14,6 @@ This plugin allows you to stream audio and video in a fullscreen, native player ## Supported platforms - Amazon Fire OS - - Android - - iOS - - +- Android +- iOS diff --git a/docs/plugins/stripe/README.md b/docs/plugins/stripe/README.md index 76cfaf6ae..909628525 100644 --- a/docs/plugins/stripe/README.md +++ b/docs/plugins/stripe/README.md @@ -14,8 +14,6 @@ A plugin that allows you to use Stripe's Native SDKs for Android and iOS. ## Supported platforms - Android - - Browser - - iOS - - +- Browser +- iOS diff --git a/docs/plugins/sum-up/README.md b/docs/plugins/sum-up/README.md index 5a7fab2d1..635bf653c 100644 --- a/docs/plugins/sum-up/README.md +++ b/docs/plugins/sum-up/README.md @@ -14,7 +14,5 @@ Plugin to communicate with a SumUp payment terminal ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/system-alert-window-permission/README.md b/docs/plugins/system-alert-window-permission/README.md index 0c4b3b0d0..923627816 100644 --- a/docs/plugins/system-alert-window-permission/README.md +++ b/docs/plugins/system-alert-window-permission/README.md @@ -14,6 +14,4 @@ This plugin does something ## Supported platforms - Android - - diff --git a/docs/plugins/taptic-engine/README.md b/docs/plugins/taptic-engine/README.md index 7dac1cd0b..40102c490 100644 --- a/docs/plugins/taptic-engine/README.md +++ b/docs/plugins/taptic-engine/README.md @@ -14,6 +14,4 @@ An Ionic plugin to use Taptic Engine API on iPhone 7, 7 Plus or newer. ## Supported platforms - iOS - - diff --git a/docs/plugins/tealium-adidentifier/README.md b/docs/plugins/tealium-adidentifier/README.md index a8563e4e4..ebd46b6bb 100644 --- a/docs/plugins/tealium-adidentifier/README.md +++ b/docs/plugins/tealium-adidentifier/README.md @@ -1,7 +1,7 @@ # TealiumAdIdentifier ``` -$ '' +$ $ npm install @awesome-cordova-plugins/tealium-adidentifier ``` @@ -15,7 +15,5 @@ Makes the IDFA and Google Ad Identifier available in the Tealium data layer. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/tealium-installreferrer/README.md b/docs/plugins/tealium-installreferrer/README.md index cb3503337..c3da33062 100644 --- a/docs/plugins/tealium-installreferrer/README.md +++ b/docs/plugins/tealium-installreferrer/README.md @@ -1,7 +1,7 @@ # TealiumInstallReferrer ``` -$ '' +$ $ npm install @awesome-cordova-plugins/tealium-installreferrer ``` @@ -15,6 +15,4 @@ Implements a Broadcast Receiver for the INSTALL_REFERRER intent. ## Supported platforms - Android - - diff --git a/docs/plugins/tealium/README.md b/docs/plugins/tealium/README.md index 730f4f577..0764c009a 100644 --- a/docs/plugins/tealium/README.md +++ b/docs/plugins/tealium/README.md @@ -1,5 +1,7 @@ -# ConsentExpiry - '' +# Tealium + +``` +$ $ npm install @awesome-cordova-plugins/tealium ``` @@ -14,7 +16,5 @@ For full documentation, see [https://docs.tealium.com/platforms/cordova/](https: ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/text-to-speech-advanced/README.md b/docs/plugins/text-to-speech-advanced/README.md index d4b924556..ffbbfbe5e 100644 --- a/docs/plugins/text-to-speech-advanced/README.md +++ b/docs/plugins/text-to-speech-advanced/README.md @@ -14,7 +14,5 @@ Text to Speech plugin ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/theme-detection/README.md b/docs/plugins/theme-detection/README.md index 11fe505a3..5a7d4b731 100644 --- a/docs/plugins/theme-detection/README.md +++ b/docs/plugins/theme-detection/README.md @@ -1,12 +1,5 @@ # Theme Detection -

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

- - ``` $ cordova plugin add cordova-plugin-theme-detection $ npm install @awesome-cordova-plugins/theme-detection @@ -21,7 +14,5 @@ Cordova plugin to detect whether dark mode is enabled or not ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/three-dee-touch/README.md b/docs/plugins/three-dee-touch/README.md index 4242a6555..ec7a8557c 100644 --- a/docs/plugins/three-dee-touch/README.md +++ b/docs/plugins/three-dee-touch/README.md @@ -1,13 +1,13 @@ # 3D Touch ``` -$ ionic cordova plugin add cordova-plugin-3dtouch +$ ionic cordova plugin add @herdwatch/cordova-plugin-3dtouch $ npm install @awesome-cordova-plugins/three-dee-touch ``` ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/three-dee-touch/) -Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-3dtouch](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch) +Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-3dtouch](https://github.com/herdwatch-apps/cordova-plugin-3dtouch) The 3D Touch plugin adds 3D Touch capabilities to your Cordova app. @@ -16,6 +16,4 @@ Requires Cordova plugin: `cordova-plugin-3dtouch`. For more info, please see the ## Supported platforms - iOS - - diff --git a/docs/plugins/toast/README.md b/docs/plugins/toast/README.md index 4e719a831..34e322c40 100644 --- a/docs/plugins/toast/README.md +++ b/docs/plugins/toast/README.md @@ -16,10 +16,8 @@ Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the ## Supported platforms - Android - - BlackBerry 10 - - iOS - - Windows - - Windows Phone 8 - - +- BlackBerry 10 +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/touch-id/README.md b/docs/plugins/touch-id/README.md index 7d521590d..f7ab072ea 100644 --- a/docs/plugins/touch-id/README.md +++ b/docs/plugins/touch-id/README.md @@ -16,6 +16,4 @@ Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see th ## Supported platforms - iOS - - diff --git a/docs/plugins/unique-device-id/README.md b/docs/plugins/unique-device-id/README.md index 92e6800f3..0270c4f6a 100644 --- a/docs/plugins/unique-device-id/README.md +++ b/docs/plugins/unique-device-id/README.md @@ -1,7 +1,7 @@ # Unique Device ID ``` -$ '' +$ $ npm install @awesome-cordova-plugins/unique-device-id ``` @@ -14,8 +14,6 @@ This plugin produces a unique, cross-install, app-specific device id. ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/unvired-cordova-sdk/README.md b/docs/plugins/unvired-cordova-sdk/README.md index 9848c3c1e..e192072f6 100644 --- a/docs/plugins/unvired-cordova-sdk/README.md +++ b/docs/plugins/unvired-cordova-sdk/README.md @@ -1,7 +1,7 @@ -# SyncResult -ult -ivateResult -ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk +# Unvired Cordova SDK + +``` +$ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk $ npm install @awesome-cordova-plugins/unvired-cordova-sdk ``` @@ -31,9 +31,7 @@ After you install the plugin, for Ionic/Angular projects, please add a reference ## Supported platforms - iOS - - Android - - Windows - - Browser - - +- Android +- Windows +- Browser diff --git a/docs/plugins/uptime/README.md b/docs/plugins/uptime/README.md index baa5e41d9..ed69dae31 100644 --- a/docs/plugins/uptime/README.md +++ b/docs/plugins/uptime/README.md @@ -14,7 +14,5 @@ This plugin provides the time spent in milliseconds since boot (uptime). ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/urbanairship/README.md b/docs/plugins/urbanairship/README.md index d274b0a43..364a554f1 100644 --- a/docs/plugins/urbanairship/README.md +++ b/docs/plugins/urbanairship/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/usabilla-cordova-sdk/README.md b/docs/plugins/usabilla-cordova-sdk/README.md index 8e434ce56..c126a3368 100644 --- a/docs/plugins/usabilla-cordova-sdk/README.md +++ b/docs/plugins/usabilla-cordova-sdk/README.md @@ -17,7 +17,5 @@ For more info see [Cordova plugin docs](https://github.com/usabilla/usabilla-u4a ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/vibes/README.md b/docs/plugins/vibes/README.md index 73e20ba6b..7188f765f 100644 --- a/docs/plugins/vibes/README.md +++ b/docs/plugins/vibes/README.md @@ -14,7 +14,5 @@ This plugin enables integration with the Vibes Push SDK to your Cordova project ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/vibration/README.md b/docs/plugins/vibration/README.md index 8ad09aa7a..5fa858be7 100644 --- a/docs/plugins/vibration/README.md +++ b/docs/plugins/vibration/README.md @@ -14,8 +14,6 @@ Vibrates the device ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/video-editor/README.md b/docs/plugins/video-editor/README.md index 89f552b76..288f89530 100644 --- a/docs/plugins/video-editor/README.md +++ b/docs/plugins/video-editor/README.md @@ -14,9 +14,7 @@ Edit videos using native device APIs ## Supported platforms - Android - - iOS - - Windows - - Windows Phone 8 - - +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/video-player/README.md b/docs/plugins/video-player/README.md index 5075331b1..88cb3e6d5 100644 --- a/docs/plugins/video-player/README.md +++ b/docs/plugins/video-player/README.md @@ -16,6 +16,4 @@ Requires Cordova plugin: `com.moust.cordova.videoplayer`. For more info, please ## Supported platforms - Android - - diff --git a/docs/plugins/we-cap-inbox/README.md b/docs/plugins/we-cap-inbox/README.md new file mode 100644 index 000000000..78aee16aa --- /dev/null +++ b/docs/plugins/we-cap-inbox/README.md @@ -0,0 +1,18 @@ +# WE Cap Inbox + +``` +$ ionic cordova plugin add we-notificationinbox-cordova +$ npm install @awesome-cordova-plugins/we-cap-inbox +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/we-cap-inbox/) + +Plugin Repo: [https://github.com/WebEngage/we-ionic-notification-inbox](https://github.com/WebEngage/we-ionic-notification-inbox) + +This plugin provides functionalities to manage notifications in your app. + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/web-intent/README.md b/docs/plugins/web-intent/README.md index 09d262989..7cbe8b1fa 100644 --- a/docs/plugins/web-intent/README.md +++ b/docs/plugins/web-intent/README.md @@ -14,6 +14,4 @@ This Plugin provides a general purpose shim layer for the Android intent mechani ## Supported platforms - Android - - diff --git a/docs/plugins/web-server/README.md b/docs/plugins/web-server/README.md index 29ef8ce0e..8f68db310 100644 --- a/docs/plugins/web-server/README.md +++ b/docs/plugins/web-server/README.md @@ -14,7 +14,5 @@ This plugin allows you to start a local dynamic content web server for android a ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/web-socket-server/README.md b/docs/plugins/web-socket-server/README.md index 42091faff..7d6829b63 100644 --- a/docs/plugins/web-socket-server/README.md +++ b/docs/plugins/web-socket-server/README.md @@ -14,7 +14,5 @@ This plugin allows you to run a single, lightweight, barebone WebSocket Server. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/webengage/README.md b/docs/plugins/webengage/README.md index 3a8128157..1f591b962 100644 --- a/docs/plugins/webengage/README.md +++ b/docs/plugins/webengage/README.md @@ -14,7 +14,5 @@ Awesome Cordova Plugins wrapper that wraps Webengage Cordova plugin for Android ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/webim/README.md b/docs/plugins/webim/README.md index 02e30e0c3..19b8e1425 100644 --- a/docs/plugins/webim/README.md +++ b/docs/plugins/webim/README.md @@ -14,8 +14,6 @@ A cordova plugin, a JS version of Webim SDK ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/wechat/README.md b/docs/plugins/wechat/README.md index aac91be2f..b5fc5487f 100644 --- a/docs/plugins/wechat/README.md +++ b/docs/plugins/wechat/README.md @@ -14,7 +14,5 @@ A cordova plugin, a JS version of Wechat SDK ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/wheel-selector/README.md b/docs/plugins/wheel-selector/README.md index e3c71d410..9b5a71531 100644 --- a/docs/plugins/wheel-selector/README.md +++ b/docs/plugins/wheel-selector/README.md @@ -1,12 +1,5 @@ # WheelSelector Plugin -

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

- - ``` $ ionic cordova plugin add cordova-wheel-selector-plugin $ npm install @awesome-cordova-plugins/wheel-selector @@ -21,7 +14,5 @@ Native wheel selector for Cordova (Android/iOS). ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/wifi-wizard-2/README.md b/docs/plugins/wifi-wizard-2/README.md index 144e95334..80ace4c13 100644 --- a/docs/plugins/wifi-wizard-2/README.md +++ b/docs/plugins/wifi-wizard-2/README.md @@ -16,7 +16,5 @@ This project is a fork of the WifiWizard plugin with fixes and updates, as well ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/wonderpush/README.md b/docs/plugins/wonderpush/README.md index 03d7394b6..bbdcfab9c 100644 --- a/docs/plugins/wonderpush/README.md +++ b/docs/plugins/wonderpush/README.md @@ -1,5 +1,4 @@ -# UserPreferencesMethods -nderPush +# Push Notifications - WonderPush ``` $ ionic cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=YOUR_CLIENT_ID --variable CLIENT_SECRET=YOUR_CLIENT_SECRET @@ -24,7 +23,5 @@ to retain your users and grow your audience while remaining fully GDPR compliant ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/youtube-video-player/README.md b/docs/plugins/youtube-video-player/README.md index c52a56b0f..e3fe1549e 100644 --- a/docs/plugins/youtube-video-player/README.md +++ b/docs/plugins/youtube-video-player/README.md @@ -14,7 +14,5 @@ Plays YouTube videos in Native YouTube App ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zbar/README.md b/docs/plugins/zbar/README.md index 695809895..297872647 100644 --- a/docs/plugins/zbar/README.md +++ b/docs/plugins/zbar/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zeroconf/README.md b/docs/plugins/zeroconf/README.md index 1973717cd..450c6d56c 100644 --- a/docs/plugins/zeroconf/README.md +++ b/docs/plugins/zeroconf/README.md @@ -14,7 +14,5 @@ This plugin allows you to browse and publish Zeroconf/Bonjour/mDNS services. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zip/README.md b/docs/plugins/zip/README.md index cc5cf25be..af6a46caa 100644 --- a/docs/plugins/zip/README.md +++ b/docs/plugins/zip/README.md @@ -14,7 +14,5 @@ A Cordova plugin to unzip files in Android and iOS. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zoom/README.md b/docs/plugins/zoom/README.md index 10fd19bd4..65c154872 100644 --- a/docs/plugins/zoom/README.md +++ b/docs/plugins/zoom/README.md @@ -14,7 +14,5 @@ A Cordova plugin to use Zoom Video Conferencing services on Cordova applications ## Supported platforms - Android - - iOS - - +- iOS diff --git a/scripts/docs/config.json b/scripts/docs/config.json deleted file mode 100644 index 4949e63a5..000000000 --- a/scripts/docs/config.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "v2DocsDir": "docs/native", - "pluginDir": "dist/@awesome-cordova-plugins/plugins" -} diff --git a/scripts/docs/dgeni/configs/links.js b/scripts/docs/dgeni/configs/links.js deleted file mode 100644 index 361b932c8..000000000 --- a/scripts/docs/dgeni/configs/links.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function (getLinkInfo) { - getLinkInfo.useFirstAmbiguousLink = false; -}; diff --git a/scripts/docs/dgeni/configs/log.js b/scripts/docs/dgeni/configs/log.js deleted file mode 100644 index cf20f3b26..000000000 --- a/scripts/docs/dgeni/configs/log.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function (log) { - log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error' -}; diff --git a/scripts/docs/dgeni/configs/tag-defs.js b/scripts/docs/dgeni/configs/tag-defs.js deleted file mode 100644 index ae47967b0..000000000 --- a/scripts/docs/dgeni/configs/tag-defs.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function (parseTagsProcessor) { - parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat(require('../tag-defs/tag-defs')); -}; diff --git a/scripts/docs/dgeni/configs/template-filters.js b/scripts/docs/dgeni/configs/template-filters.js deleted file mode 100644 index 83f6a3d14..000000000 --- a/scripts/docs/dgeni/configs/template-filters.js +++ /dev/null @@ -1,12 +0,0 @@ -module.exports = function (templateEngine) { - // Nunjucks and Angular conflict in their template bindings so change the Nunjucks - // Also conflict with Jekyll - templateEngine.config.tags = { - variableStart: '<$', - variableEnd: '$>', - blockStart: '<@', - blockEnd: '@>', - commentStart: '<#', - commentEnd: '#>', - }; -}; diff --git a/scripts/docs/dgeni/configs/template-tags.js b/scripts/docs/dgeni/configs/template-tags.js deleted file mode 100644 index 53c8a8887..000000000 --- a/scripts/docs/dgeni/configs/template-tags.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = function (templateEngine) { - // add custom filters to nunjucks - templateEngine.filters.push( - require('../filters/capital'), - require('../filters/code'), - require('../filters/dump'), - require('../filters/dashify') - ); -}; diff --git a/scripts/docs/dgeni/dgeni-config.js b/scripts/docs/dgeni/dgeni-config.js deleted file mode 100644 index 938036174..000000000 --- a/scripts/docs/dgeni/dgeni-config.js +++ /dev/null @@ -1,75 +0,0 @@ -'use strict'; -const Package = require('dgeni').Package, - jsdocPackage = require('dgeni-packages/jsdoc'), - nunjucksPackage = require('dgeni-packages/nunjucks'), - typescriptPackage = require('dgeni-packages/typescript'), - linksPackage = require('dgeni-packages/links'), - path = require('path'), - config = require('../config.json'); - -module.exports = (currentVersion) => { - return ( - new Package('ionic-native-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) - - .processor(require('./processors/remove-private-members')) - .processor(require('./processors/hide-private-api')) - .processor(require('./processors/parse-optional')) - .processor(require('./processors/mark-properties')) - .processor(require('./processors/npm-id')) - .processor(require('./processors/jekyll')) - - .config(require('./configs/log')) - .config(require('./configs/template-filters')) - .config(require('./configs/template-tags')) - .config(require('./configs/tag-defs')) - .config(require('./configs/links')) - - .config(function (renderDocsProcessor, computePathsProcessor) { - currentVersion = { - href: '/' + config.v2DocsDir.replace('content/', ''), - folder: '', - name: currentVersion, - }; - - renderDocsProcessor.extraData.version = { - list: [currentVersion], - current: currentVersion, - latest: currentVersion, - }; - - computePathsProcessor.pathTemplates = [ - { - docTypes: ['class'], - getOutputPath: (doc) => 'content/' + config.v2DocsDir + '/' + doc.name + '/index.md', - }, - ]; - }) - - //configure file reading - .config(function (readFilesProcessor, readTypeScriptModules) { - // Don't run unwanted processors since we are not using the normal file reading processor - readFilesProcessor.$enabled = false; - readFilesProcessor.basePath = path.resolve(__dirname, '../../..'); - - readTypeScriptModules.basePath = path.resolve(__dirname, '../../..'); - readTypeScriptModules.sourceFiles = ['./src/@awesome-cordova-plugins/plugins/**/*.ts']; - }) - - // Configure file writing - .config(function (writeFilesProcessor) { - writeFilesProcessor.outputFolder = '../ionic-site/'; - }) - - // Configure rendering - .config(function (templateFinder) { - templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); - - // Specify how to match docs to templates. - templateFinder.templatePatterns = [ - '${ doc.template }', - '${ doc.docType }.template.html', - 'common.template.html', - ]; - }) - ); -}; diff --git a/scripts/docs/dgeni/dgeni-readmes-config.js b/scripts/docs/dgeni/dgeni-readmes-config.js deleted file mode 100644 index 69fdad9e1..000000000 --- a/scripts/docs/dgeni/dgeni-readmes-config.js +++ /dev/null @@ -1,74 +0,0 @@ -'use strict'; -const Package = require('dgeni').Package, - jsdocPackage = require('dgeni-packages/jsdoc'), - nunjucksPackage = require('dgeni-packages/nunjucks'), - typescriptPackage = require('dgeni-packages/typescript'), - linksPackage = require('dgeni-packages/links'), - path = require('path'), - config = require('../config.json'); - -module.exports = (currentVersion) => { - return ( - new Package('ionic-native-readmes', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) - - .processor(require('./processors/readmes')) - .processor(require('./processors/remove-private-members')) - .processor(require('./processors/hide-private-api')) - .processor(require('./processors/npm-id')) - - .config(require('./configs/log')) - .config(require('./configs/template-filters')) - .config(require('./configs/template-tags')) - .config(require('./configs/tag-defs')) - .config(require('./configs/links')) - - .config(function (renderDocsProcessor, computePathsProcessor) { - currentVersion = { - href: '/' + config.v2DocsDir.replace('content/', ''), - folder: '', - name: currentVersion, - }; - - renderDocsProcessor.extraData.version = { - list: [currentVersion], - current: currentVersion, - latest: currentVersion, - }; - - computePathsProcessor.pathTemplates = [ - { - docTypes: ['class'], - getOutputPath: (doc) => - doc.originalModule.replace(config.pluginDir + '/', '').replace(/\/index$/, '/README.md'), - }, - ]; - }) - - //configure file reading - .config(function (readFilesProcessor, readTypeScriptModules) { - // Don't run unwanted processors since we are not using the normal file reading processor - readFilesProcessor.$enabled = false; - readFilesProcessor.basePath = path.resolve(__dirname, '../../..'); - - readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../../..')); - readTypeScriptModules.sourceFiles = ['./src/@awesome-cordova-plugins/plugins/**/*.ts']; - }) - - // Configure file writing - .config(function (writeFilesProcessor) { - writeFilesProcessor.outputFolder = './dist/@awesome-cordova-plugins/'; - }) - - .config(function (writeFilesProcessor) { - writeFilesProcessor.outputFolder = './docs/'; - }) - - // Configure rendering - .config(function (templateFinder) { - templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); - - // Specify how to match docs to templates. - templateFinder.templatePatterns = ['${ doc.template }', '${ doc.docType }.template.md', 'readme.template.md']; - }) - ); -}; diff --git a/scripts/docs/dgeni/filters/capital.js b/scripts/docs/dgeni/filters/capital.js deleted file mode 100644 index 9d3c2bb5b..000000000 --- a/scripts/docs/dgeni/filters/capital.js +++ /dev/null @@ -1,5 +0,0 @@ -'use strict'; -module.exports = { - name: 'capital', - process: (str) => (str ? str.charAt(0).toUpperCase() + str.substring(1) : ''), -}; diff --git a/scripts/docs/dgeni/filters/code.js b/scripts/docs/dgeni/filters/code.js deleted file mode 100644 index 0ae001b3f..000000000 --- a/scripts/docs/dgeni/filters/code.js +++ /dev/null @@ -1,24 +0,0 @@ -'use strict'; -const encoder = new require('node-html-encoder').Encoder(); - -function code(str, inline, lang) { - // Encode any HTML entities in the code string - str = encoder.htmlEncode(str, true); - - // If a language is provided then attach a CSS class to the code element - lang = lang ? ' class="lang-' + lang + '"' : ''; - - str = '' + str + ''; - - // If not inline then wrap the code element in a pre element - if (!inline) { - str = '
' + str + '
'; - } - - return str; -} - -module.exports = { - name: 'code', - process: (str, lang) => code(str, true, lang), -}; diff --git a/scripts/docs/dgeni/filters/dashify.js b/scripts/docs/dgeni/filters/dashify.js deleted file mode 100644 index 60054c783..000000000 --- a/scripts/docs/dgeni/filters/dashify.js +++ /dev/null @@ -1,5 +0,0 @@ -'use strict'; -module.exports = { - name: 'dashify', - process: (str) => (str ? str.replace(/\s/g, '-') : ''), -}; diff --git a/scripts/docs/dgeni/filters/dump.js b/scripts/docs/dgeni/filters/dump.js deleted file mode 100644 index ad23b94c0..000000000 --- a/scripts/docs/dgeni/filters/dump.js +++ /dev/null @@ -1,5 +0,0 @@ -'use strict'; -module.exports = { - name: 'dump', - process: (obj) => console.log(obj), -}; diff --git a/scripts/docs/dgeni/processors/debug.js b/scripts/docs/dgeni/processors/debug.js deleted file mode 100644 index cc1f6af68..000000000 --- a/scripts/docs/dgeni/processors/debug.js +++ /dev/null @@ -1,39 +0,0 @@ -'use strict'; -module.exports = function test() { - return { - name: 'debug', - $runBefore: ['rendering-docs'], - $process: function (docs) { - docs.forEach(function (doc) { - if (doc.name == 'Camera') { - console.log(doc.tags); - doc.tags.forEach(function (tag) { - if (tag.tagName == 'classes') { - } - }); - - doc.moduleDoc.exports.forEach(function (d, i) { - if (d.name === 'CameraOptions') { - console.log('Name: ' + d.name); - console.log('Type: ' + d.docType); - console.log('First member: ', d.members[0]); - } - }); - - var exports = doc.exportSymbol.parent.exports; - for (var p in exports) { - if (p == 'CameraOptions') { - var x = exports[p]; - console.log(x.members.quality); - } - } - doc.members.forEach(function (method) { - if (method.name === 'getPicture') { - console.log(method); - } - }); - } - }); - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/hide-private-api.js b/scripts/docs/dgeni/processors/hide-private-api.js deleted file mode 100644 index e58c8f71c..000000000 --- a/scripts/docs/dgeni/processors/hide-private-api.js +++ /dev/null @@ -1,9 +0,0 @@ -'use strict'; -module.exports = function removePrivateApi() { - return { - name: 'remove-private-api', - description: 'Prevent the private apis from being rendered', - $runBefore: ['rendering-docs'], - $process: (docs) => docs.filter((doc) => !doc.private && (!doc.tags || !doc.tags.tagsByName.get('hidden'))), - }; -}; diff --git a/scripts/docs/dgeni/processors/jekyll.js b/scripts/docs/dgeni/processors/jekyll.js deleted file mode 100644 index 6c9d46378..000000000 --- a/scripts/docs/dgeni/processors/jekyll.js +++ /dev/null @@ -1,63 +0,0 @@ -'use strict'; -module.exports = function jekyll(renderDocsProcessor) { - return { - name: 'jekyll', - description: 'Create jekyll includes', - $runAfter: ['paths-computed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - // pretty up and sort the docs object for menu generation - docs = docs.filter((doc) => (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page'); - - docs.push({ - docType: 'class', - URL: 'https://github.com/ionic-team/ionic-native-google-maps/blob/master/documents/README.md', - name: 'Google Maps', - }); - - docs.sort((a, b) => { - const textA = a.name ? a.name.toUpperCase() : '', - textB = b.name ? b.name.toUpperCase() : ''; - - return textA < textB ? -1 : textA > textB ? 1 : 0; - }); - - docs.forEach((doc) => { - if (!doc.outputPath) { - return; - } - - doc.outputPath = doc.outputPath.toLowerCase().replace(/\s/g, '-'); - doc.URL = doc.outputPath.replace('docs//', 'docs/').replace('/index.md', '').replace('content/', ''); - // add trailing slash to plugin pages - if (!doc.URL.endsWith('/') && !doc.URL.endsWith('.html')) { - doc.URL = doc.URL + '/'; - } - - doc.URL = '/' + doc.URL; - }); - - const betaDocs = []; - - docs = docs.filter((doc) => { - if (doc.beta === true) { - betaDocs.push(doc); - return false; - } - return true; - }); - - docs = docs.concat(betaDocs); - - // add side menu - docs.push({ - docType: 'nativeMenu', - id: 'native_menu', - template: 'native_menu.template.html', - outputPath: 'content/_includes/fluid/native_menu.html', - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/mark-properties.js b/scripts/docs/dgeni/processors/mark-properties.js deleted file mode 100644 index 2b02528a7..000000000 --- a/scripts/docs/dgeni/processors/mark-properties.js +++ /dev/null @@ -1,16 +0,0 @@ -'use strict'; -module.exports = function markProperties() { - return { - name: 'mark-properties', - $runBefore: ['rendering-docs'], - $process: (docs) => - docs.map((doc) => { - for (let i in doc.members) { - if (doc.members.hasOwnProperty(i) && typeof doc.members[i].parameters === 'undefined') { - doc.members[i].isProperty = true; - } - } - return doc; - }), - }; -}; diff --git a/scripts/docs/dgeni/processors/npm-id.js b/scripts/docs/dgeni/processors/npm-id.js deleted file mode 100644 index 31394f27f..000000000 --- a/scripts/docs/dgeni/processors/npm-id.js +++ /dev/null @@ -1,20 +0,0 @@ -'use strict'; -module.exports = function npmId(renderDocsProcessor) { - return { - name: 'npm-id', - $runAfter: ['paths-computed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - // pretty up and sort the docs object for menu generation - docs = docs.filter(function (doc) { - return (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page'; - }); - - docs.forEach((doc) => { - doc.npmId = doc.id.match(/plugins\/(.*)\/index/)[1]; - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/parse-optional.js b/scripts/docs/dgeni/processors/parse-optional.js deleted file mode 100644 index 9b38a2f73..000000000 --- a/scripts/docs/dgeni/processors/parse-optional.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; -module.exports = function parseOptional() { - return { - $runBefore: ['rendering-docs'], - $process: (docs) => { - docs.forEach((doc) => { - if (doc.members && doc.members.length) { - for (let i in doc.members) { - if (doc.members[i].params && doc.members[i].params.length) { - for (let ii in doc.members[i].params) { - if (doc.members[i].params[ii].optional) { - doc.members[i].params[ii].description += 'Optional'; - } - } - } - } - } - }); - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/readmes.js b/scripts/docs/dgeni/processors/readmes.js deleted file mode 100644 index 1f3cf38da..000000000 --- a/scripts/docs/dgeni/processors/readmes.js +++ /dev/null @@ -1,19 +0,0 @@ -'use strict'; -module.exports = function readmes(renderDocsProcessor) { - return { - name: 'readmes', - description: 'Create jekyll includes', - $runAfter: ['paths-computed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - // pretty up and sort the docs object for menu generation - docs = docs.filter((doc) => (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page'); - - docs.forEach((doc) => { - doc.outputPath = doc.outputPath.replace('src/@awesome-cordova-plugins/', ''); - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/remove-private-members.js b/scripts/docs/dgeni/processors/remove-private-members.js deleted file mode 100644 index 2dd0b0a3c..000000000 --- a/scripts/docs/dgeni/processors/remove-private-members.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; -module.exports = function removePrivateMembers() { - return { - name: 'remove-private-members', - description: 'Remove member docs with @private tags', - $runAfter: ['tags-parsed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - docs.forEach((doc) => { - if (doc.members) { - doc.members = doc.members.filter((member) => !member.tags.tagsByName.get('hidden')); - } - - if (doc.statics) { - doc.statics = doc.statics.filter((staticMethod) => !staticMethod.tags.tagsByName.get('hidden')); - } - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/tag-defs/tag-defs.js b/scripts/docs/dgeni/tag-defs/tag-defs.js deleted file mode 100644 index 3192824de..000000000 --- a/scripts/docs/dgeni/tag-defs/tag-defs.js +++ /dev/null @@ -1,11 +0,0 @@ -'use strict'; -module.exports = [ - { name: 'advanced' }, - { name: 'demo' }, - { name: 'beta', transforms: (doc, tag, value) => typeof value !== 'undefined' }, // make the value true or undefined instead of '' or undefined - { name: 'usage' }, - { name: 'hidden' }, // hide from docs - { name: 'classes' }, // related classes - { name: 'interfaces' }, // related interfaces - { name: 'paid', transforms: (doc, tag, value) => typeof value !== 'undefined' }, // paid plugin, set value to true -]; diff --git a/scripts/docs/dgeni/templates/common.template.html b/scripts/docs/dgeni/templates/common.template.html deleted file mode 100644 index ec70e3f9b..000000000 --- a/scripts/docs/dgeni/templates/common.template.html +++ /dev/null @@ -1,192 +0,0 @@ ---- -layout: "fluid/docs_base" -version: "<$ version.current.name $>" -versionHref: "<$ version.current.href.replace('content/','') $>" -path: "<$ doc.path $>" -category: native -id: "<$ doc.name|lower|replace(' ','-') $>" -title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>" -header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>" -doc: "<$ doc.name $>" -docType: "<$ doc.docType $>" ---- - -<@- macro interfaceTable(interface) -@> <@ for export in doc.moduleDoc.exports -@> <@ if export.name == interface @> - - - - - - - - - - <@ for param in export.members @> - - - - - - <@ endfor @> - -
ParamTypeDetails
<$ param.name $> - <$ param.returnType | escape $> - <$ param.description | marked $> <@ if param.optional @>(optional)<@ endif @>
-<@ endif @> <@- endfor @> <@- endmacro -@> <@- macro githubViewLink(doc) -@> -<$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>) -<@- endmacro -@> <@- macro paramTable(params, isDirective) -@> - - - - - - - - - - <@- for param in params @> - - - - - - <@ endfor -@> - -
<@ if isDirective @>Attr<@ else @>Param<@ endif @>TypeDetails
<$ param.name $> <@- if param.alias @>| <$ param.alias $><@ endif -@><$ typeList(param.typeList) $> - <$ param.description | marked $> <@- if param.defaultValue @> -

(default: <$ param.defaultValue $>)

- <@ endif -@> -
-<@- endmacro -@> <@- macro functionSyntax(fn) @> <@- set sep = joiner(', ') -@> -<$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $> <@- if - param.type.optional @>[<@- endif -@> <$ param.name $> <@- if param.type.optional -@>]<@- endif -@> <@- endfor -@><@- - if not fn.isProperty @>)<@- endif -@> -<@- endmacro -@> <@- macro typeList(types) -@> <@ set separator = joiner("|") @> <@- for type in types @><$ separator() -$><$ type | code $><@ endfor -@> <@- endmacro -@> <@- macro typeInfo(fn) -@> <$ typeList(fn.typeList) $> <$ -fn.description $> <@- endmacro -@> <@- macro documentPlatforms(method) -@> <@- if method.decorators @> <@ for prop in -method.decorators[0].argumentInfo @> <@ if prop.platforms @> -

- Platforms: - <@- for platform in prop.platforms -@> - <$ platform $>  <@- endfor -@> -

-<@ endif @> <@ endfor @> <@- endif @> <@- endmacro -@> <@ macro documentMethod(method) -@> -

<$ functionSyntax(method) $>

-<$ documentPlatforms(method) $> <$ method.description $> <@ if method.params -@> <$ paramTable(method.params) $> <@- -endif @> <@ if method.returns -@> -
- - Returns: <$ typeInfo(method.returns) $> -
-<@- endif @> <@- endmacro -@> <@- macro documentClass(doc) @> <@- if doc.statics.length -@> -

Static Members

-<@ for method in doc.statics -@> <$ documentMethod(method) $> <@ endfor -@> <@ endif @> <# --- methods in class --- #> -<@- if doc.members and doc.members.length @> - -

Instance Members

-<@ for method in doc.members -@> <$ documentMethod(method) $> <@- endfor @> <@- endif -@> <@ endmacro @> - -

- <$ doc.name $> <@- if doc.beta == true -@> - β - <@- endif -@> <@- if doc.paid == true -@> - - <@- endif -@> -

- - - Improve this doc - - -<# --- Decorators --- #> <@- if doc.decorators @> <@ for prop in doc.decorators[0].argumentInfo @> <@ 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 @> <@ if doc.paid == true @> - -<@ endif @> <# --- Plugin description --- #> <$ doc.description | marked $> - -

- Repo: - <$ prop.repo $> -

- -<# --- Install commands --- #> -

Installation

-
    -
  1. - Install the Cordova and Ionic Native plugins:
    -
    $ <@ if prop.install @><$ prop.install | replace('<', '<').replace('>', '>') $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
    -$ npm install @ionic-native/<$ doc.npmId $>
    -
    -
  2. -
  3. - Add this plugin to your app's module -
  4. -
- -<# --- Plugin supported platforms --- #> <@ if prop.platforms @> -

Supported platforms

-
    - <@ for platform in prop.platforms -@> -
  • <$ platform $>
  • - <@- endfor @> -
-<@ endif @> <@ endfor @> <@ endif -@> <# --- end of: if doc.decorators --- #> <# --- Plugin usage --- #> <@ if doc.usage -@> -

Usage

-<$ doc.usage | marked $> <@ endif @> <# --- Plugin attributes --- #> <@- if doc.properties -@> -

Attributes:

- - - - - <@ set hasTypes = false @> <@ for prop in doc.properties @> <@ if prop.type @> <@ set hasTypes = true @> <@ endif - @> <@ endfor @> <@ if hasTypes @> - - <@ endif @> - - - - - <@- for prop in doc.properties -@> - - - <@ if hasTypes @> - - <@ endif @> - - - <@ endfor -@> - -
AttributeTypeDescription
<$ prop.name $><$ prop.type.name $><$ prop.description $>
-<@- endif -@> <# --- Plugin class documentation --- #> <$ documentClass(doc) $> <# --- Advanced usage --- #> <@- if -doc.advanced -@> -

Advanced

-<$ doc.advanced | marked $> <@- endif -@> <# --- Other classes --- #> <@- for tag in doc.tags.tags -@> <@- if -tag.tagName == 'classes' -@> <@- set classes = tag.description.split('\n') -@> <@- for item in classes -@> <@- if -item.length > 1 -@> <@- for export in doc.moduleDoc.exports -@> <@- if export.name == item -@> -

<$ item $>

-<$ documentClass(export) $> <@- endif -@> <@- endfor -@> <@- endif -@> <@- endfor -@> <@- endif -@> <@- endfor -@> <# ---- Other interfaces --- #> <@ for tag in doc.tags.tags -@> <@ if tag.tagName == 'interfaces' @> <@ set interfaces = -tag.description.split('\n') @> <@ for item in interfaces -@> <@ if item.length > 1 @> -

<$ item $>

-<$ interfaceTable(item) $> <@ endif @> <@- endfor @> <@ endif @> <@- endfor @> <# --- Related links --- #> <@- if -doc.see @> -

Related

-<@ for s in doc.see @> <$ s | safe $> <@- endfor -@> <@- endif -@> diff --git a/scripts/docs/dgeni/templates/native_menu.template.html b/scripts/docs/dgeni/templates/native_menu.template.html deleted file mode 100644 index bf745db88..000000000 --- a/scripts/docs/dgeni/templates/native_menu.template.html +++ /dev/null @@ -1,14 +0,0 @@ -
  • - Overview -
  • -
  • - Browser Usage -
  • -<@- for doc in docs @><@ if doc.URL and doc.private != true @> -
  • - <$ doc.name $><@ if doc.paid == true @> <@ endif @><@ if doc.beta == true @> - β<@ endif @> -
  • -<@ endif @><@ endfor @> diff --git a/scripts/docs/dgeni/templates/readme.template.md b/scripts/docs/dgeni/templates/readme.template.md deleted file mode 100644 index 06b1fa450..000000000 --- a/scripts/docs/dgeni/templates/readme.template.md +++ /dev/null @@ -1,36 +0,0 @@ -# <$ doc.name $> - -<@- 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 cordova plugin add <$ prop.plugin $><@ endif @> -$ npm install @awesome-cordova-plugins/<$ doc.npmId|replace('plugins/','') $> -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@awesome-cordova-plugins/plugins/','') $>) - -Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>) - -<$ doc.description $> - -<@- if prop.platforms @> - -## Supported platforms - -<@ for platform in prop.platforms -@> - -- <$ platform $> - <@ endfor @> - -<@ endif -@> - -<@ endfor @> diff --git a/scripts/docs/generate-readmes.ts b/scripts/docs/generate-readmes.ts new file mode 100644 index 000000000..ebc81a779 --- /dev/null +++ b/scripts/docs/generate-readmes.ts @@ -0,0 +1,257 @@ +import { + Application, + Converter, + Context, + ReflectionKind, + DeclarationReflection, + CommentTag, + ProjectReflection, + LogLevel, +} from 'typedoc'; +import { cpSync, mkdirSync, writeFileSync } from 'node:fs'; +import { resolve, join } from 'node:path'; +import { + Node, + Symbol as TsSymbol, + isClassDeclaration, + isCallExpression, + isIdentifier, + isObjectLiteralExpression, + isPropertyAssignment, + isStringLiteral, + isNumericLiteral, + isArrayLiteralExpression, + getDecorators, + SyntaxKind, +} from 'typescript'; + +const ROOT = resolve(__dirname, '../..'); +const PLUGINS_SRC = join(ROOT, 'src/@awesome-cordova-plugins/plugins'); +const DOCS_OUT = join(ROOT, 'docs/plugins'); + +interface PluginMeta { + pluginName?: string; + plugin?: string; + pluginRef?: string; + repo?: string; + platforms?: string[]; + install?: string; +} + +// Map from reflection id to extracted decorator metadata +const pluginMetaMap = new Map(); + +function parseLiteralValue(node: Node): string | number | boolean | string[] | undefined { + if (isStringLiteral(node)) return node.text; + if (isNumericLiteral(node)) return Number(node.text); + if (node.kind === SyntaxKind.TrueKeyword) return true; + if (node.kind === SyntaxKind.FalseKeyword) return false; + if (isArrayLiteralExpression(node)) { + return node.elements.map((el) => { + const val = parseLiteralValue(el); + return typeof val === 'string' ? val : String(val); + }); + } + return undefined; +} + +function extractPluginMeta(symbol: TsSymbol | undefined): PluginMeta | undefined { + if (!symbol) return undefined; + const decl = symbol.declarations?.[0]; + if (!decl || !isClassDeclaration(decl)) return undefined; + + const decorators = getDecorators(decl); + if (!decorators) return undefined; + + const pluginDec = decorators.find((d) => { + const expr = d.expression; + return isCallExpression(expr) && isIdentifier(expr.expression) && expr.expression.text === 'Plugin'; + }); + if (!pluginDec) return undefined; + + const callExpr = pluginDec.expression; + if (!isCallExpression(callExpr)) return undefined; + + const args = callExpr.arguments[0]; + if (!args || !isObjectLiteralExpression(args)) return undefined; + + const meta: Record = {}; + for (const prop of args.properties) { + if (!isPropertyAssignment(prop) || !isIdentifier(prop.name)) continue; + meta[prop.name.text] = parseLiteralValue(prop.initializer); + } + return meta as unknown as PluginMeta; +} + +function getCommentText(reflection: DeclarationReflection): string { + if (!reflection.comment) return ''; + + // Prefer summary text (text before any block tags) + const summary = reflection.comment.summary + .map((part) => part.text) + .join('') + .trim(); + + if (summary) return summary; + + // Fall back to @description block tag (used by most plugins) + const descTag = reflection.comment.blockTags?.find((t: CommentTag) => t.tag === '@description'); + if (descTag) { + return descTag.content + .map((part) => part.text) + .join('') + .trim(); + } + + return ''; +} + +function getTagValue(reflection: DeclarationReflection, tagName: string): string | undefined { + if (!reflection.comment) return undefined; + const tag = reflection.comment.blockTags?.find((t: CommentTag) => t.tag === `@${tagName}`); + if (!tag) return undefined; + return tag.content + .map((part) => part.text) + .join('') + .trim(); +} + +function generateReadme(name: string, pluginSlug: string, description: string, meta: PluginMeta): string { + const installCmd = meta.install ?? `ionic cordova plugin add ${meta.plugin ?? 'PLUGIN_NAME'}`; + const npmPkg = `@awesome-cordova-plugins/${pluginSlug}`; + + let readme = `# ${name}\n\n`; + + readme += '```\n'; + readme += `$ ${installCmd}\n`; + readme += `$ npm install ${npmPkg}\n`; + readme += '```\n\n'; + + readme += `## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/${pluginSlug}/)\n\n`; + + if (meta.repo) { + readme += `Plugin Repo: [${meta.repo}](${meta.repo})\n\n`; + } + + if (description) { + readme += `${description}\n\n`; + } + + if (meta.platforms && meta.platforms.length > 0) { + readme += '## Supported platforms\n\n'; + for (const platform of meta.platforms) { + readme += `- ${platform}\n`; + } + readme += '\n'; + } + + return readme; +} + +// Custom JSDoc block tags used by plugin source files (rendered in Gitbook) +const CUSTOM_BLOCK_TAGS = [ + '@advanced', + '@author', + '@capacitorincompatible', + '@classes', + '@description', + '@enums', + '@interfaces', + '@Interfaces', + '@kind', + '@link', + '@name', + '@note', + '@paid', + '@platform', + '@premier', + '@return', + '@static', + '@usage', + '@warning', +] as const; + +// TypeDoc default block tags + project-specific custom tags for Gitbook +const BLOCK_TAGS = [ + '@param', '@returns', '@template', '@typeParam', '@module', '@inheritDoc', + '@group', '@category', '@categoryDescription', '@groupDescription', + '@defaultValue', '@default', '@example', '@remarks', '@see', '@throws', + '@since', '@deprecated', '@overload', '@enum', '@typedef', '@callback', + '@prop', '@property', '@satisfies', '@import', '@type', '@hidden', + '@ignore', '@internal', '@packageDocumentation', '@document', '@license', + '@private', '@protected', '@public', + ...CUSTOM_BLOCK_TAGS, +] as const; + +async function main(): Promise { + // TypeDoc's CJS type exports map several option fields to incorrect types (e.g. `string` instead of + // `boolean` or `object`). The `unknown` cast works around this without affecting runtime behavior. + const app = await Application.bootstrapWithPlugins({ + entryPoints: [`${PLUGINS_SRC}/*/index.ts`], + tsconfig: join(ROOT, 'tsconfig.json'), + skipErrorChecking: true, + logLevel: LogLevel.Error, + blockTags: [...BLOCK_TAGS], + inlineTags: ['@link', '@inheritDoc', '@label', '@code', '@type'], + validation: { notDocumented: false, invalidLink: false }, + } as unknown as Parameters[0]); + + // Extract @Plugin() decorator metadata during TypeScript conversion + app.converter.on( + Converter.EVENT_CREATE_DECLARATION, + (context: Context, reflection: DeclarationReflection) => { + if (reflection.kind !== ReflectionKind.Class) return; + + const symbol = context.getSymbolFromReflection(reflection); + if (!symbol) return; + + const meta = extractPluginMeta(symbol); + if (meta) { + pluginMetaMap.set(reflection.id, meta); + } + } + ); + + const project: ProjectReflection | undefined = await app.convert(); + if (!project) { + console.error('TypeDoc conversion failed'); + process.exit(1); + } + + // Copy root README to core docs + const coreDocsDir = join(DOCS_OUT, 'core'); + mkdirSync(coreDocsDir, { recursive: true }); + cpSync(join(ROOT, 'README.md'), join(coreDocsDir, 'README.md')); + + let count = 0; + + for (const reflection of project.getReflectionsByKind(ReflectionKind.Class)) { + const classRef = reflection as DeclarationReflection; + const meta = pluginMetaMap.get(classRef.id); + + if (!meta || !meta.plugin) continue; + + // Extract plugin slug from source file path + // Use @awesome-cordova-plugins/plugins/ prefix to avoid matching "awesome-cordova-plugins/src/" + const sourcePath = classRef.sources?.[0]?.fullFileName ?? ''; + const slugMatch = sourcePath.match(/@awesome-cordova-plugins\/plugins\/([^/]+)\//); + if (!slugMatch) continue; + const pluginSlug = slugMatch[1]; + + const pluginName = getTagValue(classRef, 'name') ?? classRef.name; + const description = getCommentText(classRef); + + const readmeContent = generateReadme(pluginName, pluginSlug, description, meta); + const outDir = join(DOCS_OUT, pluginSlug); + mkdirSync(outDir, { recursive: true }); + writeFileSync(join(outDir, 'README.md'), readmeContent, 'utf-8'); + count++; + } + + console.log(`${count} README files generated`); +} + +main().catch((err: unknown) => { + console.error(err); + process.exit(1); +}); diff --git a/scripts/docs/gulp-tasks.js b/scripts/docs/gulp-tasks.js deleted file mode 100644 index d69d40f06..000000000 --- a/scripts/docs/gulp-tasks.js +++ /dev/null @@ -1,36 +0,0 @@ -'use strict'; -const config = require('./config.json'), - projectPackage = require('../../package.json'), - path = require('path'), - fs = require('fs-extra'), - Dgeni = require('dgeni'); - -module.exports = (gulp) => { - gulp.task('docs', () => { - try { - const ionicPackage = require('./dgeni/dgeni-config')(projectPackage.version), - dgeni = new Dgeni([ionicPackage]); - - return dgeni.generate().then((docs) => console.log(docs.length + ' docs generated')); - } catch (err) { - console.log(err.stack); - } - }); - - gulp.task('readmes', () => { - fs.copySync( - path.resolve(__dirname, '..', '..', 'README.md'), - path.resolve(__dirname, '..', '..', config.pluginDir, 'core', 'README.md') - ); - - try { - const ionicPackage = require('./dgeni/dgeni-readmes-config')(projectPackage.version), - dgeni = new Dgeni([ionicPackage]); - return dgeni.generate().then((docs) => { - console.log(docs.length + ' README files generated'); - }); - } catch (err) { - console.log(err.stack); - } - }); -};