# okadan/flutter-nfc-manager architecture

> Architecture diagram of the GitHub repository okadan/flutter-nfc-manager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/okadan/flutter-nfc-manager
- Repository: https://github.com/okadan/flutter-nfc-manager

## Overview

##### Project type and purpose
- This is an open-source Dart/Flutter plugin monorepo (a workspace) for NFC features.
- It contains multiple packages:
- ndef_record – NDEF record handling in pure Dart
- nfc_manager – Core Flutter plugin exposing NFC on Android/iOS
- nfc_manager_ndef – Higher-level NDEF abstraction built on nfc_manager
- nfc_manager_felica – FeliCa card abstraction built on nfc_manager
- Each package ships with: Dart library code, platform-specific plugin code (Android/Kotlin, iOS/Swift), Pigeon definitions, and example apps.

##### File structure
- Top-level: mono repo root with pubspec.yaml, README, and a packages/ directory.
- Under packages/: one folder per plugin.
– lib/ : the Dart API surface
– pigeon/ : shared API definitions (in nfc_manager only)
– android/ : native code (Kotlin + Gradle scripts)
– ios/ : native code (Swift + Podspec)
– example/ : a standalone Flutter app demonstrating usage
- Dependencies flow:
ndef_record (standalone)
nfc_manager (core) ← pigeon → native code
nfc_manager_ndef → nfc_manager
nfc_manager_felica → nfc_manager
- Build & deployment files: Gradle, Podfile, analysis_options.yaml

##### README for additional insights
- The README lists each package and its role.
- Confirms that nfc_manager is the pivot, and the other packages extend/consume it.

##### Elements
- Clear labels: “Dart API”, “Pigeon Stubs”, “Android Plugin”, “iOS Plugin”, “Example App”
– from Example → Dart API → Pigeon Stubs → Native Plugin → OS NFC APIs
– from Extension Package → Core Plugin

## Diagram (Mermaid)

```mermaid
graph TB
  %% Workspace Root
  subgraph "Workspace Root"
    pubspec["pubspec.yaml"]:::package
    packages_dir["packages/"]:::package
  end

  %% ndef_record Package
  subgraph "ndef_record"
    nr_pub["pubspec.yaml"]:::package
    nr_api["Dart API\n(ndef_record.dart)"]:::dart
    nr_example["Example Docs"]:::example
  end
  click nr_pub "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/ndef_record/pubspec.yaml"
  click nr_api "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/ndef_record/lib/ndef_record.dart"
  click nr_example "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/ndef_record/example/example.md"

  %% nfc_manager Package
  subgraph "nfc_manager"
    nm_pub["pubspec.yaml"]:::package
    core_api["Dart API\n(nfc_manager.dart)"]:::dart
    android_api["Dart Android API\n(nfc_manager_android.dart)"]:::dart
    ios_api["Dart iOS API\n(nfc_manager_ios.dart)"]:::dart
    pigeon_android["Pigeon Defs (Android)"]:::dart
    pigeon_ios["Pigeon Defs (iOS)"]:::dart
    native_android["Android Plugin\n(NfcManagerPlugin.kt)"]:::native
    native_pigeon_kotlin["Pigeon.kt"]:::native
    native_ios["iOS Plugin\n(NfcManagerPlugin.swift)"]:::native
    native_pigeon_swift["Pigeon.swift"]:::native
    example_app["Example App\n(main.dart)"]:::example
    example_android_host["Example Android Host\n(MainActivity.kt)"]:::native
    example_ios_host["Example iOS Host\n(AppDelegate.swift)"]:::native
  end
  click nm_pub "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/pubspec.yaml"
  click core_api "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/lib/nfc_manager.dart"
  click android_api "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/lib/nfc_manager_android.dart"
  click ios_api "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/lib/nfc_manager_ios.dart"
  click pigeon_android "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/pigeon/android.dart"
  click pigeon_ios "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/pigeon/ios.dart"
  click native_android "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/android/src/main/kotlin/dev/flutter/plugins/nfcmanager/NfcManagerPlugin.kt"
  click native_pigeon_kotlin "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/android/src/main/kotlin/dev/flutter/plugins/nfcmanager/Pigeon.kt"
  click native_ios "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/ios/Classes/NfcManagerPlugin.swift"
  click native_pigeon_swift "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/ios/Classes/Pigeon.swift"
  click example_app "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/example/lib/main.dart"
  click example_android_host "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/example/android/app/src/main/kotlin/dev/flutter/plugins/nfcmanagerexample/MainActivity.kt"
  click example_ios_host "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager/example/ios/Runner/AppDelegate.swift"

  %% nfc_manager_ndef Package
  subgraph "nfc_manager_ndef"
    ndef_pub["pubspec.yaml"]:::package
    ndef_api["Dart API\n(nfc_manager_ndef.dart)"]:::dart
    ndef_android_impl["Android Impl\n(ndef_platform_android.dart)"]:::native
    ndef_ios_impl["iOS Impl\n(ndef_platform_ios.dart)"]:::native
    ndef_example["Example Docs"]:::example
  end
  click ndef_pub "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_ndef/pubspec.yaml"
  click ndef_api "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_ndef/lib/nfc_manager_ndef.dart"
  click ndef_android_impl "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_ndef/lib/src/ndef_platform_android.dart"
  click ndef_ios_impl "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_ndef/lib/src/ndef_platform_ios.dart"
  click ndef_example "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_ndef/example/example.md"

  %% nfc_manager_felica Package
  subgraph "nfc_manager_felica"
    felica_pub["pubspec.yaml"]:::package
    felica_api["Dart API\n(nfc_manager_felica.dart)"]:::dart
    felica_android["Android Impl\n(felica_platform_android.dart)"]:::native
    felica_ios["iOS Impl\n(felica_platform_ios.dart)"]:::native
    felica_example["Example Docs"]:::example
  end
  click felica_pub "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_felica/pubspec.yaml"
  click felica_api "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_felica/lib/nfc_manager_felica.dart"
  click felica_android "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_felica/lib/src/felica_platform_android.dart"
  click felica_ios "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_felica/lib/src/felica_platform_ios.dart"
  click felica_example "https://github.com/okadan/flutter-nfc-manager/blob/main/packages/nfc_manager_felica/example/example.md"

  %% Relationships
  nr_api -->|uses| nr_pub
  example_app -->|imports| core_api
  core_api -->|calls| pigeon_android
  core_api -->|calls| pigeon_ios
  pigeon_android -->|invokes| native_pigeon_kotlin
  pigeon_android -->|invokes| native_android
  pigeon_ios -->|invokes| native_pigeon_swift
  pigeon_ios -->|invokes| native_ios
  ndef_api -->|depends on| core_api
  felica_api -->|depends on| core_api

  %% Package grouping
  pubspec --> packages_dir
  packages_dir --> ndef_record
  packages_dir --> nfc_manager
  packages_dir --> nfc_manager_ndef
  packages_dir --> nfc_manager_felica

  %% Styles
  classDef package fill:#f9f,stroke:#333,stroke-width:1px;
  classDef dart fill:#bbf,stroke:#333,stroke-width:1px;
  classDef native fill:#bfb,stroke:#333,stroke-width:1px;
  classDef example fill:#fbf,stroke:#333,stroke-width:1px;
```
