Langsung ke konten utama
@capgo/capacitor-nfc API Perangkat Open source

NFC plugin Capacitor

Deteksi, pembacaan, dan penulisan tag NFC native untuk aplikasi Capacitor di iOS dan Android

Instal

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

Panduan

Cara menggunakan NFC di Capacitor

Tes di perangkat

Download aplikasi Capgo, lalu scan QR code.

QR pratinjau plugin NFC code

Menggunakan @capgo/capacitor-nfc

Permukaan API publik untuk plugin NFC Capacitor.

Instal

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.

Impor

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

Sekilas tentang API

Metode Deskripsi
startScanning Mulai mendengarkan tag NFC.
stopScanning Menghentikan sesi pemindaian NFC yang sedang berjalan.
write Menulis record NDEF yang diberikan ke tag terakhir yang ditemukan.
erase Mencoba menghapus tag terakhir yang ditemukan dengan menulis pesan NDEF kosong.
makeReadOnly Mencoba membuat tag terakhir yang ditemukan menjadi read-only.
share Berbagi pesan NDEF dengan perangkat lain via peer-to-peer (Android saja).
unshare Menghentikan berbagi pesan NDEF yang diberikan sebelumnya (Android saja).
getStatus Mengembalikan status adaptor NFC saat ini.
showSettings Membuka halaman pengaturan sistem agar pengguna dapat mengaktifkan NFC.
isSupported Memeriksa apakah perangkat mendukung hardware NFC.

Contoh

startScanning()

Mulai mendengarkan tag NFC.

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

await CapacitorNfc.startScanning();

stopScanning()

Menghentikan sesi pemindaian NFC yang sedang berjalan.

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

await CapacitorNfc.stopScanning();

write()

Menulis record NDEF yang diberikan ke tag terakhir yang ditemukan.

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

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

erase()

Mencoba menghapus tag terakhir yang ditemukan dengan menulis pesan NDEF kosong.

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

await CapacitorNfc.erase();

makeReadOnly()

Mencoba membuat tag terakhir yang ditemukan menjadi read-only.

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

await CapacitorNfc.makeReadOnly();

share()

Berbagi pesan NDEF dengan perangkat lain via peer-to-peer (Android saja).

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

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

Tabel di atas mencantumkan 10 metode inti. Listener, helper versi, dan kontrak lengkap setiap metode didokumentasikan di repositori GitHub.

Mendengarkan event

addListener mengembalikan sebuah handle. Panggil handle.remove() saat screen di-unmount.

Referensi lengkap

Lanjutkan dari Menggunakan @capgo/capacitor-nfc

Jika Anda menggunakan Menggunakan @capgo/capacitor-nfc untuk merencanakan operasi dashboard dan API, hubungkan dengan @capgo/capacitor-nfc untuk detail implementasi di @capgo/capacitor-nfc, Panduan Memulai untuk detail implementasi di Getting Started, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, dan Kunci API untuk detail implementasi di API Keys.

FAQ

FAQ plugin NFC

Bagaimana cara menginstal plugin NFC di aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-nfc" (atau "npm install @capgo/capacitor-nfc"), lalu jalankan "bunx cap sync" agar proyek iOS dan Android mengambil code native. Impor dari "@capgo/capacitor-nfc" di code aplikasi Anda.

Apakah @capgo/capacitor-nfc bekerja dengan React, Vue, dan Angular?

Ya. NFC adalah paket Capacitor, jadi bekerja dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript murni.

Versi Capacitor mana yang didukung @capgo/capacitor-nfc?

Plugin Capgo mengikuti versi mayor Capacitor: gunakan versi mayor plugin yang sesuai dengan versi mayor Capacitor Anda (contoh: plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub mencantumkan versi yang masih di-maintain.

Apakah @capgo/capacitor-nfc gratis dan open source?

Ya. Sumber code publik di GitHub di https://github.com/Cap-go/capacitor-nfc/ dan paketnya gratis diinstal dari npm. Laporan bug dan pull request diterima.

Bisakah saya memperbarui code yang menggunakan NFC tanpa review App Store?

Instalasi atau upgrade plugin akan mengubah native code, jadi butuh build store baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin bisa langsung dikirim lewat live updates Capgo.

Rilis perubahan NFC tanpa menunggu review aplikasi

Setelah plugin ada di build store Anda, live updates Capgo akan mengirim perubahan JavaScript, HTML, dan CSS ke pengguna dalam hitungan menit.

Mulai dengan Capgo