@manhtruongwang/react-native-alert-dialog NPM

react-native-alert-dialog

Example Dialog Box

Theme Light	Theme Dark

Example Toast Notification

Theme Light	Theme Dark

Installation

- Installing:

yarn add react-native-alert-dialog

- Installing dependencies:

For Native project:

yarn add react-native-safe-area-context

pod install

For Expo project:

expo install react-native-safe-area-context

Usage

import { ALERT_TYPE, Dialog, AlertNotificationRoot, Toast } from 'react-native-alert-notification';

<AlertNotificationRoot>
  <View>
    // dialog box with single button
    <Button
      title={'dialog box'}
      onPress={() =>
        Dialog.show({
          type: ALERT_TYPE.SUCCESS,
          title: 'Success',
          textBody: 'Congrats! this is dialog box success',
          button: 'close',
        })
      }
    />
    // dialog box with cancel & confirm buttons
    <Button
      title={'confirmation dialog'}
      onPress={() =>
        Dialog.show({
          type: ALERT_TYPE.WARNING,
          title: 'Confirm Action',
          textBody: 'Are you sure you want to proceed with this action?',
          cancelButton: 'Cancel',
          confirmButton: 'Proceed',
          onPressCancel: () => console.log('Action cancelled'),
          onPressConfirm: () => console.log('Action confirmed'),
        })
      }
    />
    // toast notification
    <Button
      title={'toast notification'}
      onPress={() =>
        Toast.show({
          type: ALERT_TYPE.SUCCESS,
          title: 'Success',
          textBody: 'Congrats! this is toast notification success',
          paddingTop: 45, // custom top padding
        })
      }
    />
  </View>
</AlertNotificationRoot>;

Documentation:

Root Component

A React node that will be most likely wrapping your whole app.

Name	Description	Default	Type
theme	select theme light dark (by default is auto)	auto	'light','dark'
colors	custom colors		IColors, IColors
dialogConfig	config dialog box global		{closeOnOverlayTap:bool, autoClose:bool / number}
toastConfig	config toast global		{autoClose:bool / number, titleStyle?: StyleProp , textBodyStyle?: StyleProp}

type IProps = {
  dialogConfig?: Pick<IConfigDialog, 'closeOnOverlayTap' | 'autoClose'>;
  toastConfig?: Pick<IConfigToast, 'autoClose' | 'titleStyle' | 'textBodyStyle'>;
  theme?: 'light' | 'dark';
  colors?: [IColors, IColors] /** ['light_colors' , 'dark_colors'] */;
};
type IColors = {
  label: string;
  card: string;
  overlay: string;
  success: string;
  danger: string;
  warning: string;
};

Dialog Box Component

Name	Description	Require	Default	Type
title	The title text			String
type	Defines the type ("Success", "Warning" or "Error")	true		"SUCCESS", "DANGER", "WARNING"
textBody	The text body			String
button	name button (for hide button: undefined)			String
cancelButton	Text for cancel button in dual-button layout			String
confirmButton	Text for confirm button in dual-button layout			String
autoClose	Defines time auto close dialog box in ms		face	bool / number
closeOnOverlayTap	allow close if click in overlay		true	bool
onPressButton	(if not declared and isset button action is close)		String	() => void
onPressCancel	Action when cancel button is pressed			() => void
onPressConfirm	Action when confirm button is pressed			() => void
onShow	action after end animation open			() => void
onHide	action after end animation close			() => void

type IConfig = {
  type: ALERT_TYPE;
  title?: string;
  textBody?: string;
  button?: string;
  cancelButton?: string;
  confirmButton?: string;
  autoClose?: number | boolean;
  closeOnOverlayTap?: boolean;
  onPressButton?: () => void;
  onPressCancel?: () => void;
  onPressConfirm?: () => void;
  onShow?: () => void;
  onHide?: () => void;
};

Toast Notification Component

Name	Description	Default	Type
title	The title text		String
type	Defines the type ("Success", "Warning" or "Error")		"SUCCESS", "DANGER", "WARNING"
textBody	The text body		String
autoClose	Defines time auto close dialog box in ms	5000	bool / number
paddingTop	Specify custom top padding	0	number
onPress	action click in card		bool
onShow	event after end animation open		() => void
onHide	event after end animation close		() => void

type IConfig = {
  type?: ALERT_TYPE;
  title?: string;
  textBody?: string;
  autoClose?: number | boolean;
  paddingTop?: number;
  titleStyle?: StyleProp<TextStyle>;
  textBodyStyle?: StyleProp<TextStyle>;
  onPress?: () => void;
  onShow?: () => void;
  onHide?: () => void;
};

For Close popup

// For Dialog Box
Dialog.hide();

// For Toast Notification
Toast.hide();

Author

Truong Quang Manh | https://vietgigs.vn

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

License

MIT

react-native ios android alert notification dialog box toast notification popup dialog modal

0.4.4

10 months ago

0.4.3

10 months ago

0.4.2

10 months ago