@santoshpk/react-native-nfc-scanner

Android NFC scanning for React Native. Supports foreground and background scanning out of the box.

Android only. Requires React Native 0.79+.

Installation

npm install @santoshpk/react-native-nfc-scanner

Auto-links on install. No extra setup needed.

Usage

import { Button, View } from 'react-native';
import {
  startScanning,
  stopScanning,
  isSupported,
  isEnabled,
  goToNfcSetting,
  addNfcListener,
} from '@santoshpk/react-native-nfc-scanner';

function ScanScreen() {
  async function scan() {
    const supported = await isSupported();
    if (!supported) return console.log('NFC not supported');

    const enabled = await isEnabled();
    if (!enabled) return goToNfcSetting();

    const sub = addNfcListener('NfcTagScanned', (tag) => {
      console.log('Tag ID:', tag.tag);
      console.log('Payloads:', tag.payloads);
      stopScanning();
      sub.remove();
    });

    await startScanning();
  }

  return (
    <View>
      <Button title="Scan NFC Tag" onPress={scan} />
    </View>
  );
}

API

| Method | Returns | Description | |---|---|---| | startScanning() | Promise<void> | Start listening for NFC tags | | stopScanning() | Promise<void> | Stop listening | | isSupported() | Promise<boolean> | Check if device has NFC hardware | | isEnabled() | Promise<boolean> | Check if NFC is turned on | | goToNfcSetting() | Promise<boolean> | Open Android NFC settings | | addNfcListener(event, cb) | EmitterSubscription | Subscribe to scan events. Call .remove() to unsubscribe |

Events

| Event | Payload | |---|---| | NfcTagScanned | NfcTagEvent |

Types

interface NfcTagEvent {
  tag: string;         // tag identifier
  ndef: string;        // NDEF data (empty string if none)
  payloads: string[];  // decoded text from each NDEF record
}

Requirements

• React Native 0.79+
• Android API 21+
• Physical device with NFC

License

MIT