internals library
What the SDK is made of and an app does not need: the pieces between a
published screen and its render objects that the SDK's own tools and tests
reach for (bound values, the viewport's boxes, route internals, the
session view's sources). Nothing here is a stable API: it may change in
any release. An app imports package:codelessly_sdk/codelessly_sdk.dart.
Classes
- BackGuard
-
Registers a PopEntry on the route it's in whose
canPopis!blocksBack(), read when back is pressed (no rebuild needed to follow the values it reads); a blocked back calls onBackPressed. - BoundNode
- A node as shown: its bound values applied.
- BoundSource
- A NodeSource over base with each node's bindings applied by engine in scope. A node re-resolves when its source node changes, or when the scope changes and its last resolution read a value.
- BoundValues
-
The values one node reads and writes, by name or path (
volume,item.price,draft.title). - BoundVariable
- A variable a node's render objects write.
- CanvasBox
- The box a canvas takes, and the size it's laid out at inside it.
- CanvasLocationMatch
- The screen a location opens and the params it passes to it.
- CanvasSizingScope
- The sizing a modal asks of the screen it shows: a modal that covers the screen has its screen fill it (CanvasSizing.fill) rather than keep its design size.
- CanvasViewport
- Canvas sizing by scale mode.
-
CodelesslyPageTransitionRoute<
T> -
A screen's route playing transition (not the platform's) over
transitionMsand back overreverseTransitionMs, flying shared elements as long as it lasts. -
CodelesslyRouteTransitionRoute<
T> - A page route that plays a RouteTransition (resolved: its preset's values filled in). A modal one shows a modal (see-through, with a barrier, closed by a close modal action).
-
CodelesslyTranslucentRoute<
T> - The route of a screen drawn over the one beneath it, which stays visible behind (a lightbox, a dialog: ScreenRoute.translucent). It fades in.
- ControlFocusLayerScope
-
The modal overlay (a dialog, a sheet, a popover) the screens under it are
shown in: each NodeView below puts its focus scope in layer, so the
keyboard stays in the overlay while it is the top one
(render/controls/focus.dart's
ControlFocusLayer). The host that opens the overlay's route puts it there (ModalFocus, app/ui/presentation_route.dart). - ExpressionValues
-
BoundValues that also work out expressions with names of the
caller's own over the node's: a draw list's
item,indexandsize(render/custom_paint.dart). The runtime's values are these. - FocusManagerKeyboard
-
Key events for a root from Flutter's
FocusManager(its early handlers, so a key a control handles never reaches Flutter's own traversal), and the bridge between the two focuses: a control taking the focus unfocuses the app's focused widget; the app focusing one of its widgets (an island's text field) takes the focus from the controls. - FontRegistrationCache
- Deduplicates engine registrations by family and actual file bytes, including concurrent loads and overlapping style sets. Failed loads remain retryable.
- HitTestedWhereDrawn
- A layer drawn away from where its node is laid out (a node that follows the pointer): the node's box hit tests it wherever it is, not only inside the box's own bounds.
- InstanceBindings
- TreeBindings that keep state per component instance (its scopes): told when an instance leaves the tree, so they let go of it.
- ManagedComponentResolver
- Brings a layout's managed instances to the version their channel offers now (see the library comment), falling back to each instance's snapshot on any failure.
- ManagedComponentSource
-
Where managed component masters and versions come from
(
managed_components/{id}and itsversions/{n}): Firestore inpackage:codelessly_sdk/firebase.dart(FirestoreManagedComponentSource), memory in tests. - MapValueScope
-
A ValueScope over a map of named values: the app's data, a screen's
variables and route params. Paths read into maps and lists
(
user.name,items[0].price,items.0); a name this scope doesn't hold is read from parent. - MemoryManagedComponentSource
- A ManagedComponentSource in memory, for tests and offline apps.
- ModalFocus
- Wraps the content of a modal route: see the head of this file.
- An ActionUi on the nearest Navigator of context: navigation pushes routes, modals show modal screens as Material dialogs and sheets, toasts are snack bars, confirms an AlertDialog (or the screen they name).
- NodeGestures
-
The gesture layers the runtime adds to a node's box: gestures that move
data (a dragged node's
dragvalues, a drop's reactions), not only pixels. Given to a tree (RenderTree.gestures). - PopoverLayout
- Lays a popover out by its anchor (see showAnchoredModal).
- PublishAssetSource
-
A loader of a site that ships files beside its documents: the fonts it
declares (
site.json'sfonts) and its local images, which documents name by their path relative to the site (fonts/Inter.ttf,images/hero.jpg), as a Flutter app names its assets. The runtime reads them through the loader that loaded the site. - RenderNodeView
- RouteDragDismiss
- A drag that closes route interactively: anywhere on it, or from its edge within edgeWidth (a swipe back).
- ScreenActionContext
-
The ActionContext of one screen: its variables (over the route's
params and the app's data), services, UI and node tree. The app can set
variables no screen declares (RuntimeActionContext.declareMissing).
On a paywall's screen, its
paywallactions act on paywall. - ScreenIdentity
- The title and description of one screen.
- SessionValues
- NodeValues over a UiSession that passes on a notification with no change too (a parent whose pending child arrived re-lists its children).
- ThemedSource
-
A node source whose nodes have theme's names resolved (
"color": "primary","style": "body"), as a published site's are; the same nodes when the theme names nothing they use. - TransitionPhysics
- The spring a released interactive transition settles with, and whether a release closes the route.
- TransitionSideView
- child moved amount (0 at rest, 1 at its values) of the way to side's motion, and clipped by its reveal.
- TreeBindings
- Gives a tree each node as shown, and its render objects the values they read and write. Without one a tree renders its nodes as stored.