nfcutils

NFCUtils - plugin for Capacitor

Capacitor plugin providing NFC functionalities

Supported Platforms

• ✅ Android
• ❌ iOS (not yet implemented)
• 🚫 Web/PWA (not supported, see: Web NFC API )

NFC Tag Technologies

• NDEF
• MifareUltralight

Install

npm install nfcutils
npx cap sync

Permissions

Android

AndroidManifest.xml

<uses-permission android:name="android.permission.NFC" />

API

• addListener('nfcScanned', ...)
• addListener('scanError', ...)
• startReading()
• stopReading()
• isSupported()
• removeAllListeners()
• Interfaces

addListener('nfcScanned', ...)

addListener(eventName: 'nfcScanned', listenerFunc: (event: NFCScannedEvent) => void) => Promise<PluginListenerHandle>

Listen for a scanned NFC event

Param	Type
eventName	'nfcScanned'
listenerFunc	(event: NFCScannedEvent) => void

Returns: Promise<PluginListenerHandle>

addListener('scanError', ...)

addListener(eventName: 'scanError', listenerFunc: (event: ScanErrorEvent) => void) => Promise<PluginListenerHandle>

Listen for a scan error event

Param	Type
eventName	'scanError'
listenerFunc	(event: ScanErrorEvent) => void

Returns: Promise<PluginListenerHandle>

startReading()

startReading() => Promise<void>

Start listening for NFC read

stopReading()

stopReading() => Promise<void>

Stop listening for NFC read

isSupported()

isSupported() => Promise<{ supported: boolean; }>

Check if NFC is supported

Returns: Promise<{ supported: boolean; }>

removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners.

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

NFCScannedEvent

Scanned NFC contents

Prop	Type
data	string
tagInfo	{ id: string; type: string; }

ScanErrorEvent

Scan error