react-native-notification-badge's Introduction

react-native-notification-badge

For when you don't want to use a fully featured notification manager

A very simple notification badge count manager for React Native that just works.

API

`getBadgeCount`

Asynchronously returns the current Badge count.

Note: If no notification permissions have been granted yet, this will also ask the user for notification permissions (only [.badge]), so request permissions before calling this using a library like react-native-permissions

const badgeCount = await getBadgeCount()

`getBadgeCountSync`

Same as getBadgeCount, but synchronously.

const badgeCount = getBadgeCountSync()

`setBadgeCount`

Asynchronously sets the Badge count.

await setBadgeCount(2)

`getNotificationBadgeSetting`

Asynchronously gets the current state of the "Notification Badge" permission setting.

Possible values are: 'enabled' | 'disabled' | 'notSupported' | 'unknown'

const permission = await getNotificationBadgeSetting()
if (permission === 'enabled') {
  await setBadgeCount(5)
} else {
  console.log("Badge permission has not yet been granted. I'll ask the user later")
}

`requestNotificationPermissions`

Asynchronously request the user to grant the specified permissions.

const granted = await requestNotificationPermissions(['badge', 'alert', 'sound'])

`removeNotificationsWithThreadId`

Remove all notification with the given Thread ID from the User's Notification Center.

The Thread ID is a property in the APNS payload which can be used to group notifications in iOS 10.0 or higher.

Returns the count of notifications that were removed.

const removed = await removeNotificationsWithThreadId('group-chat-2')

Other

Check out my other react-native libraries:

react-native-blurhash: 🖼️ Give your users the loading experience they want.
react-native-google-nearby-messages: 📲 Communicate with nearby devices using Bluetooth, BLE, WiFi and near-ultrasonic audio. Broadcast and receive small payloads (like strings) using the easy-to-use React Native API!
react-native-sectioned-slider: An iOS 11 Control Center inspired Slider for React Native

react-native-notification-badge's People

Contributors

Stargazers

Watchers

react-native-notification-badge's Issues

Is it possible to upgrade to react 18?

When installing packages I get the following error

npm ERR! Could not resolve dependency:
npm ERR! peer react@"^16.8.1" from [email protected]
npm ERR! node_modules/react-native-notification-badge
npm ERR!   react-native-notification-badge@"^1.0.5" from the root project

would it be possible to upgrade this package to use react@18?

Thanks!