Skip to main content

Getting Started Guide

Signup

Ionic Portals requires a product key to use. Getting a key is easy. Just head to the Ionic Dashboard and click "Get Access".

This will present you with a form asking for some additional information. After submitting the page will refresh and you will immediately see the key that can be used to unlock the use of Portals in your app.

info

You can always use this shareable link to signup for a Product Key: ionic.io/register-portals

Install

Ionic Portals is publicly available on Maven Central, Cocoapods, Carthage, and NPM.

Cocoapods

note

IonicPortals requires using Cocoapods 1.10 or greater.

To add Portals to your iOS project, put the following line to your Podfile:

Podfile
pod 'IonicPortals', '~> 0.6.3'

And then run pod install.

Swift Package Manager

Add https://github.com/ionic-team/ionic-portals-ios in the Xcode "Swift Package Dependencies" tab in the project configuration. The suggested version range is "Up to Next Minor Version" to prevent auto-updating to a breaking version before Ionic Portals iOS reaches version 1.0

Configure

After installing the dependency you need to register your copy of Ionic Portals at runtime. This works both offline and in production. You'll need to call PortalManager.register(myApiKey) before creating any Portals in your app. Below is a simple example of how to bootstrap Ionic Portals before loading any Portal instances in your app. To get an API Key, refer to the Sign Up section.

AppDelegate.swift
import IonicPortals

@main
class AppDelegate: NSObject, UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
PortalsRegistrationManager.shared.register("MY_API_KEY")
// setup portals...
return true
}
}
warning

Avoid committing your Portals key to source code repositories where it may be publicly visible! On Android, you can use the Secrets Gradle Plugin to keep it out of a public repository. On iOS, you can use an .xcconfig file to keep it out of a public repository.

Supported Platform Versions

PlatformLatest Portals VersionMinimum Supported Platform Version
iOS0.6.3iOS 13.0
Android0.6.2Android SDK 21
React Native0.1.0React Native 0.63.4