NFC

GitHub npm crates.io

API Reference

Read and write NFC tags on Android and iOS.

Supported Platforms

• Android
• iOS

Setup

This plugin requires a Rust version of at least 1.75

Install the nfc plugin to get started.

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add nfc

yarn

yarn run tauri add nfc

pnpm

pnpm tauri add nfc

bun

bun tauri add nfc

cargo

cargo tauri add nfc

Manual

1. Run the following command in the src-tauri folder to add the plugin to the project’s dependencies in Cargo.toml:

   cargo add tauri-plugin-nfc --target 'cfg(any(target_os = "android", target_os = "ios"))'

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(mobile)]
               app.handle().plugin(tauri_plugin_nfc::init());
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

   npm

   npm install @tauri-apps/plugin-nfc

   yarn

   yarn add @tauri-apps/plugin-nfc

   pnpm

   pnpm add @tauri-apps/plugin-nfc

   bun

   bun add @tauri-apps/plugin-nfc

Configuration

On iOS the NFC plugin requires the NFCReaderUsageDescription information property list value, which should describe why your app needs to scan or write to NFC tags.

In the src-tauri/Info.ios.plist file, add the following snippet:

src-tauri/Info.ios.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NFCReaderUsageDescription</key>
    <string>Read QR codes</string>
  </dict>
</plist>

Usage

Contribute

This is a stub and is waiting for contributions. Get involved by visiting us on GitHub or joining us on Discord.

Here are some ideas to get you started:

Based on https://github.com/tauri-apps/plugins-workspace/tree/plugins/nfc

Default Permission

This permission set configures what kind of operations are available from the nfc plugin.

Granted Permissions

Checking if the NFC functionality is available and scanning nearby tags is allowed. Writing to tags needs to be manually enabled.

• allow-is-available
• allow-scan

Permission Table

Identifier	Description
nfc:allow-is-available	Enables the is_available command without any pre-configured scope.
nfc:deny-is-available	Denies the is_available command without any pre-configured scope.
nfc:allow-scan	Enables the scan command without any pre-configured scope.
nfc:deny-scan	Denies the scan command without any pre-configured scope.
nfc:allow-write	Enables the write command without any pre-configured scope.
nfc:deny-write	Denies the write command without any pre-configured scope.