How mendix/atlas-ui-framework works
Project type and purpose
• This is a UI theming package (“Mendix Atlas 2 UI”) that provides styling for both web and native Mendix applications.
• It contains source files (SASS, TypeScript, JavaScript), build scripts, sample HTML entry points, and configuration for design properties.
File structure
• Top-level:
• index.html / index-rtl.html / login.html / login-with-sso.html — sample web entry points
• scripts/ — version bump utilities
• styles.js — JS-based style exports
• settings*.json — design-property configuration
• styles/
• web/ — SASS source + compiled CSS assets
• native/ — JS/TS source for React Native theming
– core/ — base variables, helpers, widgets
– app/ — _custom overrides for variables & styles
– ui_resources/atlas_ui_resources — building blocks, layouts, page templates
• configuration: package.json, tsconfig.json, manifest JSON files
README for additional insights
• The package separates “core” styling from “app” (custom) styling and “UI resources” (blocks, layouts).
• Build process for web uses SASS → CSS (via Calypso or other SCSS compiler).
• Native styling ships as JS/TS modules consumed by the Make It Native app.
• External tools: Calypso, Mendix Design Property Tool, React Native Debugger.
a. Main components
1. Source Repositories
– Web SASS files (styles/web/sass)
– Native JS/TS files (styles/native/js & styles/native/ts)
– Core vs. App (custom overrides) vs. UI Resources
2. Build Tools
– SCSS compiler (Calypso/webpack)
– TypeScript compiler / bundler
– Version bump scripts
3. Output Artifacts
– Web: CSS files (styles/web/css/main.css, source maps)
– Native: JS bundles (styles/native/js/main.js) + manifest
4. Deployment / Consumption
– Mendix Web Apps (load CSS & JS via index.html)
– Mendix Native Apps (import JS modules in React Native)
5. External Services & Tools
– Calypso (SCSS → CSS)
– Design Property Tool (visual theme customization)
– React Native Debugger (inspect native styles)
b. Relationships & data flows
– “scripts/” interacts with package.json to bump versions before builds
– Settings JSON files feed into both build pipelines to generate theme variables
– UI Resources modules consumed by both build outputs
c. Architectural patterns & design principles
– Separation of Concerns: core styling layer vs. custom overrides vs. UI resources
– Theming pipeline: source → compile → output → runtime consumption
– Monorepo-style packaging: tight coupling with widgets-resources repo for shared assets
d. Key technologies, frameworks, libraries
– SASS/SCSS, Calypso (or equivalent)
– TypeScript, Babel/Metro (for React Native)
– Node.js scripts for automation
– Mendix platform (web & native runtime)
Detailed breakdown for components
• Core Styling Layer
• Base variables, helpers, widget defaults
• Shared by web & native pipelines
• App (Custom) Layer
• _custom-variables.scss / .js
• Overrides core variables
• UI Resources Layer
• Building blocks (card, header, chat…)
• Layouts & page templates
• Build Scripts
• bump-major/minor/patch (versioning)
• Integration with CI/CD pipelines
• Entry Points
• index.html family for web demos
• Manifest JSON for native bundling
Final advice
• Don’t overthink – represent each directory as a node, group related ones visually.