2.2.9 • Published 2 years ago

react-native-hook-notification v2.2.9

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

React Native Hook Notification

Add notifications in your React Native app. Types: success, error, warning, info, default or custom.

  • Compatible with Reanimated v2.
  • Compatible with Expo.
  • Written in TypeScript.

Install

npm install react-native-hook-notification

or

yarn add react-native-hook-notification

Dependencies​

This library needs these dependencies to be installed in your project before you can use it:

npm install react-native-reanimated react-native-gesture-handler

or

yarn add react-native-reanimated react-native-gesture-handler

ℹ️ INFO

React Native Gesture Handler needs extra steps to finalize its installation, please follow their installation instructions.

React Native Reanimated v2 needs extra steps to finalize its installation, please follow their installation instructions.

Usage

  • In the application index file:
import React from 'react';
import { NotificationContainer } from 'react-native-hook-notification';

import { Component } from './component/Component';

export default function App() {
  return (
    <>
      <Component />
      <NotificationContainer />
    </>
  );
}
  • In the component:
import React from 'react';
import { TouchableOpacity, Text } from 'react-native';
import { useNotification } from 'react-native-hook-notification';

export default function Component() {
  const notification = useNotification();

  return (
    <TouchableOpacity
      onPress={() =>
        notification.success({
          text: 'Notification test',
        })
      }
    >
      <Text>Dispatch</Text>
    </TouchableOpacity>
  );
}

Props

PropertyTypeRequiredDefaultDescription
textstringyesNotification text
titlestringnoNotification title
positiontop-right | top-center | top-left | bottom-right | bottom-center | bottom-leftnotop-rightNotification position
themecolored | light | darknocoloredNotification theme
transitionbounce | flip | fade | slide | zoomnobounceNotification transition
delaynumberno5000Notification delay in milliseconds
showButtonClosebooleannofalseShow or hide close button
autoClosebooleannotrueAutomatic closing of the notification after the delay ends
pauseOnPressbooleannotrueAuto close pause on hover
closeOnPressbooleannofalseClose on press
onPress() => voidnoCalled on Notification press
draggablebooleannotrueEnable or disable drag
dragDirectionx | ynoyDrag direction
iconReact.FunctionComponentElementnoRender icon on left side. Obs.: Dimensions: 24x24
titleMaxLinesnumberno1Maximum number of lines for title
textMaxLinesnumberno2Maximum number of lines for text
xOffsetnumberno16Offset from the X axis of the screen (in px)
customStyle{ container?: StyleProp<ViewStyle>; title?: StyleProp<TextStyle>; text?: StyleProp<TextStyle>; icon?: StyleProp<ViewStyle>; button?: StyleProp<ViewStyle>;buttonText?: StyleProp<TextStyle>;}noStyles for custom notificaion type

License

License

Developed by: André Coelho

2.2.9

2 years ago

2.2.8

2 years ago

2.2.5

2 years ago

2.2.6

2 years ago

2.2.1

2 years ago

2.2.3

2 years ago

2.2.2

2 years ago

2.2.0

2 years ago

2.1.0

2 years ago

2.0.0

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.3

2 years ago

1.0.1

2 years ago