Skip to main content

Getting Started Guide

License​

Use of Ionic Portals requires a valid and active commercial agreement with Ionic. Contact sales to get started.

Install​

Ionic Portals is publicly available via Maven Central, Cocoapods, SPM, and NPM.

To add Portals to your Android project, add the dependency to your build.gradle files

build.gradle
// ----------------------------------------------
// Module-level build.gradle
// ----------------------------------------------
dependencies {
implementation 'io.ionic:portals:0.14.0'
}

And in the top level build.gradle file, be sure that you include jcenter and maven in your repositories section

// ----------------------------------------------
// Top-level build.gradle
// ----------------------------------------------
allprojects {
repositories {
google()

// Make sure JCenter and Maven Central are
// in your project repositories
jcenter()
mavenCentral()
}
}

To add Portals to your web project, install it via NPM:

npm install @ionic/portals@0.13.0

If you need help configuring specific versions of Portals with Capacitor or Capacitor Plugins, check out our SDK Version Compatibility page.