ledger_host library
Ledger's host layer, for an app that shows the look's screens in a shell of its own: the scaffold every
look shares (package:ui_core/host.dart: its tabs, its main action, its background and insets, the
preview frame and platform) and Ledger's own part of it. An app that draws its screens from
package:ledger_ui/ledger_ui.dart does not need this library; the look's own chrome, gallery and tests import it
beside that one.
Outside semver: this library may change in any version, a patch included; the CHANGELOG says how to move.
Classes
- ChromeGroundScope
-
Publishes the ChromeGround of the page it wraps.
ChromeRoutes.pagemounts one inside a pushed page and inside a branch root (from its NavTab.ground); a system's chrome inside the page reads it. - DisplayFormat
-
The formatters. A design system re-exports this file from its own
format.dartand may name the class after itself (typedef ExpressiveFormat = DisplayFormat;), so page code readsExpressiveFormat.money(…). - LedgerChromeMetrics
- The chrome's measures, by the part that draws them.
- LedgerHost
-
The one mount of Ledger. Picks the theme for the brightness in force,
publishes it as a LedgerTheme, gives the platform primitives
beneath the thin Material
ThemeDatathey read, paints the ground behind the app, sets the body type as the default text style, carries status-bar polarity, and lets the reader's text size reach maxTextScale (200%): rows grow and wrap to it, and past it a page stands at 200% rather than break. Day to night (or one theme to another) the paper and the ink fade across in LedgerMotion.slow (AnimatedLedgerTheme); with reduced motion on they change at once. It hosts the toasts (LedgerToaster). Every render host mounts it once above its Navigator: the app in its router builder, a page preview in its own. - LedgerMediaGround
- Stands child on the media ground: the host's dark tokens under a light status bar, for chrome drawn over a full-bleed photograph or video (the shell's bar on a media tab). Nothing in it blurs.
-
LedgerPage<
T> -
The go_router Page for a route pushed off a root: its route is laid
down in Ledger's page motion (
LedgerPageTransitions, which the host sets on every platform), standing on the theme's ground. - LedgerPreview
- One page's isolated preview: the same host, bar, route and sheet the app gives the page live, without the router, so preview pixels match in-app pixels and the chrome the route derives is the real one: the way back when pushed, the close on a sheet. A pushed or sheet page is raised over a blank stage so its exit renders as it does live; a preview is looked at, not walked out of, so the exit leaves the page standing. A root stands over the tab bar on a phone; at desktop width a root and a pushed page stand beside the sidebar (tabs, activeIndex its current), as the shell stands every page there. Given the page's location, the sidebar marks the account's foot when the page is its profile.
-
LedgerSheetPage<
T> -
The go_router Page whose route is Ledger's page sheet, created on the
root navigator so it rises over the shell's bar. drawer stands it as
tall as its content, confirm as the narrower dialog of a question at
desktop width; fullScreen raises a full-screen cover on the ground
instead, with no barrier, drawn as a pushed page whose exit is the close.
Either publishes
RoutePresentation.sheetaround its child, so the screen inside derives its close, or with back the way back. - MediaSlot
- Where a slot's picture comes from.
- MediaSlotImage
- Trusted image delivery for one declared media slot, shared by a system's photo and avatar components. fallback stands in while the picture is pending and whenever it misses, so a pending image never delays layout, first paint or publication.
-
One tab of the shell's navigation: a branch's root, with the glyph and
the words it wears. The runtime emits one per
StatefulShellBranch, in branch order; the system decides how it looks. - PreviewDevice
- The device a platform previews on: its logical size and pixel density. The oracle captures and the gallery's renders use the same numbers.
- PreviewFrame
- The frame a preview stands in: publishes its platform and brightness to everything inside it, scopes the platform override there, and publishes its box as the screen.
- PreviewFrameData
- What a PreviewFrame publishes to everything inside it.
- PreviewStage
- A stage that raises a previewed page on a route over itself once it is on screen, and keeps it raised: how a pushed or sheet page is previewed alone, so its exit renders as it does live and the chrome it derives is the real one (RoutePresentation.pushed or the sheet's).
- RoutePresentationScope
- Publishes the RoutePresentation of the route it stands in, overriding what the route's position implies. A system's sheet page wraps its child in one with RoutePresentation.sheet; a preview or a hand-built navigator may publish any presentation.
- ShellAction
- The app-level act beside the shell's tabs: the one thing reachable from every root — add, compose, capture — with the glyph it wears and what it does. A system draws it in its own way (a floating action button, a disc in the bar, a square at its end).
- ShellInsets
- The bottom inset the shell's bar asks every branch root to keep clear: published by a system's shell over its branch container (and by a preview that stands the bar under a lone page), spent by the system's screen on its scroll padding and by its toast on its inset.
Enums
- ChromeGround
- The ground a page stands on, which is what its chrome is drawn against: the system's own surface, or media — a full-bleed feed of video or photographs, over which the chrome is dark and solid.
- LedgerPresentation
- How a previewed page stands in the app: as a nav root over the shell's bar, pushed off one, or raised as a page sheet.
- PreviewPlatform
- The platform a preview is drawn for: its device size and the platform whose behaviour applies inside it. The look is the system's everywhere; behaviour (scroll physics, back gestures, text handling) follows this platform.
- RoutePresentation
- How a route is presented, which is what a screen derives its bar from: the title on a root, the back affordance on a pushed page, the dismiss affordance on a sheet. A page never authors its own back or close; it reads its presentation (of).
Extensions
- PreviewPlatformDevice on PreviewPlatform
- The platform's device, as data on the enum.