Zum Hauptinhalt springen
@capgo/capacitor-NFC Geräte-APIs Open Source

NFC Capacitor-Plugin

Nativer NFC-Tagsuche, -Lesen und -Schreiben für Capacitor-Apps auf iOS und Android

Installieren

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

Anleitung

Wie man NFC in Capacitor verwendet

Testen auf Gerät

Laden Sie die Capgo-App herunter, dann scannen Sie die QR-Code code.

QR-code für die NFC-Plugin-Vorschau

Verwendung von @capgo/capacitor-nfc

Öffentliche API-Oberfläche für das Capacitor-NFC-Plugin

Installieren

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync kopiert die native code-Bibliothek in Ihre native Projekte. Führen Sie es erneut aus, nachdem jede Plugin-Upgrade durchgeführt wurde.

Einfügen

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

API im Überblick

Methode Beschreibung
startScanning NFC-Tags beginnt zu hören.
stopScanning Beendet die laufende NFC-Scansitzung.
write Schreibt die bereitgestellten NDEF-Records auf das letzte entdeckte Tag.
erase Versucht, das letzte entdeckte Tag durch das Schreiben eines leeren NDEF-Messages zu löschen.
makeReadOnly Versucht, das letzte entdeckte Tag schreibgeschützt zu machen.
share Teilt ein NDEF-Messages mit einem anderen Gerät via Peer-to-Peer (nur Android).
unshare Beendet die vorherige NDEF-Messages-Teilung (nur Android).
getStatus Gibt den aktuellen NFC-Adapter-Status zurück.
showSettings Öffnet die Systemeinstellungen-Seite, auf der der Benutzer NFC aktivieren kann.
isSupported Überprüft, ob das Gerät NFC-Hardware unterstützt.

Beispiele

startScanning()

Startet das Abhören von NFC-Tags.

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

await CapacitorNfc.startScanning();

stopScanning()

Beendet die laufende NFC-Scansitzung.

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

await CapacitorNfc.stopScanning();

write()

Schreibt die bereitgestellten NDEF-Records auf den letzten entdeckten Tag.

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

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

erase()

Versucht, den letzten entdeckten Tag durch das Schreiben eines leeren NDEF-Nachrichts zu löschen.

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

await CapacitorNfc.erase();

makeReadOnly()

Versucht, den letzten entdeckten Tag schreibgeschützt zu machen.

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

await CapacitorNfc.makeReadOnly();

share()

Teilt ein NDEF-Nachricht mit einem anderen Gerät über Peer-to-Peer (nur Android).

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

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

Die Tabelle oben listet die 10 Kernmethoden. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind in der GitHub-Repository.

Zu Ereignissen hörbar

addListener erstellt einen Handle. Ruf handle.remove() bei dem Bildschirm unmontiert wird.

Vollständige Referenz

Weitermachen von @capgo/capacitor-nfc

Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-nfc Verwendung von @capgo/capacitor-nfc um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit zur Implementierungsdetail in @capgo/capacitor-nfc, für die Implementierungsdetails in @capgo/capacitor-nfc zur Implementierungsdetail in Getting Started, für die Implementierungsdetails im Getting Started API-Referenz zur Implementierungsdetail in API Übersicht Einleitung zur Implementierungsdetail in Einleitung, und API Schlüssel zur Implementierungsdetail in API Schlüssel.

FAQ

NFC-Plugin-Faq

Wie installiere ich den NFC-Plugin in einer Capacitor-App?

Laufen Sie "bun add @capgo/capacitor-nfc" (oder "npm install @capgo/capacitor-nfc"), dann laufen Sie "bunx cap sync" so dass die iOS- und Android-Projekte die native code aufnehmen. Importieren Sie es von "@capgo/capacitor-nfc" in Ihrer code-App.

Arbeitet @capgo/capacitor-nfc mit React, Vue und Angular?

Ja. NFC ist ein Capacitor-Paket, also funktioniert es mit jedem Webframework, das innerhalb von Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und plain JavaScript.

Welche Capacitor-Version unterstützt @capgo/capacitor-nfc?

Capgo-Plugins folgen der Capacitor-Version: verwenden Sie die Plugin-Major-Version, die Ihrem Capacitor-Major-Version entspricht (z.B. Plugin v8 mit Capacitor 8). Die Kompatibilitäts-Tabelle im GitHub-README listet die unterstützten Versionen auf.

ist @capgo/capacitor-nfc kostenlos und Open-Source?

Ja. Die Quelle code ist öffentlich auf GitHub unter https://github.com/Cap-go/capacitor-nfc/ und die Pakete sind kostenlos zum Installieren erhältlich von npm. Fehlerberichte und Pull-Anfragen sind willkommen.

Kann ich code mit NFC-Unterstützung ohne eine App-Store-Bewertung aktualisieren?

Die Installation oder das Upgrade des Plugins ändert die native code, daher benötigt es eine neue Store-Build. Anschließend können JavaScript-, HTML- und CSS-Änderungen, die den Plugin aufrufen, sofort mit Capgo-Live-Updates verschickt werden.

Schicken Sie NFC-Änderungen ohne auf die App-Überprüfung zu warten.

Eine einmalige Installation des Plugins in Ihrem Store-Build ermöglicht Capgo Live-Updates, die Ihre JavaScript-, HTML- und CSS-Änderungen in Minuten an die Benutzer pushen.

Beginnen Sie mit Capgo