Salta al contenuto principale
@capgo/capacitor-nfc API dei dispositivi Open source

NFC Plugin Capacitor

Scoperta, lettura e scrittura di tag NFC nativi per app Capacitor su iOS e Android

Installa

bun add @capgo/capacitor-nfc bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-nfc
  • pnpm add @capgo/capacitor-nfc
  • yarn add @capgo/capacitor-nfc

Guida

Come usare NFC in Capacitor

Testa sul dispositivo

Scarica l'app Capgo, poi scansiona il QR code.

QR code di anteprima del plugin NFC

Uso di @capgo/capacitor-nfc

Superficie API pubblica per il plugin NFC Capacitor.

Installa

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.

Importa

import { CapacitorNfc } from '@capgo/capacitor-nfc';

API in breve

Metodo Descrizione
startScanning Avvia l'ascolto dei tag NFC.
stopScanning Interrompe la sessione di scansione NFC in corso.
write Scrive i record NDEF forniti sull'ultimo tag rilevato.
erase Tenta di cancellare l'ultimo tag rilevato scrivendo un messaggio NDEF vuoto.
makeReadOnly Tenta di impostare l'ultimo tag rilevato in modalità sola lettura.
share Condivide un messaggio NDEF con un altro dispositivo via peer-to-peer (solo Android).
unshare Interrompe la condivisione del messaggio NDEF fornito in precedenza (solo Android).
getStatus Restituisce lo stato attuale dell'adapter NFC.
showSettings Apre la pagina delle impostazioni di sistema dove l'utente può abilitare l'NFC.
isSupported Verifica se il dispositivo supporta l'hardware NFC.

Esempi

startScanning()

Avvia l'ascolto dei tag NFC.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.startScanning();

stopScanning()

Interrompe la sessione di scansione NFC in corso.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.stopScanning();

write()

Scrive i record NDEF forniti sull'ultimo tag rilevato.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.write({
  records: [
    {
      tnf: 1,
      type: [1],
      id: [1],
      payload: [1],
    },
  ],
});

erase()

Tenta di cancellare l'ultimo tag rilevato scrivendo un messaggio NDEF vuoto.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.erase();

makeReadOnly()

Tenta di impostare l'ultimo tag rilevato in modalità sola lettura.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.makeReadOnly();

share()

Condivide un messaggio NDEF con un altro dispositivo via peer-to-peer (solo Android).

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.share({
  records: [
    {
      tnf: 1,
      type: [1],
      id: [1],
      payload: [1],
    },
  ],
});

La tabella sopra elenca i 10 metodi principali. I listener e gli helper di versione, insieme al contratto completo di ogni metodo, sono documentati nel repository GitHub.

Ascolta gli eventi

addListener restituisce un handle. Chiama handle.remove() quando la schermata viene smontata.

Riferimento completo

Continua da Using @capgo/capacitor-nfc

Se stai usando Uso di @capgo/capacitor-nfc per pianificare le operazioni della dashboard e di API, collegalo a @capgo/capacitor-nfc per i dettagli implementativi in @capgo/capacitor-nfc, Per iniziare per i dettagli di implementazione nella guida introduttiva, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli implementativi nell'Introduzione, e Chiavi API per i dettagli implementativi in API Keys.

FAQ

FAQ del plugin NFC

Come installo il plugin NFC in un'app Capacitor?

Esegui "bun add @capgo/capacitor-nfc" (o "npm install @capgo/capacitor-nfc"), poi esegui "bunx cap sync" affinché i progetti iOS e Android recuperino il codice nativo code. Importalo da "@capgo/capacitor-nfc" nel tuo code dell'app.

@capgo/capacitor-nfc funziona con React, Vue e Angular?

Sì. NFC è un pacchetto Capacitor, quindi funziona con qualsiasi framework web che gira all'interno di Capacitor, inclusi Ionic, React, Vue, Angular, Svelte e JavaScript puro.

Quale versione di Capacitor supporta @capgo/capacitor-nfc?

I plugin Capgo seguono la major version di Capacitor: usa la major version del plugin che corrisponde alla tua major version di Capacitor (ad esempio plugin v8 con Capacitor 8). La tabella di compatibilità nel README di GitHub elenca le versioni mantenute.

@capgo/capacitor-nfc è gratuito e open source?

Sì. Il codice sorgente code è pubblico su GitHub all'indirizzo https://github.com/Cap-go/capacitor-nfc/ e il pacchetto si installa gratuitamente da npm. Bug report e pull request sono benvenuti.

Posso aggiornare code che usa NFC senza la revisione dell'App Store?

Installare o aggiornare il plugin modifica il code nativo, quindi serve una nuova build per lo store. Dopo, le modifiche a JavaScript, HTML e CSS che chiamano il plugin possono essere rilasciate subito con le live updates di Capgo.

Rilascia modifiche NFC senza attendere la revisione dell'app

Una volta incluso il plugin nel tuo store build, Capgo invia le modifiche a JavaScript, HTML e CSS tramite live updates in pochi minuti.

Inizia con Capgo