Documentation
Guides
Step-by-step guides for Framework v2: overview, upgrading, enhancing plugins, troubleshooting, and TRMNL X compatibility.
V2 Overview
What's new in Framework v2: utilities, components, and guides
V2 Upgrade Guide
Steps to upgrade your plugins to Framework v2
V2 Enhancement Guide
Device, bit-depth, and orientation-responsive patterns for plugins
V2 Troubleshooting
Resolve issues surfaced by v2's stricter markup requirements
TRMNL X Guide
Framework changes for TRMNL X compatibility
Foundation
The structural hierarchy of Screen, View, Layout, Title Bar, Columns, and Mashup: the fixed scaffolding for plugin content.
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.
Modulations
Engines and systems that adapt content at render time: overflow, clamping, value formatting and fitting, content limiting, pixel-perfect text, and the Framework Runtime.
Elements
Atomic text and separator elements: Title, Value, Label, Description, and Divider. Use these for consistent typography and visual structure.