Wraps SKStoreProductViewController for use in react-native projects
Objective-C JavaScript Shell Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
RJHStoreViewManager.xcodeproj
ReactNativeStoreViewExample
ios
.editorconfig
.flowconfig
.gitattributes
.gitignore
.npmignore
.travis.yml
LICENSE
README.md Typo Oct 24, 2017
ReactNativeStoreView.podspec
demo.gif
index.android.js
index.ios.js
package.json

README.md

ReactNativeStoreView

Wraps SKStoreProductViewController to open items in the App Store from within react-native projects.

CI Status npm version

Demo gif

NB: v2 and v3 require React Native v0.40 or above. Use v1 for React Native <= 0.39

Installation

With link

  1. npm install --save react-native-store-view
  2. react-native link

With CocoaPods

  1. npm install --save react-native-store-view
  2. Add pod 'ReactNativeStoreView', :path => '../node_modules/react-native-store-view' to your project's Podfile, modifying the path as necessary.
  3. pod install

API

isAvailable():Promise

Resolves with a boolean indicating whether SKStoreProductViewController is available on the current platform (iOS >= 6.0). Resolves false on Android.

loadProductWithParameters(params):Promise

Load a product in the background, in preparation for displaying. Resolves when loading is complete, or rejects with an passed-through error if the underlying call fails.

params is an object with up to four properties, corresponding to SKStoreProductViewController's parameters

  • iTunesItemIdentifier (number, required)
  • affiliateToken (string, optional, iOS 8.0+)
  • campaignToken (string, optional, iOS 8.0+)
  • providerToken (string, optional, iOS 8.3+)
  • advertisingPartnerToken (string, optional, iOS 9.3+)

presentViewController(animated:boolean = true):Promise

Display the store view as a modal. Resolve when animation completes.

dismiss(animated:boolean = true):Promise

Dismiss the store programmatically (not required if the user dismisses the store). Resolve when animation completes.

addListener(eventName:string, callback:(payload: any) => any)

Add a listener for the given event (see below).

removeListener(eventName:string, callback:(payload: any) => any)

Removes the specified listener for the specified event. Be sure to pass the same function reference as passed to addListener.

once(eventName:string, callback:(payload: any) => any)

Calls the callback at most once on the next occurrence of the event. Removes the listener if the event fires.

Events

The module fires events:

  • loading - Begun loading a product in the background.
  • loaded - Product loaded and ready to present.
  • presenting - presentViewController has been called.
  • presented - presentViewController has finished animating and the store is now in the foreground.
  • dismissing - Either dismiss has been called or the user has pressed Done.
  • dismissed - dismiss has finished animating and the store is gone from view.

(NB: If listening for events in native code or when importing the module directly from NativeModules, loading becomes RJHStoreViewManagerLoading etc to avoid conflicts with other modules sharing the global emitter.)

Example usage

import React, {Component} from "react";
import {Text, View, TouchableHighlight} from "react-native";
import * as StoreViewManager from "react-native-store-view";

class ReactNativeStoreViewExample extends Component {

  dismissListener = () => console.log('Store view dismissed');

  constructor() {
    StoreViewManager.addListener('dismiss', this.dismissListener);
  }
  
  componentWillUnmount() {
    StoreViewManager.removeListener('dismiss', this.dismissListener);
  }

  render() {
    return (
      <View>
        <TouchableHighlight onPress={this.onPressButton}>
          <Text>
            Tap here to open the app store
          </Text>
        </TouchableHighlight>
      </View>
    );
  }

  onPressButton() {
    StoreViewManager.loadProductWithParameters({
      iTunesItemIdentifier: 364709193 // The only mandatory parameter is a numeric App Store ID. This one is iBooks.
      //, affiliateToken: 'string, optional, iOS 8.0+'
      //, campaignToken: 'string, optional, iOS 8.0+'
      //, providerToken: 'string, optional, iOS 8.3+'
      //, advertisingPartnerToken: 'string, optional, iOS 9.3+'
    })
      .then(() => {
        console.log('SKStoreProductViewController successfully loaded the product over the net, but is not yet displaying anything');
        StoreViewManager.presentViewController();
      })
      .then(() => {
        console.log('SKStoreProductViewController is now modal. When it is dismissed, we\'ll return to this view.');
      })
      .catch((err) => {
        console.error(err);
      });
  }
}

See the ReactNativeStoreViewExample project for more.

Known limitations

SKStoreProductViewController is not supported for use in a simulator environment, and so neither is this module. You'll need to test your application using a real device.

License

ReactNativeStoreView is available under the MIT license. See the LICENSE file for more info.