react-native-notifications-utils
react-native-notifications-utils copied to clipboard
react native (native module) notifications utils, for making notifications easier
react-native-notifications-utils
✨ Features
-
Opening App Notifications Settings for Android and iOS
-
Typescript
-
Built for already in production app
🧱 Installation
yarn add react-native-notifications-utils
iOS
📝 NOTE: requires Xcode 14+ (iOS 16)
cd ios && pod install
⚙️ Usage
import NotificationsUtils from "react-native-notifications-utils";
// ...
NotificationsUtils.openSettings();
📜 API
openSettings(channelId?: string)
API used to open the Platform specific System settings for the application.
| Parameter | Type | Description | Android | iOS |
|---|---|---|---|---|
| channelId | string |
The channel id to open the settings for. If not provided, the default channel will be used. | ✅ | ❌ |
-
On Android:
- API version is >= 26 with
channelIdwill open the channel settings. ifchannelIis not provided, the app's notification settings will be opened. - API version is < 26, the application settings screen is opened
- API version is >= 26 with
-
On iOS:
- If the version of iOS is >= 15.4, the app's notification settings screen is displayed.
- If the version of iOS is < 15.4, the app's settings screen is displayed.
- for further details, see:
🫂 Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
Author
License
MIT
TODO:
-
[ ] Add tests
-
[ ] Add support for request permissions
-
[ ] Keeps updated with new native features
Made with create-react-native-library