src/content/docs/plugin/nfc.mdx
import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; import CommandTabs from '@components/CommandTabs.astro'; import PluginPermissions from '@components/PluginPermissions.astro'; import PluginLinks from '@components/PluginLinks.astro'; import Compatibility from '@components/plugins/Compatibility.astro';
<PluginLinks plugin={frontmatter.plugin} />Read and write NFC tags on Android and iOS.
Install the nfc plugin to get started.
<Tabs> <TabItem label="Automatic">Use your project's package manager to add the dependency:
{' '}
<CommandTabs
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"
/>
1. Run the following command in the `src-tauri` folder to add the plugin to the project's dependencies in `Cargo.toml`:
```sh frame=none
cargo add tauri-plugin-nfc --target 'cfg(any(target_os = "android", target_os = "ios"))'
```
2. Modify `lib.rs` to initialize the plugin:
```rust title="src-tauri/src/lib.rs" ins={5-6}
#[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:
<CommandTabs
npm="npm install @tauri-apps/plugin-nfc"
yarn="yarn add @tauri-apps/plugin-nfc"
pnpm="pnpm add @tauri-apps/plugin-nfc"
deno="deno add npm:@tauri-apps/plugin-nfc"
bun="bun add @tauri-apps/plugin-nfc"
/>
</Steps>
The NFC plugin requires native configuration for iOS.
To access the NFC APIs on iOS you must adjust the target iOS version, configure a usage description on the Info.plist file and add the NFC capability to your application.
The NFC plugin requires iOS 14+. This is the default for Tauri applications created with Tauri CLI v2.8 and above, but you can edit your Xcode project to configure it.
In the src-tauri/gen/apple/<project-name>.xcodeproj/project.pbxproj file, set all IPHONEOS_DEPLOYMENT_TARGET properties to 14.0:
/* Begin XCBuildConfiguration section */
<random-id> /* release */ = {
isa = XCBuildConfiguration;
buildSettings = {
...
IPHONEOS_DEPLOYMENT_TARGET = 14.0;
};
name = release;
};
<random-id> /* debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
...
IPHONEOS_DEPLOYMENT_TARGET = 14.0;
};
name = debug;
};
Alternatively you can set the deployment target from Xcode in the General > Minimum Deployments > iOS 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:
<?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 and write various NFC tags</string>
</dict>
</plist>
Additionally iOS requires the NFC capability to be associated with your application.
The capability can be added in Xcode in the project configuration's "Signing & Capabilities" tab by clicking the "+ Capability" button and
selecting the "Near Field Communication Tag Reading" capability (see Add a capability to a target for more information)
or by adding the following configuration to the gen/apple/<app-name>_iOS/<app-name>_iOS.entitlements file:
<?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>com.apple.developer.nfc.readersession.formats</key>
<array>
<string>TAG</string>
</array>
</dict>
</plist>
The NFC plugin is available in both JavaScript and Rust, allowing you to scan and write to NFC tags.
Not every mobile device has the capability to scan NFC tags, so you should check for availability before using the scan and write APIs.
<Tabs syncKey="lang"> <TabItem label="JavaScript">import { isAvailable } from '@tauri-apps/plugin-nfc';
const canScanNfc = await isAvailable();
tauri::Builder::default()
.setup(|app| {
#[cfg(mobile)]
{
use tauri_plugin_nfc::NfcExt;
app.handle().plugin(tauri_plugin_nfc::init());
let can_scan_nfc = app.nfc().is_available()?;
}
Ok(())
})
The plugin can scan either generic NFC tags or NFC tags with a NDEF (NFC Data Exchange Format) message, which is a standard format to encapsulate typed data in an NFC tag.
<Tabs syncKey="lang"> <TabItem label="JavaScript">import { scan } from '@tauri-apps/plugin-nfc';
const scanType = {
type: 'ndef', // or 'tag',
};
const options = {
keepSessionAlive: false,
// configure the messages displayed in the "Scan NFC" dialog on iOS
message: 'Scan a NFC tag',
successMessage: 'NFC tag successfully scanned',
};
const tag = await scan(scanType, options);
tauri::Builder::default()
.setup(|app| {
#[cfg(mobile)]
{
use tauri_plugin_nfc::NfcExt;
app.handle().plugin(tauri_plugin_nfc::init());
let tag = app
.nfc()
.scan(tauri_plugin_nfc::ScanRequest {
kind: tauri_plugin_nfc::ScanKind::Ndef {
mime_type: None,
uri: None,
tech_list: None,
},
keep_session_alive: false,
})?
.tag;
}
Ok(())
})
:::note
The keepSessionAlive option can be used to directly write to the scanned NFC tag later.
If you do not provide that option, the session is recreated on the next write() call,
which means the app will try to rescan the tag.
:::
The NFC scanner can also filter tags with a specific URI format, mime type or NFC tag technologies. In this case, the scan will only detect tags that matches the provided filters.
:::note Filtering is only available on Android, so you should always check the scanned NFC tag contents.
The mime type is case sensitive and must be provided with lower case letters. :::
<Tabs syncKey="lang"> <TabItem label="JavaScript">import { scan, TechKind } from '@tauri-apps/plugin-nfc';
const techLists = [
// capture anything using NfcF
[TechKind.NfcF],
// capture all MIFARE Classics with NDEF payloads
[TechKind.NfcA, TechKind.MifareClassic, TechKind.Ndef],
];
const tag = await scan({
type: 'ndef', // or 'tag'
mimeType: 'text/plain',
uri: {
scheme: 'https',
host: 'my.domain.com',
pathPrefix: '/app',
},
techLists,
});
tauri::Builder::default()
.setup(|app| {
#[cfg(mobile)]
{
use tauri_plugin_nfc::NfcExt;
app.handle().plugin(tauri_plugin_nfc::init());
let tag = app
.nfc()
.scan(tauri_plugin_nfc::ScanRequest {
kind: tauri_plugin_nfc::ScanKind::Ndef {
mime_type: Some("text/plain".to_string()),
uri: Some(tauri_plugin_nfc::UriFilter {
scheme: Some("https".to_string()),
host: Some("my.domain.com".to_string()),
path_prefix: Some("/app".to_string()),
}),
tech_list: Some(vec![
vec![tauri_plugin_nfc::TechKind::Ndef],
]),
},
})?
.tag;
}
Ok(())
})
The write API can be used to write a payload to a NFC tag.
If there's no scanned tag with keepSessionAlive: true, the application will first scan an NFC tag.
import { write, textRecord, uriRecord } from '@tauri-apps/plugin-nfc';
const payload = [uriRecord('https://tauri.app'), textRecord('some payload')];
const options = {
// the kind is only required if you do not have a scanned tag session alive
// its format is the same as the argument provided to scan()
kind: {
type: 'ndef',
},
// configure the messages displayed in the "Scan NFC" dialog on iOS
message: 'Scan a NFC tag',
successfulReadMessage: 'NFC tag successfully scanned',
successMessage: 'NFC tag successfully written',
};
await write(payload, options);
The API will be enhanced soon. :::
tauri::Builder::default()
.setup(|app| {
#[cfg(mobile)]
{
use tauri_plugin_nfc::NfcExt;
app.handle().plugin(tauri_plugin_nfc::init());
app
.nfc()
.write(vec![
tauri_plugin_nfc::NfcRecord {
format: tauri_plugin_nfc::NFCTypeNameFormat::NfcWellKnown,
kind: vec![0x55], // URI record
id: vec![],
payload: vec![], // insert payload here
}
])?;
}
Ok(())
})
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.
See the Capabilities Overview for more information and the step by step guide to use plugin permissions.
{
"permissions": [
...,
"nfc:default",
]
}