# cap-nfc-plugin

> Capacitor plugin

Latest version **0.2.3** (published 2020-11-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install cap-nfc-plugin
pnpm add cap-nfc-plugin
yarn add cap-nfc-plugin
bun add cap-nfc-plugin
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; large bundle; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2020-11-24 |
| First published | 2020-04-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 50.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joy |
| Maintainers | joyzhou007, yczeiss |
| Keywords | capacitor, plugin, native |

## Links

- npm: https://www.npmjs.com/package/cap-nfc-plugin
- Repository: https://github.com/JoyZhou007/cap-nfc-plugin
- Homepage: https://github.com/JoyZhou007/cap-nfc-plugin#readme
- Issues: https://github.com/JoyZhou007/cap-nfc-plugin.git/issues
- npm.io page: https://npm.io/package/cap-nfc-plugin

## Dependencies (2)

- [android](https://npm.io/package/android.md) 0.0.8
- [@capacitor/core](https://npm.io/package/@capacitor/core.md) latest

## Recent versions

- 0.2.3 (latest) — 2020-11-24
- 0.1.9 — 2020-11-19
- 0.1.8 — 2020-11-19
- 0.1.7 — 2020-10-23
- 0.1.5 — 2020-10-20
- 0.1.4 — 2020-08-28
- 0.1.3 — 2020-08-17
- 0.1.2 — 2020-08-13
- 0.1.1 — 2020-08-11
- 0.1.0 — 2020-05-28
- 0.0.9 — 2020-05-26
- 0.0.8 — 2020-05-22
- 0.0.7 — 2020-04-22
- 0.0.6 — 2020-04-22
- 0.0.5 — 2020-04-22
- … 4 more at https://npm.io/package/cap-nfc-plugin/versions

## README

# cap-nfc-plugin
## Installing
---

    $ npm i cap-nfc-plugin
    
## Methods
---
* 监听读取NFC信息: `NFCPlugin.addListener('readNFCResult',callback)`
* 监听开始写入NFC: `NFCPlugin.addListener('beginWriteNFC',callback)`
* 监听写入NFC成功或失败的结果: `NFCPlugin.addListener('writeNFCResult',callback)`
* NFC开始读写后,向android发送任务信息: `NFCPlugin.sendTaskInfo({taskInfo: Object})`
    
## Usage
---
Import the plugin you want to use into your x.component.ts file .

    import { Plugins, Capacitor } from '@capacitor/core';
    const { NFCPlugin } = Plugins;
    @Component({
      selector: 'x',
      templateUrl: './x.component.html'
    })
    
    export class AppComponent implements AfterViewInit { 
        ngAfterViewInit(): void {
            NFCPlugin.addListener('readNFCResult', (info: any) => {
              console.log('readNFCResult was fired', info);
            });
            NFCPlugin.addListener('beginWriteNFC', (info: any) => {
              console.log('beginWriteNFC was fired', info);
            });
            NFCPlugin.addListener('writeNFCResult', (info: any) => {
              console.log('writeNFCResult was fired', info);
            });
        }
        
         sendTaskInfo() {
            NFCPlugin.sendTaskInfo({
              taskInfo: {
                id: 1,
                taskNumber: "111111",
                process: "joy",
              },
            });
        }
    }
    
## Update Your Project
---
just running command 

    npm run android
    
##  Upgrade Plugin
---
1. `delete current project's node_modules folder and android folder`  
2. `npm i`
3. `npm i cap-nfc-plugin@latest`
4. `npx cap add android`
5. `npm run android`
6.  到此步骤会自动打开Android studio, 找到`MainActivity.java`文件
7.  将Plugin添加到mainActivity中
  
        public class MainActivity extends BridgeActivity {
          @Override
          public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
        
            // Initializes the Bridge
            this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
              // Additional plugins you've installed go here
              // Ex: add(TotallyAwesomePlugin.class);
              add(NFCPlugin.class);
            }});
          }
        }
8. 找到`app/manifests/AndroidManifest.xml`文件，将`android:usesCleartextTraffic="true"`添加到`application`中

        <application
            android:allowBackup="true"
            android:icon="@mipmap/ic_launcher"
            android:label="@string/app_name"
            android:roundIcon="@mipmap/ic_launcher_round"
            android:supportsRtl="true"
            android:usesCleartextTraffic="true"
            android:theme="@style/AppTheme">
            
9. 现在可以打包出来啦，Finished

## Debugger In Chrome
----
open url `chrome://inspect/#devices` in chrome, you can find device in it

---
_Source: https://npm.io/package/cap-nfc-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._