fluent2_design_host library

Fluent 2'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 Fluent 2's own part of it. An app that draws its screens from package:fluent2_design_ui/fluent2_design_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.page mounts 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.dart and may name the class after itself (typedef ExpressiveFormat = DisplayFormat;), so page code reads ExpressiveFormat.money(…).
Fluent2Account
Who the app belongs to, as its chrome shows them: their name and initials (or image) in the avatar, the quiet meta line under the name at the nav pane's foot, the unread count the bell wears, and where the avatar (onProfile) and the bell (onNotifications) lead. The app mounts one Fluent2AccountScope above its router; the top bars and the nav pane read it, so no page passes the person around. profileLocation is the profile page's path: the pane's foot is current there (a :name segment stands for any one, so '/:root/profile' is the profile pushed on any root). notificationsLocation is the bell's page.
Fluent2AccountScope
Publishes the app's Fluent2Account to its chrome: mount one above the router (around the host's child).
Fluent2Bell
The bell that opens account's notifications, its count at its top end corner. Plumbing of the bars.
Fluent2ChromeMetrics
The bars, panes and parts of Fluent 2's chrome, in logical pixels.
Fluent2Host
The one mount of Fluent 2 in a host app. Picks the theme for the brightness in force and puts it in scope with a Fluent2Theme (which gives the platform primitives beneath the thin Material ThemeData they read and sets Fluent's body1 as the default text style), paints the page's ground behind the app, carries status-bar polarity, and clamps the text scale at maxTextScale so a large accessibility size grows rows rather than breaking them. Every render host mounts it once above its Navigator: the app in its router builder, a page preview in its own.
Fluent2InventoryGallery
Fluent 2's inventory, listed: each group under its heading with how many of its rows the look carries, then each row in a card, its class and what a person calls it over its live specimen. It scrolls itself, so it fills a screen that does not scroll.
Fluent2MediaGround
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.
Fluent2Page<T>
The go_router Page for a route pushed off a root: on Material's page route, so the push runs the page motion the Fluent2Theme sets for the platform (Fluent2PageTransitionsBuilder: Fluent 2's own, everywhere, on iOS with the swipe back from the screen's leading edge), standing on the ground (on the desktop, the content layer the shell stands its pages on).
Fluent2Preview
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 dismiss on a sheet. A pushed or sheet page is raised over a blank stage so its exit renders as it does live. A root stands over the tab bar on a phone; at desktop width a root and a pushed page stand on the content layer beside the nav pane (tabs, selectedIndex its current). Given the page's location, the pane marks the account's foot when the page is its profile.
Fluent2SheetPage<T>
The go_router Page whose route is Fluent 2's page sheet, created on the root navigator so it rises over the shell's bar. drawer stands it as tall as its content on a phone and as the end drawer on the desktop; fullScreen raises a full-screen cover on the ground instead, drawn as a pushed page whose exit is the dismiss. Either publishes RoutePresentation.sheet around its child, so the screen inside derives its dismiss, or with back the way back.
Fluent2ShellAction
The app-level act beside the tabs, as Fluent 2 draws it: the floating action button over the tab bar's end on a phone (extended with its label), and the primary button under the nav pane's head at desktop width.
Fluent2ShellInsets
The bottom allowance the shell asks each branch root to reserve: the tab bar over the device inset, the act and any accessory over it. The shell publishes it through the design kit's ShellInsets; a screen reads it with of.
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.
Fluent2Presentation
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.

Constants

fluent2InventoryHeights → const Map<String, double>
The specimens that fill the height they are given; a gallery frames each in a box of this height.

Properties

fluent2Inventory → DesignInventory
Fluent 2's inventory: every row of the shared component list, answered.
final