GuidesAPI ReferenceChangelog
Log In
Hey! These docs are for version 2021-07-28, which is no longer officially supported. Click here for the latest version, 2023-11-22!

Pinwheel Link can be initialized and opened with a recently generated Link token. Additionally, you can pass in callback functions to handle events such as success and error.

# Javascript

You have the option of adding the Pinwheel Link modal to your app using a script tag or, if you are using React, you can simply install our React package.

## React

Pinwheel's React package can be installed using [npm](🔗).

Then add it to your React app.

The `open` prop is a boolean to describe whether the modal is open or not. See additional props [here](🔗).

## Script Tag (Direct Integration)

To use the Link modal directly without an SDK, simply include the script below. The Pinwheel Link modal will be appended to the document body through an iframe that is loaded in the DOM.

##### ``

This method opens the modal. It takes one parameter object of type [InitializationParams](🔗).


##### `Pinwheel.close()`

This method closes the modal.

# React Native

## Installation

You can find the npm package [here](🔗).

## Usage

The `PinwheelLink` component is a view that you can integrate into your app's flow. The Link token and optional callback handlers are passed in as props.

You can see a full list of props and optional callbacks [here](🔗).

# Android

You can find the source code for the Android SDK [here](🔗).

## Installation

The Pinwheel Android SDK is available via [Maven Central Repository](🔗) and [GitHub Packages](🔗).

### Maven Central Repository

To install the SDK using the Maven Central Repository

  1. Add `mavenCentral` to your app's `build.gradle` repositories block

  1. Add the package to your dependencies:

  1. Sync your Android gradle project and the library should be ready to use.

### GitHub Package

To install the SDK using GitHub packages:

  1. Generate a personal access token [on GitHub](🔗) with the `read:packages` scope.

  2. Store your credentials in a file named ``:


There are other ways to do this, e.g., environment vars, etc.

  1. Add the GitHub repository to your app's `build.gradle` file:

  1. Add the package to your dependencies:

  1. Sync your Android gradle project and the library should be ready to use.

Make sure that the minimum Android SDK version, minSdkVersion, in your app is 22 or greater.

## Usage

### PinwheelFragment

The Pinwheel Android SDK provides the `PinwheelFragment` that takes `linkToken` as an argument.

### PinwheelEventListener

To listen for the events coming from Link, implement `PinwheelEventListener`. Then simply provide the instance of the listener to `PinwheelFragment` by setting the `pinwheelEventListener` field.

You can find the type definitions [here](🔗).

# iOS

The iOS SDK's main interface is a `UIViewController` that you can integrate into your app as you would any `UIViewController`, e.g., presented as a modal, or used with a `UINavigationController`. Additionally, you can implement the `PinwheelDelegate` protocol to receive events throughout the `PinwheelViewController`'s lifecycle.

## Installation

The Pinwheel iOS SDK is available via [Swift Package Manager](🔗) and [CocoaPods](🔗). We recommend pinning to a specific version, thereby giving you explicit control over upgrades.

### Swift Package Manager

**Xcode UI**:

From either the File menu, or the Swift Packages section of the project settings, use the XCode UI to add: `` as a package dependency, and pin the version.

XCode UI Choose Screen

XCode UI Version Screen

XCode UI Target Screen


Add `.package(url: "", .exact("2.3.11"))` to your dependencies:

### CocoaPods

To install the SDK with CocoaPods, add `PinwheelSDK` as one of your target dependencies in your Podfile:

Please be sure to run `pod update` and use `pod install --repo-update` to ensure you have the most recent version of the SDK installed.

## Usage

### PinwheelViewController

The `PinwheelViewController` is a `UIViewController` that you can present as a modal.

### PinwheelDelegate

The `PinwheelDelegate` protocol is set up such that every event goes through the `onEvent(name: event:)` handler, and convenience callback methods are provided for the `.exit`, `.success`, `.login`, and `.error` events. Note that the `onEvent(name: event:)` handler will still be called alongside the convenience methods.

You can see a full descriptions of props and optional callbacks [here](🔗). Callback types can be found in [Github](🔗).

## Example Project

To run the example project, clone the [repo](🔗), and run `pod install` from the Example directory first. Then, add your API secret to the top of the `LinkToken.swift` file. In your app, you should fetch the Link token from your server. **_Never_** include your API secret in your app.

# Flutter

## Installation

  1. **Add the dependency to `pubspec.yaml`.**

## Usage

  1. **Import the Pinwheel widget, and models.**

  1. **Implement any callbacks, these are all optional.**

Details for the callbacks, and model objects can be found in the [lib/models.dart](🔗), and [lib/pinwheel.dart](🔗) files.

Read more about Link events at our [Link overview page](🔗).

  1. **Fetch the Link token from your server.**

Read more about Link tokens in the [Implementation overview on our docs site](🔗). **Do not include your API secret, and fetch Link tokens directly from your app.**

  1. **Initialize the PinwheelLink StatefulWidget.**

  1. **Show the widget**

`PinwheelLink` is a `StatefulWidget` that you can display and hide in your app's view hierarchy.

## Build requirements

### Android

  • Android minSdkVersion is API 22 or higher.

  • Android Target SDK version: API 30.

  • Android SDK build tools: 26.0.3

  • Android Gradle Plugin: 3.0.0 or greater.

### iOS

  • Xcode version: 9.1 or greater.

  • iOS Base SDK: 11.1 or greater.

  • Deployment target: iOS 11.0 or greater.

<br /> <hr />

Please contact [[email protected]](🔗) for access to our [Developer Dashboard](🔗).