# bitnoise/react-scheduler architecture

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

- Interactive diagram: https://gitdiagram.com/bitnoise/react-scheduler
- Repository: https://github.com/bitnoise/react-scheduler

## Overview

##### Project Type & Purpose
- This is an open-source, front-end React/TypeScript component library (“@bitnoise/react-scheduler”) for rendering ultra-fast, lightweight Gantt-style charts in React apps.
- It exposes a single `<Scheduler>` component, consumes props (data, config, callbacks), and renders a scheduler grid on an HTML canvas plus ancillary UI (side panel, buttons, tooltips).

##### File Structure
- Top-level files (package.json, vite.config.ts, Dockerfile, tsconfig.json): indicate a packaged library built with Vite + TypeScript.
- src/ holds all source code:
– context/ : CalendarProvider & LocaleProvider using React Context API for global state (current date range, zoom, i18n).
– utils/ : pure functions for date calculations and low-level canvas drawing routines (drawGrid, drawHeaderRows, drawRow, etc.).
– hooks/, assets/, styles.ts, constants.ts: support modules and global styles.

##### README Insights
- The README confirms it’s a React component library, lists props, config options (zoom, pagination, lang, theme), and shows example usage.

a. Main Components & Layers
- Consumer App (importing `<Scheduler>`).
- Scheduler Entry Component
- Context Providers:
– LocaleProvider (i18n strings, dayjs locale)
– CalendarProvider (date range, zoom, filter state)
- UI Components:
– Calendar
– Header (Topbar: Prev/Next/Today/View controls)
– Grid (canvas for weeks/days/hours)
– Tiles (positioned overlays or drawn on canvas)
– ConfigPanel (filter toggles)
– Loader, EmptyBox (state placeholders)
– PaginationButton, Toggle, Tooltip
- Utils & Helpers:
– Date functions (getDatesRange, getCols, getOccupancy…)
b. Relationships & Data Flow
1. Consumer App → `<Scheduler>` (props: data[], isLoading, callbacks, config)
2. `<Scheduler>` wraps:
– `<LocaleProvider>` & `<CalendarProvider>` (inject context)
– UI Components consume context and props.
3. On mount & on scroll/zoom/filter: CalendarProvider updates date range → triggers re-render.
4. Grid & Header call utils to compute cell coordinates & issue Canvas API calls (drawing).
5. LeftColumn renders React DOM elements for row labels.
6. Tiles: either drawn on canvas or positioned overlays (React elements) using coords from utils.
7. User interactions (click on tile/row/filter) → fire callback props (onTileClick, onItemClick, onFilterData, onClearFilterData).
c. Architectural Patterns & Principles
- Component composition (small reusable React components).
- Separation of concerns: UI layer vs rendering logic (canvas utils).
- Context API for global config & state (zoom, locale, date range).
- Functional utils for pure computations (date math, layout).
d. Relevant Technologies
- React + TypeScript
- Vite bundler
- Context API, custom hooks
- HTML Canvas API for high-performance rendering
- dayjs for date manipulations
- styled-components (CSS-in-JS)

##### Be Detailed & Capture Essentials
1. Consumer integration
2. Core component tree & context
3. Utility/rendering engine
- Build/bundle assets (vite.config.ts) as part of packaging.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Consumer Integration Layer
    subgraph "Consumer Integration" 
        direction TB
        ConsumerApp["Consumer App"]:::external
        Scheduler["<Scheduler> Entry"]:::component
    end

    %% Core Component Tree & Context
    subgraph "Core Component Tree & Context"
        direction TB
        Scheduler -->|"imports & renders"| LocaleProv[("LocaleProvider")]:::provider
        Scheduler -->|"imports & renders"| CalendarProv[("CalendarProvider")]:::provider

        LocaleProv -->|"provides i18n context"| CalendarComp[("Calendar")]:::component
        CalendarProv -->|"provides date/zoom context"| CalendarComp

        CalendarComp -->|"renders"| HeaderComp[("Header")]:::component
        CalendarComp -->|"renders"| GridComp[("Grid")]:::component
        CalendarComp -->|"renders"| LeftCol[("LeftColumn")]:::component
        CalendarComp -->|"renders"| TilesComp[("Tiles")]:::component

        HeaderComp -->|"contains"| TopbarComp[("Topbar")]:::component

        TilesComp -->|"renders each"| TileComp[("Tile")]:::component

        CalendarComp -->|"renders"| ConfigPanelComp[("ConfigPanel")]:::component
        CalendarComp -->|"renders"| LoaderComp[("Loader")]:::component
        CalendarComp -->|"renders"| EmptyBoxComp[("EmptyBox")]:::component
        CalendarComp -->|"renders"| PaginationBtn[("PaginationButton")]:::component
        CalendarComp -->|"renders"| ToggleComp[("Toggle")]:::component
        CalendarComp -->|"renders"| TooltipComp[("Tooltip")]:::component
    end

    %% Utility & Rendering Engine Layer
    subgraph "Utility & Rendering Engine"
        direction TB
        DateUtils["Date Utility Functions"]:::utility
        CanvasGridUtils["Canvas Drawing Utilities - Grid"]:::utility
        CanvasHeaderUtils["Canvas Drawing Utilities - Header"]:::utility
        HooksComp["Custom Hooks"]:::utility
        StylesConsts["Global Styles & Constants"]:::utility
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        Dayjs["dayjs"]:::external
        CanvasAPI["HTML Canvas API"]:::external
        StyledComp["styled-components"]:::external
    end

    %% Build & Packaging
    subgraph "Build & Packaging"
        direction TB
        ViteConfig["vite.config.ts"]:::build
        TSConfig["tsconfig.json"]:::build
        PackageJSON["package.json"]:::build
    end

    %% Data & Event Flows
    ConsumerApp -->|"renders"| Scheduler
    CalendarComp -->|"calls date utils"| DateUtils
    GridComp -->|"uses canvas utils"| CanvasGridUtils
    HeaderComp -->|"uses canvas header utils"| CanvasHeaderUtils
    HooksComp -->|"used by"| PaginationBtn
    StylesConsts -->|"imported by"| CalendarComp

    CalendarComp -->|"uses"| Dayjs
    GridComp -->|"draws on"| CanvasAPI
    CalendarComp -->|"styles with"| StyledComp

    Scheduler -->|"bundled with"| ViteConfig
    Scheduler -->|"type definitions from"| TSConfig
    Scheduler -->|"packaged via"| PackageJSON

    %% Click Events
    click Scheduler "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Scheduler/Scheduler.tsx"
    click LocaleProv "https://github.com/bitnoise/react-scheduler/blob/master/src/context/LocaleProvider/LocaleProvider.tsx"
    click CalendarProv "https://github.com/bitnoise/react-scheduler/blob/master/src/context/CalendarProvider/CalendarProvider.tsx"
    click CalendarComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Calendar/Calendar.tsx"
    click HeaderComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Calendar/Header/Header.tsx"
    click TopbarComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Calendar/Header/Topbar/Topbar.tsx"
    click GridComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Calendar/Grid/Grid.tsx"
    click LeftCol "https://github.com/bitnoise/react-scheduler/blob/master/src/components/LeftColumn/LeftColumn.tsx"
    click TilesComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Tiles/Tiles.tsx"
    click TileComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Tiles/Tile/Tile.tsx"
    click ConfigPanelComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/ConfigPanel/ConfigPanel.tsx"
    click LoaderComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Loader/Loader.tsx"
    click EmptyBoxComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/EmptyBox/EmptyBox.tsx"
    click PaginationBtn "https://github.com/bitnoise/react-scheduler/blob/master/src/components/PaginationButton/PaginationButton.tsx"
    click ToggleComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Toggle/Toggle.tsx"
    click TooltipComp "https://github.com/bitnoise/react-scheduler/blob/master/src/components/Tooltip/Tooltip.tsx"
    click DateUtils "https://github.com/bitnoise/react-scheduler/blob/master/src/utils/getDatesRange.ts"
    click CanvasGridUtils "https://github.com/bitnoise/react-scheduler/blob/master/src/utils/drawGrid/drawGrid.ts"
    click CanvasHeaderUtils "https://github.com/bitnoise/react-scheduler/blob/master/src/utils/drawHeader/drawHeader.ts"
    click HooksComp "https://github.com/bitnoise/react-scheduler/blob/master/src/hooks/usePagination.ts"
    click StylesConsts "https://github.com/bitnoise/react-scheduler/blob/master/src/styles.ts"
    click ViteConfig "https://github.com/bitnoise/react-scheduler/blob/master/vite.config.ts"
    click TSConfig "https://github.com/bitnoise/react-scheduler/blob/master/tsconfig.json"
    click PackageJSON "https://github.com/bitnoise/react-scheduler/blob/master/package.json"

    %% Styles
    classDef component fill:#D0E8FF,stroke:#0366d6,stroke-width:1px;
    classDef provider fill:#DFFFE0,stroke:#2E8B57,stroke-width:1px;
    classDef utility fill:#FFF3BF,stroke:#D4A017,stroke-width:1px;
    classDef external fill:#E0E0E0,stroke:#888888,stroke-width:1px;
    classDef build fill:#F0D9FF,stroke:#8A2BE2,stroke-width:1px;
```
