# mindinventory/animated_notch_bottom_bar architecture

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

- Interactive diagram: https://gitdiagram.com/mindinventory/animated_notch_bottom_bar
- Repository: https://github.com/mindinventory/animated_notch_bottom_bar

## Overview

##### Project type and purpose
- This is an open-source Flutter package (animated_notch_bottom_bar) that provides a reusable, animated bottom navigation bar widget with a notch effect.
- It contains only Dart code (no platform channels), exposes a Widget + Controller API, and ships example apps for Android, iOS, macOS, Windows, Linux, Web.

##### File structure
- Top-level directories/files:
- lib/animated_notch_bottom_bar.dart – public API entry point
- lib/src/… – implementation modules (models, constants, painter, controller, widget)
- example/… – full Flutter example apps targeting all platforms
- pubspec.yaml, README.md, CHANGELOG.md, LICENSE – metadata and docs
- No backend, database, or external microservices; it’s purely a client‐side UI component library.

##### README for additional insights
- Confirms API (“AnimatedNotchBottomBar”, “NotchBottomBarController”)
- Shows how users integrate it into their Scaffold’s bottomNavigationBar
- Notes supported platforms and features (custom widget items, blur effect, gradients, labels)

##### Essential architectural elements to capture
- Separation between Consumer App and Library
- Internal flow from user interaction → controller → widget rebuild → custom paint
- Flutter’s role as the rendering host
- Multi-platform embedder as the deployment targets

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Application Layer
    ConsumerApp["Consumer Flutter App"]:::consumer
    ConsumerApp -->|imports package| APIEntry

    %% Library Package
    subgraph "animated_notch_bottom_bar Package"
        APIEntry["animated_notch_bottom_bar.dart"]:::package
        AnimatedNotchBottomBar["AnimatedNotchBottomBar Widget"]:::package
        NotchBottomBarController["NotchBottomBarController"]:::package
        BottomBarPainter["BottomBarPainter"]:::package
        BottomBarActiveItem["BottomBarActiveItem"]:::package
        BottomBarInactiveItem["BottomBarInactiveItem"]:::package
        BottomBarItemModel["BottomBarItemModel"]:::package
        Constants["Constants"]:::package
    end

    APIEntry -->|exposes| AnimatedNotchBottomBar
    AnimatedNotchBottomBar -->|uses controller| NotchBottomBarController
    AnimatedNotchBottomBar -->|passes items to| BottomBarItemModel
    AnimatedNotchBottomBar -->|reads| Constants
    AnimatedNotchBottomBar -->|builds child widgets| BottomBarActiveItem
    AnimatedNotchBottomBar -->|builds child widgets| BottomBarInactiveItem
    AnimatedNotchBottomBar -->|paints notch| BottomBarPainter
    ConsumerApp -->|instantiates| NotchBottomBarController

    %% Framework Layer
    subgraph "Flutter Framework & Engine"
        FlutterFrameworkEngine["Dart VM & Skia Renderer"]:::framework
    end

    AnimatedNotchBottomBar -->|calls render| FlutterFrameworkEngine

    %% Platform Embedders
    subgraph "Platform Embedders"
        AndroidEmbedder["Android"]:::platform
        iOSEmbedder["iOS"]:::platform
        macOSEmbedder["macOS"]:::platform
        WindowsEmbedder["Windows"]:::platform
        LinuxEmbedder["Linux"]:::platform
        WebEmbedder["Web"]:::platform
    end

    FlutterFrameworkEngine -->|draws to| AndroidEmbedder
    FlutterFrameworkEngine -->|draws to| iOSEmbedder
    FlutterFrameworkEngine -->|draws to| macOSEmbedder
    FlutterFrameworkEngine -->|draws to| WindowsEmbedder
    FlutterFrameworkEngine -->|draws to| LinuxEmbedder
    FlutterFrameworkEngine -->|draws to| WebEmbedder

    %% Click Events
    click APIEntry "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/animated_notch_bottom_bar/animated_notch_bottom_bar.dart"
    click AnimatedNotchBottomBar "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/notch_bottom_bar.dart"
    click NotchBottomBarController "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/notch_bottom_bar_controller.dart"
    click BottomBarPainter "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/bottom_bar_painter.dart"
    click BottomBarActiveItem "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/bottom_bar_active_item.dart"
    click BottomBarInactiveItem "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/bottom_bar_inactive_item.dart"
    click BottomBarItemModel "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/models/bottom_bar_item_model.dart"
    click Constants "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/lib/src/constants/constants.dart"
    click ConsumerApp "https://github.com/mindinventory/animated_notch_bottom_bar/blob/main/example/lib/main.dart"
    click AndroidEmbedder "https://github.com/mindinventory/animated_notch_bottom_bar/tree/main/example/android/app/src/main"
    click iOSEmbedder "https://github.com/mindinventory/animated_notch_bottom_bar/tree/main/example/ios/Runner"
    click macOSEmbedder "https://github.com/mindinventory/animated_notch_bottom_bar/tree/main/example/macos/Runner"
    click WindowsEmbedder "https://github.com/mindinventory/animated_notch_bottom_bar/tree/main/example/windows/runner"
    click LinuxEmbedder "https://github.com/mindinventory/animated_notch_bottom_bar/tree/main/example/linux"
    click WebEmbedder "https://github.com/mindinventory/animated_notch_bottom_bar/tree/main/example/web"

    %% Styles
    classDef consumer fill:#9f6,stroke:#333,stroke-width:1px
    classDef package fill:#6cf,stroke:#333,stroke-width:1px
    classDef framework fill:#ccc,stroke:#333,stroke-width:1px
    classDef platform fill:#ff6,stroke:#333,stroke-width:1px
```
