How To Use a Capacitor Plugin
Ionic Portals uses Capacitor under the hood, meaning that you can use Capacitor Plugins in your Portals. This means you can take advantage of our suite of Capacitor Core Plugins in your Portals, as well as any plugins made by the community. These plugins allow Portals to use native functionality with minimal configuration by the native developer or the web developer.
Core Plugins
Capacitor Core Plugins are plugins built by the Capacitor team and provided for you to use conveniently through public repositories.
Android Native Usage
In order to use a Capacitor Core Plugin, you need to install the plugin as a dependency in your build.gradle file.
dependencies {
implementation 'io.ionic:portals:0.10.2'
implementation 'com.capacitorjs.preferences:6.0.0'
}
To avoid errors, make sure that the versions in your build.gradle and package.json match!
Next, include it via the PortalBuilder.setPlugins() or PortalBuilder.addPlugin() functions.
- Kotlin
- Java
var builder: PortalBuilder = someValue
builder = builder.addPlugin(MyPlugin::class.java)
PortalBuilder builder = someValue;
builder = builder.addPlugin(MyPlugin.class)
Published Plugins
In MavenCentral, the Capacitor plugins are prepended with com.capacitorjs. For example, the @capacitor/preferences plugin on npm is named com.capacitorjs:preferences on Maven. The following Plugins are available in MavenCentral.
The Action Sheet API provides access to native Action Sheets, which come up from the bottom of the screen and display actions a user can take.
The App API handles high level App state and events. For example, this API emits events when the app enters and leaves the foreground, handles deeplinks, opens other apps, and manages persisted plugin state.
The AppLauncher API allows the opening of other apps.
The Browser API provides the capability to open an in-app browser and subscribe to browser events.
The Camera API provides the capability to take a photo with the camera or to choose photos from the photo album.
The Clipboard API enables copy and pasting to/from the system clipboard.
The Device API exposes internal information about the device, such as the model and operating system version, along with user information such as unique ids.
The Dialog API provides methods for triggering native dialog windows for alerts, confirmations, and input prompts.
The Filesystem API provides a NodeJS-like API for working with files on the device.
The Geolocation API provides simple methods for getting and tracking the current position of the device using GPS, along with altitude, heading, and speed information if available.
The Haptics API provides physical feedback to the user through touch or vibration.
The Keyboard API provides keyboard display and visibility control, along with event tracking when the keyboard shows and hides.
com.capacitorjs:local-notifications
The Local Notifications API provides a way to schedule device notifications locally (i.e. without a server sending push notifications).
The Network API provides network and connectivity information.
The Preferences API provides a simple key/value persistent store for lightweight data.
com.capacitorjs:push-notifications
The Push Notifications API provides access to native push notifications.
The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.
The Share API provides methods for sharing content to any sharing-enabled apps that the user may have installed.
The Splash Screen API provides methods for showing or hiding a Splash image.
The StatusBar API Provides methods for configuring the style of the Status Bar, along with showing or hiding it.
The Text Zoom API provides the ability to change Web View text size for visual accessibility.
The Toast API provides a notification pop up for displaying important information to a user. Just like real toast!
Web Usage
Web Developers need to install the web dependencies of the plugins from npm. The packages are listed under the @capacitor scope. To install a plugin, run npm i @capacitor/<plugin_name> from the root of your web project.
To avoid errors, make sure that the versions in your Podfile, build.gradle, and package.json all match!
For more information on how to use Capacitor Plugins in your web application, check out the Capacitor Plugin docs.
Other Plugins
Any plugin built for Capacitor can be linked in to a project using Portals even if it is not available through public native repositories like the core plugins are.
Download the Plugin
Get the source code for the plugin and integrate it into your web app. If it is a Capacitor plugin, it is likely that it will be available through NPM.
npm i @capacitor-community/stripe
Link the Plugin Natively
The native code from the plugin needs to be made available to each native project using Portals.
In your project settings.gradle file, define a path to the plugin android native project code.
include ':capacitor-plugin-name'
project(':capacitor-plugin-name').projectDir = new File('../../webapp/node_modules/@custom-capacitor/plugin/android')
Then in your project module level build.gradle file, add the project to the dependencies.
dependencies {
implementation project(':capacitor-plugin-name')
implementation 'io.ionic:portals:0.10.2'
//...
}
If successful, you should now see a section in the Android Studio project browser for your plugin, be able to browse its source code, and reference classes in the plugin within your native application source code.
Register the Plugin
Register the plugin with a portal to use it.
- Kotlin
- Java
class MyApplication : Application() {
override fun onCreate(): Unit {
super.onCreate()
PortalManager.register("YOUR_PORTALS_KEY")
val portalId = "MY_FIRST_PORTAL"
PortalManager.newPortal(portalId)
.addPlugin(MyCapacitorPlugin::class.java)
.create()
}
}
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
PortalManager.register("YOUR_PORTALS_KEY");
String portalId = "MY_FIRST_PORTAL";
PortalManager.newPortal(portalId)
.addPlugin(MyCapacitorPlugin.class)
.create();
}
}