npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@flipgive/react-native-rewards

v0.21.1

Published

React native module for rewards partners

Downloads

411

Readme

@flipgive/react-native-rewards

A React Native module for rewards partners, providing seamless integration of reward systems into your mobile app.

npm license downloads

Architecture Diagram

Arch

Tokens

Only EXPO_PUBLIC_US_DEFAULT_REWARDS_TOKEN is needed for single country configuration.

🚀 Installation

npm install @flipgive/react-native-rewards

or

yarn add @flipgive/react-native-rewards

or

pnpm add @flipgive/react-native-rewards

Requirements

To use this package, ensure you have the following components installed in your project:

Peer Dependencies

These dependencies need to be manually installed in your project:

  • expo-secure-store
  • react-native-webview
  • axios

Usage

Here's a quick example to get you started:

import { SafeAreaView, StyleSheet } from 'react-native';
import { ShopRewards } from '@flipgive/react-native-rewards';

export default function App() {
  return (
    <SafeAreaView style={styles.container}>
      <ShopRewards
        keys={{
          REWARDS_PROPS_US_DEFAULT_REWARDS_TOKEN: process.env.EXPO_PUBLIC_US_DEFAULT_REWARDS_TOKEN || '',
          REWARDS_PROPS_CA_DEFAULT_REWARDS_TOKEN: process.env.EXPO_PUBLIC_CA_DEFAULT_REWARDS_TOKEN || '',
          REWARDS_PROPS_BASE_URL: process.env.EXPO_PUBLIC_BASE_URL || '',
          REWARDS_PROPS_GOOGLE_API_KEY: process.env.EXPO_PUBLIC_GOOGLE_API_KEY || '',
          REWARDS_PROPS_API_URL: process.env.EXPO_PUBLIC_API_URL || '',
          REWARDS_PROPS_X_REWARDS_PARTNER_ID: process.env.EXPO_PUBLIC_X_REWARDS_PARTNER_ID || '',
        }}
      />
    </SafeAreaView>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
  },
});

for more information go to the examples folder.

For now it is necessary to use this entry point for all imports until the split imports task is completed.

import { ShopRewards..... } from '@flipgive/react-native-rewards'

This package is compatible with expo go - expo snacks

Shop rewards - RewardsTypes

Keys

| Property | Type | Required | | -------------------------------------- | ------ | -------- | | REWARDS_PROPS_US_DEFAULT_REWARDS_TOKEN | string | No | | REWARDS_PROPS_CA_DEFAULT_REWARDS_TOKEN | string | No | | REWARDS_PROPS_BASE_URL | string | Yes | | REWARDS_PROPS_GOOGLE_API_KEY | string | No | | REWARDS_PROPS_API_URL | string | Yes | | REWARDS_PROPS_X_REWARDS_PARTNER_ID | string | Yes |

Theme

| Property | Type | Required | | -------- | -------------------------- | -------- | | colors | Partial | No |

Custom Components

| Component | Type | Required | | -------------------------- | ---------------------------------- | -------- | | CustomCountryPicker | ComponentType | No | | CustomSignUpScreen | ComponentType | No | | CustomSignInScreen | ComponentType | No | | CustomCreateTeamScreen | ComponentType | No | | CustomLogoutScreen | ComponentType | No | | CustomWebViewShop | ComponentType<{ baseURL: string }> | No | | CustomModalLoader | ComponentType | No | | CustomInitialScreen | ComponentType | No | | CustomForgotPasswordScreen | ComponentType | No |

Options

| Property | Type | Required | Description | | ------------------- | ------- | -------- | -------------------------------------------------------------- | | shouldResetKeychain | boolean | No | | | showWebDebugOptions | boolean | No | Enables debug buttons for webview messages: login/logout/optIn |

Custom Methods

customMethods

| Property | Type | Required | | ----------------------- | ------------------------------------------------------------------ | -------- | | onNavigationStateChange | (navState: WebViewNavigation) => void; | No | | onDeleteUserAccount | (error?: unknown; response?: DeleteUserResponse or null;) => void; | No | | onWindowOpen | (url: string) => void; | No |

📚 API Reference

Components

| Component | Description | | --------------------- | ---------------------------------- | | ShopRewards | Main component to display rewards. | | ShopRewardsProvider | Highly Customizable Store Provider | | FadeWrapper | fade animation wrapper for views |

Hooks

| Hook | Description | | --------------------- | ------------------------------------------------------------------------------------------------------------ | | useSignUpForm | Hook for managing sign-up form. | | useSignInForm | Hook for managing sign-in form. | | useCountrySelect | Hook for selecting countries. | | useCreateTeamForm | Hook for managing team creation form. | | useGetCategories | Hook for fetching categories. | | useCityAutocomplete | Hook for city autocomplete feature - google api. | | useHost | Hook for context usage | | useLoadKeysToEnv | Hook for Resetting Environment and Local Storage on New Props | | useResetPassword | Hook for resetting password | | useUpdateDeviceInfo | Hook for register push token into our cloud solution, updateDeviceInfo({ device: { fcm_token: '1234' } }) |

Context

| Componet | Description | | -------------- | ------------- | | HostProvider | Bare provider |

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

This library is distributed under the Apache License, version 2.0

copyright 2023. FlipGive, inc. all rights reserved.

licensed under the apache license, version 2.0 (the "license");
you may not use this file except in compliance with the license.
you may obtain a copy of the license at

    http://www.apache.org/licenses/license-2.0

unless required by applicable law or agreed to in writing, software
distributed under the license is distributed on an "as is" basis,
without warranties or conditions of any kind, either express or implied.
see the license for the specific language governing permissions and
limitations under the license.

TODO

  • Test
  • Split modules (working on example app, but not in npm package import)

Made with ❤️ by create-react-native-library.