Documentation
Guides
Framework 3.2 guides for migration, enhancement workflows, and TRMNL X compatibility, plus how the open-source repository is built and how to contribute.
V3.2 Overview
What's new in Framework 3.2: themes, the TRMNLPaint JS API, adaptive charts and icons, and theme-driven borders
V3.2 Upgrade Guide
Compatibility notes for upgrading plugins to Framework 3.2
V3.2 Enhancement Guide
Make your plugin theme-ready and adopt adaptive charts, icons, and JS paint
TRMNL X Guide
Framework changes for TRMNL X compatibility
Open Source
What this repository is, how it fits together, and the paint mandate that shapes it
Contributing
Run the framework locally, find your way around, run the tests, and open a good pull request
Foundation
The structural hierarchy of Screen, View, Layout, Title Bar, Columns, and Mashup: the fixed scaffolding for plugin content.
Typography
Font families, glyphs, text size and scale, weight, color, alignment, and stroke utilities for controlling how text appears across devices and orientations.
Arrangement
Control dimensions, spacing, and arrangement of elements. Size, spacing, gap, flex, grid, and aspect ratio are the building blocks for structure.
Responsive Utilities
Breakpoints, bit-depth variants, and visibility controls: the building blocks for adaptive layouts.
Styling
Control appearance and visual effects. Background, border, image, scale, and inverse colors are the building blocks for custom interfaces.
Runtime
The Framework Runtime and the engines it drives at render time: overflow, clamping, value formatting and fitting, content limiting, and pixel-perfect text.
Paint API
TRMNLPaint, the JavaScript paint API. Read the live CSS cascade to resolve framework colors, borders, and typography for canvases, SVGs, and charts.
Sass API
The framework SCSS source for custom stacks. Compile your own build, add custom device profiles, and author device-aware styles with the framework mixins.
Themes API
Opt-in stylesheets that re-theme screens while preserving device-capability rendering: usage, the authoring contract, and every themable slot.
CSS Variables
The public CSS variable surface: the palette, every token with its per-mode values, and the contract for who reads, re-points, and generates them.
Elements
Atomic text and separator elements: Title, Value, Label, Description, and Divider. Use these for consistent typography and visual structure.