# amrg101/materialpreferences architecture

> Architecture diagram of the GitHub repository amrg101/materialpreferences, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/amrg101/materialpreferences
- Repository: https://github.com/amrg101/materialpreferences

## Overview

##### Main Components

a. Core Layer:
- Core Settings Management
- Settings Model
- Settings Converters
- Storage Interface
- Setting Types (Bool, Int, String, etc.)

b. Storage Layer:
- DataStore Implementation
- Custom Storage Interface

c. Preference Screen Layer:
- Screen Base Components
- Specialized Preference Types:
- Boolean Preferences
- Input Preferences
- Choice Preferences
- Slider Preferences
- Image Preferences

d. UI Components:
- RecyclerView-based Preference Screen
- Custom ViewHolders
- Preference Adapters

##### Relationships

a. Data Flow:
**User Input -> Preference Screen -> Settings Model -> Storage Layer**
**Storage Layer -> Settings Model -> UI Components (via Flow/LiveData)**

b. Dependencies:
- Core module as the foundation
- Storage modules depending on core
- Screen modules depending on core
- Individual preference type modules extending the base screen module

**┌─────────────────────────────────────────────────────────┐**
- UI Layer                            │
- ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐   │
- Bool   │  │  Input  │  │ Choice  │  │  Other   │   │
- Prefs   │  │  Prefs  │  │ Prefs   │  │  Prefs  │   │
- ┘  └─────────┘  └─────────┘  └─────────┘   │
- ┤
- Screen Base Layer                      │
- ┌─────────────────────────────────────────────────┐   │
- Preference Screen Components           │   │
- ┘   │
- ┤
- Core Layer                          │
- ┌─────────────┐    ┌──────────────┐  ┌──────────┐    │
- Settings    │    │  Settings    │  │ Storage  │    │
- Model     │◄──►│  Converter   │  │Interface │    │
- ┘    └──────────────┘  └──────────┘    │
- ┤
- Storage Layer                          │
- ┌─────────────┐    ┌──────────────┐                   │
- DataStore  │    │    Custom    │                   │
- Storage   │    │   Storage    │                   │
- ┘    └──────────────┘                   │
- ┘

##### Additional Elements

- Dependency injection points
- Extension points for custom implementations

##### Implementation Details

- Classes like SettingsModel, Storage, and PreferenceScreen
- Kotlin delegates usage
- Coroutines and Flow integration points
- DataStore implementation specifics

##### Notes

- Version information
- Technologies: Kotlin, Coroutines, Flow, DataStore
- Extensibility points for custom preferences

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#b3d1ff,stroke:#333
    classDef ui fill:#90EE90,stroke:#333
    classDef storage fill:#FFE5B4,stroke:#333
    classDef interface fill:#E5E5E5,stroke:#333

    %% UI Layer
    subgraph UI
        BoolPrefs["Boolean Preferences"]:::ui
        InputPrefs["Input Preferences"]:::ui
        ChoicePrefs["Choice Preferences"]:::ui
        ColorPrefs["Color Preferences"]:::ui
        SliderPrefs["Slider Preferences"]:::ui
        ImagePrefs["Image Preferences"]:::ui
    end

    %% Screen Base Layer
    subgraph ScreenBase
        PrefScreen["Preference Screen"]:::ui
        PrefAdapter["Preference Adapter"]:::ui
        ViewHolders["ViewHolders"]:::ui
        BasePrefs["Base Preferences"]:::ui
    end

    %% Core Layer
    subgraph Core
        SettingsModel["Settings Model"]:::core
        SettingsConverter["Settings Converter"]:::core
        StorageInterface["Storage Interface"]:::interface
        SettingTypes["Setting Types"]:::core
    end

    %% Storage Layer
    subgraph Storage
        DataStore["DataStore Storage"]:::storage
        CustomStorage["Custom Storage"]:::storage
    end

    %% Relationships
    BoolPrefs --> PrefScreen
    InputPrefs --> PrefScreen
    ChoicePrefs --> PrefScreen
    ColorPrefs --> PrefScreen
    SliderPrefs --> PrefScreen
    ImagePrefs --> PrefScreen

    PrefScreen --> PrefAdapter
    PrefScreen --> ViewHolders
    PrefScreen --> BasePrefs
    BasePrefs --> SettingsModel

    SettingsModel <--> SettingsConverter
    SettingsModel --> StorageInterface
    SettingTypes --> SettingsModel

    StorageInterface --> DataStore
    StorageInterface --> CustomStorage

    %% Click Events
    click SettingsModel "https://github.com/amrg101/MaterialPreferences/blob/master/library/src/main/java/com/michaelflisar/materialpreferences/core/SettingsModel.kt"
    click SettingsConverter "https://github.com/amrg101/MaterialPreferences/blob/master/library/src/main/java/com/michaelflisar/materialpreferences/core/SettingsConverter.kt"
    click StorageInterface "https://github.com/amrg101/MaterialPreferences/blob/master/library/src/main/java/com/michaelflisar/materialpreferences/core/interfaces/Storage.kt"
    click SettingTypes "https://github.com/amrg101/MaterialPreferences/tree/master/library/src/main/java/com/michaelflisar/materialpreferences/core/settings/"
    click DataStore "https://github.com/amrg101/MaterialPreferences/blob/master/library-datastore/src/main/java/com/michaelflisar/materialpreferences/datastore/DataStoreStorage.kt"
    click PrefScreen "https://github.com/amrg101/MaterialPreferences/blob/master/library-preference-screen/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/PreferenceScreen.kt"
    click BasePrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/preferences/"
    click BoolPrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen-bool/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/bool/"
    click InputPrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen-input/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/input/"
    click ChoicePrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen-choice/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/choice/"
    click ColorPrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen-color/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/color/"
    click SliderPrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen-slider/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/slider/"
    click ImagePrefs "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen-image/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/image/"
    click PrefAdapter "https://github.com/amrg101/MaterialPreferences/blob/master/library-preference-screen/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/recyclerview/PreferenceAdapter.kt"
    click ViewHolders "https://github.com/amrg101/MaterialPreferences/tree/master/library-preference-screen/src/main/java/com/michaelflisar/materialpreferences/preferencescreen/recyclerview/viewholders/base/"
```
