Skip to content

Commit

Permalink
refresh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danielsogl committed Jul 11, 2023
1 parent 0f6d1c8 commit ce3a3c8
Show file tree
Hide file tree
Showing 26 changed files with 361 additions and 26 deletions.
20 changes: 20 additions & 0 deletions docs/plugins/advanced-image-picker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AdvancedImagePicker

```
$ ionic cordova plugin add cordova-plugin-advanced-imagepicker
$ npm install @awesome-cordova-plugins/advanced-image-picker
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/advanced-image-picker/)

Plugin Repo: [https://github.com/EinfachHans/cordova-plugin-advanced-imagepicker](https://github.com/EinfachHans/cordova-plugin-advanced-imagepicker)

This Cordova Plugin is for a better (multiple) ImagePicker with more options.

## Supported platforms

- Android
- iOS



20 changes: 20 additions & 0 deletions docs/plugins/app-review/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# App Review

```
$ ionic cordova plugin add cordova-plugin-app-review
$ npm install @awesome-cordova-plugins/app-review
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/app-review/)

Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-app-review](https://github.com/chemerisuk/cordova-plugin-app-review)

Cordova plugin to review app

## Supported platforms

- Android
- iOS



2 changes: 1 addition & 1 deletion docs/plugins/background-upload/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BackgroundUpload

```
$ ionic cordova plugin add cordova-plugin-background-upload
$ ionic cordova plugin add @spoonconsulting/cordova-plugin-background-upload
$ npm install @awesome-cordova-plugins/background-upload
```

Expand Down
22 changes: 22 additions & 0 deletions docs/plugins/brightness/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Brightness

```
$ ionic cordova plugin add cordova-plugin-brightness
$ npm install @awesome-cordova-plugins/brightness
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/brightness/)

Plugin Repo: [https://github.com/mgcrea/cordova-plugin-brightness](https://github.com/mgcrea/cordova-plugin-brightness)

The Brightness plugin let you control the display brightness of your device.

Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness).

## Supported platforms

- Android
- iOS



5 changes: 4 additions & 1 deletion docs/plugins/browser-tab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ This plugin provides an interface to in-app browser tabs that exist on some mobi
## Supported platforms

- Android
- iOS
- iOS



4 changes: 2 additions & 2 deletions docs/plugins/camera/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Requires the Cordova plugin: `cordova-plugin-camera`. For more info, please see
[Warning] Since IOS 10 the camera requires permissions to be placed in your config.xml add
```xml
<config-file parent="NSCameraUsageDescription" platform="ios" target="*-Info.plist">
<string>You can take photos</string>
<string>You can take photos</string>
</config-file>
```
inside of the <platform name='ios> section
inside of the `<platform name='ios>` section

## Supported platforms

Expand Down
9 changes: 4 additions & 5 deletions docs/plugins/cashfree-pg/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Cashfree PG
# CFPaymentGateway

```
$ ionic cordova plugin add cordova-plugin-cashfree-pg
Expand All @@ -7,14 +7,13 @@ $ npm install @awesome-cordova-plugins/cashfree-pg

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/cashfree-pg/)

Plugin Repo: [https://github.com/cashfree/cordova-plugin-cashfree](https://github.com/cashfree/cordova-plugin-cashfree.git)
SDK Usage Documentation: [https://docs.cashfree.com/docs/cordova-integration](https://docs.cashfree.com/docs/cordova-integration)
Plugin Repo: [https://github.com/cashfree/cordova-plugin-cashfree](https://github.com/cashfree/cordova-plugin-cashfree)


Cordova Plugin that wraps Cashfree PG SDK for Android and iOS

## Supported platforms

- Android
- Android
- iOS


Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/chooser/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Chooser

```
$ ionic cordova plugin add cordova-plugin-chooser
$ ionic cordova plugin add http://github.com/MaximBelov/cordova-plugin-chooser.git
$ npm install @awesome-cordova-plugins/chooser
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/chooser/)

Plugin Repo: [https://github.com/cyph/cordova-plugin-chooser](https://github.com/cyph/cordova-plugin-chooser)
Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-chooser](https://github.com/MaximBelov/cordova-plugin-chooser)

File chooser plugin for Cordova.

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/cloud-settings/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Cloud Settings

```
$ ionic cordova plugin add cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey
$ ionic cordova plugin add @marysuon/cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey
$ npm install @awesome-cordova-plugins/cloud-settings
```

Expand Down
19 changes: 19 additions & 0 deletions docs/plugins/crop-plugin-privacy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Crop Plugin Privacy

```
$ ionic cordova plugin add cordova-plugin-crop-privacy
$ npm install @awesome-cordova-plugins/crop-plugin-privacy
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/crop-plugin-privacy/)

Plugin Repo: [https://github.com/BaraAksayeth25/cordova-plugin-crop-privacy](https://github.com/BaraAksayeth25/cordova-plugin-crop-privacy)

This plugin does something

## Supported platforms

- Android



2 changes: 1 addition & 1 deletion docs/plugins/facebook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Click `'Add Platform'`.
At this point you'll need to open your project's [`config.xml`](https://cordova.apache.org/docs/en/latest/config_ref/index.html) file, found in the root directory of your project.

Take note of the `id` for the next step:
```
```xml
<widget id="com.mycompany.testapp" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
```

Expand Down
89 changes: 89 additions & 0 deletions docs/plugins/fbsdk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# FbSdk

```
$ ionic cordova plugin add cordova-plugin-fbsdk --variable APP_ID="123456789" --variable APP_NAME="myApplication" --variable CLIENT_TOKEN="abcd1234"
$ npm install @awesome-cordova-plugins/fbsdk
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/fbsdk/)

Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-fbsdk](https://github.com/MaximBelov/cordova-plugin-fbsdk)

Use the Facebook SDK plugin to obtain access to the native FB application on iOS and Android.

Requires Cordova plugin: `cordova-plugin-fbsdk`. For more info, please see the [Facebook SDK](https://github.com/MaximBelov/cordova-plugin-fbsdk).

#### Installation

To use the FB plugin, you first have to create a new Facebook App inside of the Facebook developer portal at [https://developers.facebook.com/apps](https://developers.facebook.com/apps).

[![fb-getstarted-1](/img/docs/native/Facebook/1.png)](https://developers.facebook.com/apps/)

Retrieve the `App ID` and `App Name`.

[![fb-getstarted-2](/img/docs/native/Facebook/2.png)](https://developers.facebook.com/apps/)

Then type in the following command in your Terminal, where APP_ID and APP_NAME are the values from the Facebook Developer portal.

```bash
ionic cordova plugin add cordova-plugin-fbsdk --variable APP_ID="123456789" --variable APP_NAME="myApplication" --variable CLIENT_TOKEN="abcd1234"
```

After, you'll need to add the native platforms you'll be using to your app in the Facebook Developer portal under your app's Settings:

[![fb-getstarted-3](/img/docs/native/Facebook/3.png)](https://developers.facebook.com/apps/)

Click `'Add Platform'`.

[![fb-getstarted-4](/img/docs/native/Facebook/4.png)](https://developers.facebook.com/apps/)

At this point you'll need to open your project's [`config.xml`](https://cordova.apache.org/docs/en/latest/config_ref/index.html) file, found in the root directory of your project.

Take note of the `id` for the next step:
```
<widget id="com.mycompany.testapp" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
```

You can also edit the `id` to whatever you'd like it to be.

#### Client Access Tokens

[](https://developers.facebook.com/docs/facebook-login/guides/access-tokens#clienttokens)


#### iOS Install
Under 'Bundle ID', add the `id` from your `config.xml` file:

[![fb-getstarted-5](/img/docs/native/Facebook/5.png)](https://developers.facebook.com/apps/)


#### Android Install
Under 'Google Play Package Name', add the `id` from your `config.xml` file:

[![fb-getstarted-6](/img/docs/native/Facebook/6.png)](https://developers.facebook.com/apps/)


And that's it! You can now make calls to Facebook using the plugin.

## Events

App events allow you to understand the makeup of users engaging with your app, measure the performance of your Facebook mobile app ads, and reach specific sets of your users with Facebook mobile app ads.

- [iOS] [https://developers.facebook.com/docs/ios/app-events](https://developers.facebook.com/docs/ios/app-events)
- [Android] [https://developers.facebook.com/docs/android/app-events](https://developers.facebook.com/docs/android/app-events)
- [JS] Does not have an Events API, so the plugin functions are empty and will return an automatic success

Activation events are automatically tracked for you in the plugin.

Events are listed on the [insights page](https://www.facebook.com/insights/).

For tracking events, see `logEvent` and `logPurchase`.

## Supported platforms

- Android
- iOS
- Browser



20 changes: 20 additions & 0 deletions docs/plugins/ffmpeg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# FFMpeg

```
$ ionic cordova plugin add cordova-plugin-ffmpeg
$ npm install @awesome-cordova-plugins/ffmpeg
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/ffmpeg/)

Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-ffmpeg](https://github.com/MaximBelov/cordova-plugin-ffmpeg)

Simple plugin that binds mobile ffmpeg to execute ffmpeg commands

## Supported platforms

- Android
- iOS



19 changes: 19 additions & 0 deletions docs/plugins/file-chooser/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# FileChooser Plugin

```
$ ionic cordova plugin add cordova-plugin-filechooser
$ npm install @awesome-cordova-plugins/file-chooser
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/file-chooser/)

Plugin Repo: [https://github.com/ihadeed/cordova-filechooser](https://github.com/ihadeed/cordova-filechooser)

Cordova FileChooser Plugin

## Supported platforms

- Android



8 changes: 4 additions & 4 deletions docs/plugins/gcdwebserver/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# GCDWebServer
# gcdwebserver

```
$ ionic cordova plugin add cordova-plugin-gcdwebserver
$ ''
$ npm install @awesome-cordova-plugins/gcdwebserver
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/gcdwebserver/)

Plugin Repo: [https://github.com/xulihang/cordova-plugin-gcdwebserver](https://github.com/xulihang/cordova-plugin-gcdwebserver)

The [GCDWebServer](https://github.com/swisspol/GCDWebServer/) Plugin can start an HTTP server to serve static files.
This plugin can start an HTTP server using GCDWebServer

## Supported platforms

iOS
- iOS



20 changes: 20 additions & 0 deletions docs/plugins/image-resizer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# ImageResizer

```
$ ionic cordova plugin add cordova-plugin-image-resizer
$ npm install @awesome-cordova-plugins/image-resizer
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/image-resizer/)

Plugin Repo: [https://github.com/JoschkaSchulz/cordova-plugin-image-resizer](https://github.com/JoschkaSchulz/cordova-plugin-image-resizer)

Cordova Plugin For Image Resize

## Supported platforms

- Android
- iOS



22 changes: 22 additions & 0 deletions docs/plugins/mobile-accessibility/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Mobile Accessibility

```
$ ''
$ npm install @awesome-cordova-plugins/mobile-accessibility
```

## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/mobile-accessibility/)

Plugin Repo: [https://github.com/phonegap/phonegap-mobile-accessibility](https://github.com/phonegap/phonegap-mobile-accessibility)

This plugin exposes information on the status of various accessibility features of mobile operating systems, including, for example, whether a screen reader is running, invert colors is enabled, and the preferred scaling for text.
It also allows an application to send a string to be spoken by the screen reader, or a command to stop the screen reader from speaking.

## Supported platforms

- Android
- iOS
- Amazon Fire OS



3 changes: 1 addition & 2 deletions docs/plugins/nfc/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# UriHelper

# TextHelper
ionic cordova plugin add phonegap-nfc
$ npm install @awesome-cordova-plugins/nfc
```
Expand Down
Loading

0 comments on commit ce3a3c8

Please sign in to comment.