Saltar al contenido principal
@capgo/capacitor-nfc API de dispositivos Código abierto

NFC plugin Capacitor

Descubrimiento, lectura y escritura nativos de etiquetas NFC para apps 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 el dispositivo

Descarga la app Capgo y escanea el QR code.

Vista previa QR del plugin NFC code

Usando @capgo/capacitor-nfc

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

Instalar

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

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

API de un vistazo

Método Descripción
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 detectada.
erase Intenta borrar la última etiqueta detectada escribiendo un mensaje NDEF vacío.
makeReadOnly Intenta poner la última etiqueta detectada en modo de solo lectura.
share Comparte un mensaje NDEF con otro dispositivo vía peer-to-peer (solo Android).
unshare Deja de compartir el 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 activar el NFC.
isSupported Comprueba si el dispositivo tiene soporte de hardware NFC.

Ejemplos

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 detectada.

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

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

erase()

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

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

await CapacitorNfc.erase();

makeReadOnly()

Intenta poner la última etiqueta detectada en modo de solo lectura.

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

await CapacitorNfc.makeReadOnly();

share()

Comparte un mensaje NDEF con otro dispositivo vía peer-to-peer (solo Android).

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

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

La tabla anterior enumera los 10 métodos principales. Los helpers de versión y listeners, junto con el contrato completo de cada método, están documentados en la repositorio GitHub.

Escuchar eventos

addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonta.

Referencia completa

Continúa desde Using @capgo/capacitor-nfc

Si estás usando Usando @capgo/capacitor-nfc para planificar las operaciones del dashboard y de API, conéctalo con @capgo/capacitor-nfc para los detalles de implementación en @capgo/capacitor-nfc, Primeros pasos para los detalles de implementación en Primeros pasos, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en Introducción, y Claves de API para los detalles de implementación en API Keys.

FAQ

FAQ del plugin NFC

¿Cómo instalo el plugin NFC en una app Capacitor?

Ejecuta "bun add @capgo/capacitor-nfc" (o "npm install @capgo/capacitor-nfc"), luego ejecuta "bunx cap sync" para que los proyectos de iOS y Android detecten el code nativo. Impórtalo desde "@capgo/capacitor-nfc" en el code de tu app.

¿Es compatible @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 es compatible con @capgo/capacitor-nfc?

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

¿Es @capgo/capacitor-nfc gratuito y open source?

Sí. El código fuente de code es público en GitHub: https://github.com/Cap-go/capacitor-nfc/ y el paquete se puede instalar gratis desde npm. Los reportes de bugs y pull requests son bienvenidos.

¿Puedo actualizar code que usa NFC sin pasar por la revisión de la App Store?

Instalar o actualizar el plugin cambia el code nativo, así que requiere un nuevo build para la tienda. Después, los cambios de JavaScript, HTML y CSS que llamen al plugin se pueden publicar al instante con las live updates de Capgo.

Publica cambios de NFC sin esperar la revisión de la app

Una vez que el plugin esté en tu store build, Capgo live updates envía tus cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Empieza con Capgo