Saltar al contenido principal
@capgo/capacitor-nfc APIs de dispositivo Fuente abierta

NFC plugin de Capacitor

Descubrimiento, lectura y escritura de etiquetas NFC nativas para aplicaciones de Capacitor en iOS y Android

Instalar

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

Guía

Cómo usar NFC en Capacitor

Probar en dispositivo

Descargue la aplicación Capgo, luego escane el código QR code.

Previsualización de plugin NFC QR code

Usando @capgo/capacitor-nfc

Superficie pública de API para el plugin NFC Capacitor.

Instalar

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync copia el nativo code del plugin en tus proyectos nativos. Ejéctalos de nuevo después de cada actualización del plugin.

Importar

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

Vista general de API

Metodo Description
startScanning Comienza a escuchar etiquetas NFC.
stopScanning Detiene la sesión de escaneo NFC en curso.
write Escribe los registros NDEF proporcionados en la última etiqueta descubierta.
erase Intenta borrar la última etiqueta descubierta escribiendo un mensaje NDEF vacío.
makeReadOnly Intenta hacer la última etiqueta de solo lectura.
share Comparte un mensaje NDEF con otro dispositivo mediante p2p (solo Android).
unshare Detiene la compartición del mensaje NDEF proporcionado anteriormente (solo Android).
getStatus Devuelve el estado actual del adaptador NFC.
showSettings Abre la página de ajustes del sistema donde el usuario puede habilitar NFC.
isSupported Verifica si el dispositivo tiene soporte para hardware NFC.

Examples

startScanning()

Comienza a escuchar etiquetas NFC.

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

await CapacitorNfc.startScanning();

stopScanning()

Detiene la sesión de escaneo NFC en curso.

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

await CapacitorNfc.stopScanning();

write()

Escribe los registros NDEF proporcionados en la última etiqueta descubierta.

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

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

erase()

Intenta borrar la última etiqueta descubierta escribiendo un mensaje NDEF vacío.

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

await CapacitorNfc.erase();

makeReadOnly()

Intenta hacer la última etiqueta descubierta de solo lectura.

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

await CapacitorNfc.makeReadOnly();

share()

Comparte un mensaje NDEF con otro dispositivo mediante p2p (solo Android).

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

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

La tabla anterior muestra los 10 métodos básicos. Los ayudantes de escucha y versión, y el contrato completo de cada método, se documentan en el repositorio de GitHub.

Escucha eventos

addListener devuelve un manejador. Llame a handle.remove() cuando se desmonta la pantalla.

Referencia completa

Sigue adelante desde Uso de @capgo/capacitor-nfc

Si estás utilizando Uso de @capgo/capacitor-nfc para planificar la consola de instrumentos y las operaciones de API, conecta @capgo/capacitor-nfc para obtener detalles de implementación en @capgo/capacitor-nfc Inicio rápido para obtener detalles de implementación en Inicio rápido Resumen de API para el detalle de implementación en API Resumen Introducción para el detalle de implementación en Introducción, y API Claves para el detalle de implementación en API Claves.

FAQ

FAQ del plugin NFC

Cómo instalo el plugin NFC en una aplicación Capacitor?

Ejecuta "bun add @capgo/capacitor-nfc" (o "npm install @capgo/capacitor-nfc"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el proyecto nativo code. Importa desde "@capgo/capacitor-nfc" en tu aplicación code.

¿Funciona @capgo/capacitor-nfc con React, Vue y Angular?

Sí. NFC es un paquete Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor admite @capgo/capacitor-nfc?

Los plugins Capgo siguen la versión mayor de Capacitor: utiliza la versión mayor del plugin que coincida con la versión mayor de Capacitor (por ejemplo, plugin v8 con Capacitor 8). La tabla de compatibilidad en el README del GitHub lista las versiones mantenidas.

¿Es @capgo/capacitor-nfc gratuito y de código abierto?

Yes. La fuente code está pública en GitHub en https://github.com/Cap-go/capacitor-nfc/ y el paquete es gratuito para instalar desde npm. Se agradecen los informes de errores y solicitudes de extracción.

Puedo actualizar code que utiliza NFC sin una revisión de la Tienda?

La instalación o actualización del complemento modifica el code nativo, por lo que necesita una nueva compilación de la tienda. Después de eso, los cambios en JavaScript, HTML y CSS que llaman al complemento pueden enviar con actualizaciones Capgo en vivo.

Envíe cambios NFC sin esperar la revisión de la aplicación

Una vez que el plugin esté en tu tienda de construcción, Capgo actualizaciones en vivo envían cambios en JavaScript, HTML y CSS a los usuarios en minutos.

Comience con Capgo