# sdc-alibaba/sui-mobile architecture

> Architecture diagram of the GitHub repository sdc-alibaba/sui-mobile, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sdc-alibaba/sui-mobile
- Repository: https://github.com/sdc-alibaba/sui-mobile

## Overview

##### Project Type and Purpose
- This is an open-source, lightweight mobile UI component library (SUI Mobile) for building hybrid or web-based mobile apps.
- It combines CSS (LESS) themes and JavaScript modules (built on Zepto, FastClick, iScroll, etc.) to provide pre-built UI widgets (tabs, modals, forms, pickers, etc.).
- It also includes full documentation, demos, examples, and a test suite.

##### High-Level File Structure Analysis
- Root: build configs (Gruntfile.js), package.json, lint settings, CONTRIBUTING.md, develop.md.
- src layers:
- less/ – all UI component styles in .less (accordion.less, buttons.less, etc.).
- js/ – component scripts and utilities (router.js, modal.js, pull-to-refresh.js, util.js, zepto-adapter.js).
- dist/ – compiled/minified outputs ready for CDN or npm (dist/css/*.css, dist/js/*.js).
- docs/ – Jekyll-style documentation site (layouts, includes, demos, examples, assets).
- js/tests/ – browser-based unit tests (via PhantomJS).
- examples/ – standalone HTML/CSS/JS demos showing integration.

##### README Insights
- Emphasizes design inspiration (Framework7, Ratchet, Ionic) and CDN distribution.
- Invitation for issues/PRs; link to develop.md for contribution guidelines.

##### Main Components
a. Source Modules
- LESS source (UI component styles)
- JS source (widget logic + utilities + adapters)
b. Build System & Pipeline
- Grunt tasks: compile LESS → CSS, lint JS, concatenate/minify JS, generate dist artifacts.
- NPM scripts / package.json references.
c. Distribution Artifact
- dist/css/sm.css, sm-extend.css
- dist/js/sm.js, sm-extend.js, sm-city-picker.js
- Published to GitHub Pages / CDN / npm registry
d. Documentation Site
- Jekyll engine (_config.yml, _layouts, _includes, .md pages) → static site in docs/
- Assets: docs/assets/css, js, img
- Demos: docs/demos, docs/examples
e. Example Integrations
- Standalone HTML + CSS + bundled JS examples in docs/examples/baichuan
f. Testing
- js/tests/unit using PhantomJS (unit tests for JS components)

##### Interactions and Data Flows
- Developer edits source (less/ or js/) → triggers Grunt → outputs dist/
- dist/ artifacts feed into:
- Documentation demos (docs/assets or via CDN)
- Example pages (docs/examples)
- NPM/npm publish & CDN distribution
- Jekyll build uses docs/ source + dist artifacts to produce the live docs site
- Test runner pulls JS source (or dist) to validate widget behavior
- External services: GitHub for code & issues, npm registry, Alibaba CDN, Travis CI (if present)

##### Architectural Patterns and Principles
- Modular front-end architecture: one folder per UI component (both LESS & JS).
- Build → dist separation: clean separation of source vs. distributable.
- Documentation as first-class citizen: Jekyll templating for reusability of components in docs.
- Extensibility points: “extend” variants (sm-extend.css/js), plug-in hooks in router, pull-to-refresh.

##### Essential Elements to Capture
- Source modules separated by technology (LESS vs. JS)
- Build configuration (Gruntfile.js) and its tasks
- Output artifacts and their destinations (CDN, docs, npm)
- Documentation and demo generation path
- Testing harness for maintaining quality
- External dependencies (Zepto, FastClick, iScroll)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Developer Workflow"
        direction TB
        LessSource["LESS Source Modules"]:::source
        JSSource["JavaScript Source Modules"]:::source
        CoreThemes["Core Themes & Variables"]:::source
        InitScript["Entry Point & init.js"]:::source
        Gruntfile["Gruntfile.js"]:::build
        PackageJSON["package.json"]:::build
        BuildSystem["Build System & Pipeline\n(Grunt Tasks)"]:::build
    end

    subgraph "Artifacts & Outputs"
        direction TB
        DistCSS["dist/css/*.css"]:::output
        DistJS["dist/js/*.js"]:::output
        DocsSource["Documentation Site Source (docs/)"]:::output
        JekyllBuild["Jekyll Build"]:::output
        DocsSite["Live Docs Site"]:::output
        Examples["Example Integrations"]:::output
        Tests["Testing Harness"]:::output
    end

    subgraph "External Services"
        direction TB
        GitHub["GitHub Repository & Issues"]:::external
        TravisCI["Travis CI"]:::external
        NPM["npm Registry"]:::external
        CDN["CDN (Alibaba/GitHub Pages)"]:::external
    end

    subgraph "End-User Consumption"
        direction TB
        CDNServe["CDN Hosted Assets"]:::external
        NPMPackage["npm Package"]:::external
        DemoPages["Docs Demos & Examples"]:::external
    end

    GitHub -->|"push/webhook"| TravisCI
    TravisCI -->|"trigger build"| BuildSystem
    LessSource -->|"compile less"| BuildSystem
    CoreThemes -->|"compile less"| BuildSystem
    JSSource -->|"lint & concat"| BuildSystem
    InitScript -->|"include in bundle"| BuildSystem
    Gruntfile -->|"defines tasks"| BuildSystem
    PackageJSON -->|"npm scripts/meta"| BuildSystem

    BuildSystem -->|"outputs"| DistCSS
    BuildSystem -->|"outputs"| DistJS
    BuildSystem -->|"copies"| DocsSource
    BuildSystem -->|"runs"| Tests

    DistCSS -->|"feed assets"| JekyllBuild
    DistJS -->|"feed assets"| JekyllBuild
    DocsSource -->|"jekyll build"| JekyllBuild
    JekyllBuild -->|"deploy"| DocsSite

    DistCSS -->|"publish"| CDN
    DistJS -->|"publish"| CDN
    DistJS -->|"publish"| NPM

    DocsSite -->|"serves"| DemoPages
    Examples -->|"standalone demos"| DemoPages

    DistCSS -->|"install"| NPMPackage
    DistJS -->|"install"| NPMPackage

    NPMPackage -->|"via npm"| End-User
    CDNServe -.->|"via CDN"| End-User
    DemoPages -.->|"via docs"| End-User

    click LessSource "https://github.com/sdc-alibaba/sui-mobile/tree/dev/less/"
    click JSSource "https://github.com/sdc-alibaba/sui-mobile/tree/dev/js/"
    click CoreThemes "https://github.com/sdc-alibaba/sui-mobile/blob/dev/less/themes.less"
    click InitScript "https://github.com/sdc-alibaba/sui-mobile/blob/dev/js/init.js"
    click Gruntfile "https://github.com/sdc-alibaba/sui-mobile/blob/dev/Gruntfile.js"
    click PackageJSON "https://github.com/sdc-alibaba/sui-mobile/blob/dev/package.json"
    click DistCSS "https://github.com/sdc-alibaba/sui-mobile/blob/dev/dist/css/sm.css"
    click DistJS "https://github.com/sdc-alibaba/sui-mobile/blob/dev/dist/js/sm.js"
    click DocsSource "https://github.com/sdc-alibaba/sui-mobile/tree/dev/docs/"
    click Examples "https://github.com/sdc-alibaba/sui-mobile/tree/dev/docs/examples/baichuan/"
    click Tests "https://github.com/sdc-alibaba/sui-mobile/tree/dev/js/tests/unit/"

    classDef source fill:#D6EAF8,stroke:#21618C,color:#1B2631
    classDef build fill:#D5F5E3,stroke:#196F3D,color:#1B2631
    classDef output fill:#F9E79F,stroke:#B9770E,color:#1B2631
    classDef external fill:#D2B4DE,stroke:#6C3483,color:#1B2631
```
