Skip to content

README.md

Latest commit

 

History

History
159 lines (122 loc) · 4.17 KB

README.md

File metadata and controls

159 lines (122 loc) · 4.17 KB

@blazejkustra/react-native-alert

NPM Downloads

✨ Universal, customizable alerts and prompts for React Native — identical API to the built-in Alert, but works seamlessly across iOS, Android, and Web.

React Native Alert

🚀 Features

  • Cross-platform – iOS, Android, Web with one API
  • Drop-in replacement – same API as Alert
  • Prompts everywhere – text input prompts supported on all platforms
  • Modern Web implementation – built with <dialog> + CSS custom properties
  • Dark/light themes – automatic with manual override
  • Accessible – full keyboard navigation + screen reader support
  • TypeScript ready – complete type definitions

📦 Installation

npm install @blazejkustra/react-native-alert

No extra setup needed on iOS or Android (just rebuild your app). On Web, styles are injected automatically and can be customized with CSS variables.

🛠 Usage

Basic Alert

import Alert from '@blazejkustra/react-native-alert';

Alert.alert('Hello!', 'This is a cross-platform alert.');

Alert with Buttons

Alert.alert(
  'Confirm',
  'Do you want to continue?',
  [
    { text: 'Cancel', style: 'cancel' },
    { text: 'OK', style: 'default' },
  ]
);

Destructive Alert

Alert.alert(
  'Delete item?',
  'This action cannot be undone.',
  [
    { text: 'Cancel', style: 'cancel' },
    { text: 'Delete', style: 'destructive' },
  ]
);

Prompt

Alert.prompt(
  'Enter your name',
  'Please type your name below:',
  [
    { text: 'Cancel', style: 'cancel' },
    { text: 'OK', onPress: (value) => console.log('Name:', value) },
  ],
  'plain-text',
  'John Doe'
);

Secure Prompt

Alert.prompt(
  'Password',
  'Enter your password:',
  [
    { text: 'Cancel', style: 'cancel' },
    { text: 'OK', onPress: () => console.log('Password entered') },
  ],
  'secure-text'
);

For more examples, see example/src/App.tsx.

📖 API

Same as React Native Alert.

📱 Platform Notes

  • iOS – uses React Native's built-in Alert.alert and Alert.prompt
  • Android – uses React Native's built-in Alert.alert and custom native module with Material styling for Alert.prompt
  • Web – HTML5 <dialog>, themeable via CSS variables

🎨 Web Customization

Override CSS variables to match your design system:

:root {
  --rn-alert-accent: #059669;   /* Primary button */
  --rn-alert-danger: #dc2626;   /* Destructive button */
  --rn-alert-bg: #fefefe;       /* Dialog background */
  --rn-alert-fg: #111827;       /* Text color */
  --rn-alert-radius: 16px;        /* Border radius */
}

@media (prefers-color-scheme: dark) {
  :root:not([data-theme]) {
    ...
  }
}

Available variables:

  • --rn-alert-bg – dialog background
  • --rn-alert-fg – primary text color
  • --rn-alert-muted – secondary / muted text
  • --rn-alert-surface – input & surface background
  • --rn-alert-border – border color
  • --rn-alert-elev – box shadow / elevation
  • --rn-alert-accent – primary button color
  • --rn-alert-accent-hover – primary button hover color
  • --rn-alert-danger – destructive button color
  • --rn-alert-danger-hover – destructive button hover color
  • --rn-alert-radius – border radius (dialogs/buttons)
  • --rn-alert-radius-sm – small border radius (inputs/buttons)
  • --rn-alert-spacing – default padding
  • --rn-alert-spacing-sm – small padding
  • --rn-alert-btn-min – minimum button height (touch target)
  • --rn-alert-outline – focus outline style
  • --rn-alert-outline-weak – subtle focus outline
  • --rn-alert-font – font family
  • --rn-alert-font-size – base font size
  • --rn-alert-title-size – title font size

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for workflow and CODE_OF_CONDUCT.md.

📄 License

MIT © Blazej Kustra

Built with create-react-native-library 🛠