Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robhogan/react-native-store-view
Wraps SKStoreProductViewController for use in react-native projects
https://github.com/robhogan/react-native-store-view
app-store ios react-native
Last synced: 3 months ago
JSON representation
Wraps SKStoreProductViewController for use in react-native projects
- Host: GitHub
- URL: https://github.com/robhogan/react-native-store-view
- Owner: robhogan
- License: mit
- Created: 2016-02-16T16:26:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-06T15:46:33.000Z (over 6 years ago)
- Last Synced: 2024-04-23T02:37:01.202Z (9 months ago)
- Topics: app-store, ios, react-native
- Language: Objective-C
- Homepage:
- Size: 335 KB
- Stars: 32
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native - react-native-store-view ★19 - Wraps SKStoreProductViewController for use in react-native projects (Components / UI)
README
# ReactNativeStoreView
Wraps SKStoreProductViewController to open items in the App Store from within react-native projects.
[](https://travis-ci.org/rh389/react-native-store-view) [](https://badge.fury.io/js/react-native-store-view)
**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](https://developer.apple.com/documentation/storekit/skstoreproductviewcontroller/product_dictionary_keys)
- `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
```js
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 (
Tap here to open the app store
);
}
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`](https://github.com/rh389/react-native-store-view/tree/master/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.