1.0.0 • Published 11 months ago

react-native-app-update-alert v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

📲 React Native App Update Alert Function

🌟 Description

This function meticulously monitors updates for your mobile app by comparing the local version with the latest versions available on iOS and Android app stores. It intuitively alerts users to both major and minor updates, seamlessly guiding them through app store redirections for updates.

Props

NameTypeDescriptionDefault Value
iosStoreURLStringThe App Store URL for iOS where the app update can be downloaded.-
androidStoreURLStringThe Play Store URL for Android where the app update can be downloaded.-
countryString(Optional) Country code to specify the country for regional app store updates. Default is "us"."us"
majorUpdateTitleStringTitle for the major update alert."Update Required"
majorUpdateMessageStringMessage for the major update alert."A major update is available. Please update your app to continue using it."
minorUpdateTitleStringTitle for the minor update alert."Update Available"
minorUpdateMessageStringMessage for the minor update alert."A minor update is available. Would you like to update now?"
minorUpdateButtonTextStringText for the button in the minor update alert to postpone the update."Later"
minorUpdateButtonStyleStringStyle for the button in the minor update alert ("cancel" or "default")."cancel"

Example Usage

import checkForAppUpdate from './path/to/checkForAppUpdate';

const YourComponent = () => {
  // Example usage with required props
  useEffect(() => {
    checkForAppUpdate({
      iosStoreURL: "https://apps.apple.com/app-id",
      androidStoreURL: "https://play.google.com/store/apps/details?id=your.package.name",
    });
  }, []);

  // Your component's UI or logic
  return (
    // Your component's JSX
  );
};

🚀 Contributions and License

Contributions are welcome! Feel free to fork the repository, create pull requests, and suggest new features or improvements. Please ensure to follow the guidelines in the CONTRIBUTING.md file.

This project is licensed under the MIT License.

Created By