codelessly_api library
Flutter's widgets and layouts as plain, immutable data.
Classes
- AccordionProps
- An accordion: its first child is the header (with a toggle button over its end), its second the content shown while expanded.
- ActionCommonFields
- The fields every action has.
- ActionDef
-
One action. Every action can be turned off (enabled), run without
being awaited (nonBlocking: the chain goes on at once and its failure
doesn't stop it) and run only while a predicate holds (when). JSON:
{"type": type, ...its fields, "enabled": false, "nonBlocking": true, "when": {...}}. Unknown types decode as UnknownAction. - ActionSpec
- An action type, as an editor shows it.
- ActionSpecs
- Every action type an editor can make, by JSON type.
- ActivityIndicatorProps
-
Flutter
CupertinoActivityIndicator. - Alignment
-
Flutter's
Alignment: -1 (start) to 1 (end) per axis. JSON:[x, y]. - AnimateVariableAction
- Animates number variable variable over time: plays it from from to to over durationMs (or duration, an expression giving milliseconds) along curve, or pauses, resumes, stops or seeks the animation it runs. A play (or a resume) completes when its timeline ends: make it non-blocking to go on at once. Resume with nothing paused plays from where the value is.
- AnimateVariableFields
- AnimateVariableAction.
- AnimationCurveCodec
-
An AnimationCurve, by the name of its Flutter
Curvesconstant. Reads as leniently as the models do (AnimationCurve.parse). - ApiInput
-
An input of an API:
${name}in its URL, headers, query, form or body takes the value an action passes, else defaultValue. - AppBarProps
-
AppBar. - AppIdentity
-
A published app's identity (the publish model's
appIdentity). JSON: the identity's own (see the file comment), with every key this version doesn't model kept in extra. - AudioPlayerProps
-
A network audio player (
just_audio). - AuthAction
- Signs app users in, up and out, and manages their account. A failure's message goes in errorVariable (and stops the chain).
- AuthFields
- AuthAction.
- Automation
-
One automation of a project. Its when and its actions read the app's
values (variables,
auth,storage,data),${event}(name,props) and${usage}, the per-user counters the runtime keeps on the device: - AutomationFields
- An Automation's fields, for generated editors (its JSON keys and defaults).
- AxisPosition
-
Where a child of a freeform (stack) parent sits on one axis, as
Flutter's
PositionedorAlign, in the parent's padded box: - AxisSize
-
Sizing along one axis. value is the design size: the size for
SizeFit.fixed, and the fallback whenever a mode can't apply. JSON: a
number (fixed) or
{"fill"|"flexible"|"hug": value}. - BadgeProps
-
Badge: a small label (or a dot) over itschildslot. - BarChartProps
- A bar chart of values with optional labels, grid and a highlighted bar.
- BarcodeProps
- A barcode or QR code of data, filling the box.
- BehaviorFields
-
A node's Behaviors, one per key of Behaviors.keys: stored flat in
the node's JSON (
"motion": {...},"tooltip": "..."), defaults as in Behaviors.none. - Behaviors
- A node's behaviors. Stored flat in the node's JSON under keys.
- BindPaths
- Binding paths (keys of Node.bind) and how values are applied to them.
- BindValue
- Loose readers for bound values (what an expression gave). Each returns null for a value it can't read.
- BoolCodec
- BorderRadius
-
Flutter's
BorderRadius: four corners, each circular or elliptical. JSON (sparse, see fromJson):8,[16, 8]or[8, [16, 8], 0, 0]. - BorderSide
-
Flutter's
BorderSide. A null color is unset: the widget's theme default where it has one, else Flutter's black. - BorderSideFields
- BoxConstraints
-
Flutter's
BoxConstraints, where a missing bound means unconstrained. - BoxProps
-
A leaf box: Flutter
Containerwith a decoration and no child. - Breakpoint
- One screen size class of a project: from minWidth (inclusive) up to the next breakpoint's.
- Breakpoints
- A project's breakpoints, narrowest first (DESIGN.md §5.3).
- BreakpointWidthsCodec
- Breakpoint id → width (a variance's own switch points).
- ButtonProps
-
ElevatedButton,FilledButton,TextButton,OutlinedButton: a label with an optional icon (their.iconconstructors), styled by aButtonStyle. - ButtonSegment
-
Flutter's
ButtonSegment<String>: one segment of a segmented button. - ButtonSegmentFields
- ButtonStyle
-
Flutter's
ButtonStyle, as the buttons'styleFromtakes it. Null fields are the button's own defaults. The padding is the node'slayout.padding; the size is the node's box (no minimum size). - ButtonStyleFields
- CallApiAction
-
Calls API api (the publish model's
services.apis) with params, its inputs (expressions; an empty one takes the input's default). Then onSuccess runs after a 2xx response, onError after any other or a failed request, both reading the response as${result}. A failed request without onError stops the chain. - CallApiFields
- CallApiAction.
- CallFunctionAction
-
Calls a function the app registered by name with params (text
values are expressions). Its result is the chain's
${result}: what the app's code answered (a permission granted, a share completed), which the next actions branch on. A function the app didn't register fails the chain, unless the action is optional. - CallFunctionFields
- CallFunctionAction.
- CanvasBreakpoint
- Which project breakpoint a canvas of a layout is the design for (DESIGN.md §5.3). A layout with several canvases (one screen, one canvas per breakpoint) shows the one whose switch point is the highest at or below the width it's shown at (see CanvasBreakpointsForWidth.forWidth).
- CanvasProps
-
A screen (
Scaffold): itsbodyslot is the page content. - CaptureScreenshotAction
-
Captures what is on screen as a PNG image.
${result}is{"image": "data:image/png;base64,...", "width", "height"}(in pixels): bind it to an image fill to show it, or upload it with acloudFilesaction whosesourceis${result.image}. JSON:{"type": "captureScreenshot", "target": "app"}. - CaptureScreenshotFields
- CaptureScreenshotAction.
- ChartProps
- A chart of data rows: bars, lines and areas over categories, a timeline of segments, or a donut.
- ChartReferenceLine
- A horizontal line across a chart's plot at value.
- ChartSeries
- One series of a chart: the values of field in each data row.
- CheckboxProps
-
Flutter
Checkbox, scaled to its box (40 px is Flutter's own size, 18 px when compact). - ChipProps
-
Chip,ActionChip,ChoiceChip,FilterChipandInputChip. - CircularProgressIndicatorProps
-
Flutter
CircularProgressIndicator: a spinner, or a ring filled to value. startAngle and sweepAngle draw it as an arc (a dial). - CloseModalAction
-
Closes the modal it runs in, giving the chain that opened it result
(its text values are expressions) as
${result}. - CloseModalFields
- CloseModalAction.
- CloudBatchAction
-
Several CloudDataAction writes (create, update, delete) committed at
once. With forEach, steps run once per item of that list
(
${loop.item},${loop.index}), every write in the same commit: "mark all read" in one write instead of one per item. - CloudBatchFields
- CloudBatchAction.
- CloudDataAction
-
Creates, updates, deletes, reads, queries or aggregates documents of a
collection. Its result (the new id, the document, the documents, the
number) is the chain's
${result}and goes in resultVariable. - CloudDataFields
- CloudDataAction.
- CloudDocumentsAction
- Writes documents of a cloud collection: one at a time by id, or many at once.
- CloudDocumentsFields
- CloudDocumentsAction.
- CloudFieldWrite
- One field a CloudDataAction writes: value is an expression.
- CloudFilesAction
-
Uploads files the user picks to (or deletes them from) cloud storage
folder path; actions run with each file (
${result.url}...). With a source, it uploads that value instead of asking the user (a captured screenshot, a drawing). - CloudFilesFields
- CloudFilesAction.
- CloudJoin
- Documents of another collection attached to each document a query loads: per item, the matching document of collection goes in field as (null when none; with many, a list of every match).
- CloudQueryDef
-
A query of a cloud collection, as a data-bound list (
listView.query) or a cloud data action stores it: - Codecs
-
Common codecs. Nullable variants (
optional*) read a missing or unreadable value as null. - CollectionCodecs
- Codecs for the collections' value types.
- CollectionSchema
- The typed fields of a collection.
- CollectionScrollProps
-
The props every scrolling collection shares (
ScrollView's parameters). - CollectionSlots
- The slots a list or grid takes besides its item template.
- Color
-
A 32-bit ARGB color, as Flutter's
Color. JSON:"#AARRGGBB"("#RRGGBB"and ints also read). - ColorStop
- One gradient stop.
- ColorStopFields
- Comparison
-
left op right(the right side only for ops that ConditionOp.takesRight). - ComponentDefinition
- A component in a project's library: its nodes as a layout document with one root, its design size, and where it was made from.
- ComponentLink
-
A node's link to a component (
Node.component): the component's main node, or the top node of an instance of it. - ComponentSetting
- One thing a component lets an instance customize, or a group of them.
- Condition
- An if / else-if / else rule. Its first branch whose test holds and that sets a property gives the property its value; when none does, the property keeps its binding's or its own value. JSON:
- ConditionBranch
-
One branch: when when holds (always, for an
else: null), the properties in sets take their values. - ConditionOperand
-
One side of a Comparison: an expression text whose
${...}are read (${count},${= a + b},3,done), or, when raw, a literal taken as written. Both are then parsed loosely (3is a number,truea bool,[1, 2]a list). JSON: the text, or{"raw": text}. - ConfirmAction
-
Asks the user to confirm; runs actions when they do, cancelActions
when they don't. With dialog (a screen id), that screen is the dialog
and what its close modal action returns is
${result}. - ConfirmFields
- ConfirmAction.
- ControlDragAction
- Flings, returns, resets or shakes draggable node node (a swipe card), or steps a drag track.
- ControlDragFields
- ControlDragAction.
- CopyToClipboardAction
- Copies text (an expression) to the clipboard.
- CopyToClipboardFields
- CopyToClipboardAction.
- DataRules
- The rules, schemas, composite indexes and write roles of a project's collections.
- DatePickerProps
-
An
OutlinedButton(or, with a decoration, a read-only field) showing a date (yyyy-MM-dd) that opensshowDatePicker. - DateTimeInputProps
-
An outlined
InputDecoratorshowing a date, time or both, that opens the pickers. - Decoration
-
A box's paint: Flutter's
BoxDecoration, with stacked paints as in a design tool (fills bottom to top, then strokes). - DecorationFields
-
A node's Decoration, field by field (JSON under
decoration). - DelayAction
- Waits ms milliseconds, or duration (a formula giving them) when that gives a number.
- DelayFields
- DelayAction.
- DividerProps
-
DividerandVerticalDivider: a line across the node's box. - DoubleCodec
- DownloadFileAction
-
Exports generated UTF-8 text (CSV, JSON, plain text...) as a file.
The browser downloads it; native apps show the platform save picker.
Cancellation returns
{saved: false}as the action result. - DownloadFileFields
- DownloadFileAction.
- DragMotion
- Makes the node follow the pointer: it tilts, and on release springs back, stays, or flies off past a threshold (a swiped card); with a track it's a value control.
- DragMotionFields
- DragSource
-
Lets the user pick the node up and drop it on a DropTarget that takes
its group (Flutter's
Draggable). - DragSourceFields
- DragTrack
-
Makes a dragged node a value control (a knob, a fader): it moves along
the track as variable variable goes from min to max, and the
design canvas draws it at the variable's value. Dragging it writes the
variable (unless write is off); a double tap goes to defaultValue
(or through doubleTapValues), the wheel and arrow keys step it. Inside
it
${track.value},${track.progress},${track.dragging},${track.fine}and${track.focused}can be read. - DragTrackFields
- DropdownProps
-
Flutter
DropdownButton<Object>. Its padding is the node'slayout.padding. - DropTarget
-
Takes DragSources of the groups it accepts (Flutter's
DragTarget). - DropTargetFields
- EdgeInsets
-
Flutter's
EdgeInsets(left, top, right, bottom). JSON: a number (all sides) or[left, top, right, bottom]. - EditTextAction
- Edits text field node's text at its cursor: wraps the selection in before / after, toggles a (numbered) list, inserts or sets text, replaces the word being typed, clears it or focuses it.
- EditTextFields
- EditTextAction.
- Effect
-
A shadow or blur (Flutter's
BoxShadow,ImageFilter.blur). - EffectAnimation
- A one-shot effect the node plays on cue (an action, a bound play key, or when it appears).
- EffectAnimationFields
- EffectFields
- EmbeddedVideoProps
- A YouTube or Vimeo video, played in a web view.
- EmitEventAction
-
Fires app event event with props (text values are expressions) on
the app's event bus: the project's automations listening for it run (a
popup after the third order), and the host app hears it
(
codelessly.events). The same bus a host fires withcodelessly.emit(name, props). JSON:{"type": "emitEvent", "event": "onboarding_done", "props": {"plan": "${plan}"}}. - EmitEventFields
- EmitEventAction.
-
EnumCodec<
T extends Enum> - ErrorTextCodec
-
Text, or a yes/no:
trueis kErrorWithoutMessage,falseno error. - ExpansionTileProps
-
Flutter
ExpansionTile. Thetileslot is a list tile whoseleading,title,subtitleandtrailingslots make the header; the children are shown while expanded. - ExternalProps
-
A widget the app builds (
Codelessly's external component builders). - FieldValue
- An immutable value made of declared fields, as a widget's props are: decoding is total, encoding sparse (a field at its default is omitted), equality by value. spec lists the fields (the editor's panels read it).
- FlexProps
-
RowandColumn: the same props, different main axis. - Flight
- How a node with a Behaviors.flightKey flies in from where the node with the same key was: on a spring by default, or, with a duration, along a curve that rises lift (or liftShare of the distance, the larger) above the higher end, swelling to swell at the middle and spinning turns times (toward the way it flies), trailing trail fading dots.
- FlightFields
- FlipCard
-
Makes the node a two-sided card (node key
flip; a runtime 3D turn, not a mirror): its first child is the front, its second the back, turned 180° in advance; each hides while it faces away. The turn is the node's own Motion (rotateY, or rotateX for FlipAxis.x, 0 or 180), with its perspective, duration (600 ms without one), curve and keyframes. Inside the card${flip.flipped}and${flip.progress}(0 front, 1 back) can be read. - FlipCardFields
-
FlipCard (node key
flip): a card that turns over. - FlipSpring
-
A spring (mass, stiffness, damping), as Flutter's
SpringDescription. - FlipSpringFields
- FloatingActionButtonProps
-
FloatingActionButton(and its small, large and extended forms). - FocusAction
- Focuses text field node (selecting its text with selectAll), or takes the focus away (unfocus; from every field when node is empty).
- FocusFields
- FocusAction.
- FontWeightCodec
-
Flutter's
FontWeight, as its weight: 100, 200 ... 900. - ForEachAction
-
Runs actions once per item of list items (a path or expression).
Every action of a turn reads the item and its index as
${loop.item}and${loop.index};${result.item}and${result.index}hold them too, until an action of the turn gives a result of its own. - ForEachFields
- ForEachAction.
- GaugeMeterProps
- A meter: value between min and max as a filled arc or bar (continuous or in segments), with ticks and a limit marker.
- GaugeZone
- A colored band of a radial gauge, from from to to in value units.
- GesturePhysics
-
How a node moves on its own once the pointer lets go, the same for a
DragMotion, a DragSource's return and a TransformGesture: a fling
that slows by friction, a stretch of overscroll past the bounds, and
a spring (stiffness, damping, mass; or bounce and duration, as
Flutter's
SpringDescription.withDurationAndBounce) onto the snap target nearest to where the fling would stop. - GesturePhysicsFields
- GesturePhysics: the release a drag, a drag source's return and a transform gesture share.
- GestureSnap
- The places a released node settles at (GesturePhysics.snap).
- GestureSnapFields
- GridViewProps
-
Flutter
GridViewwith a fixed cross-axis count (SliverGridDelegateWithFixedCrossAxisCount) or, when maxCrossAxisExtent is set, a maximum cell extent (SliverGridDelegateWithMaxCrossAxisExtent). - HapticAction
-
Buzzes the device (
HapticFeedback, on phones that support it; nothing elsewhere). Its commonwhenbuzzes only while a setting holds. - HapticFields
- HapticAction.
- HeroTag
-
Makes the node a shared element (Flutter's
Hero): it flies between its places on two screens with the same tag while a navigation plays. - HeroTagFields
-
HeroTag. Its JSON is
{"tag", "flight"}, or just the tag string when the flight is standard. - HttpApi
-
An HTTP API the app calls: method, URL, headers, query parameters and
body, each of which may hold
${input}placeholders. - HttpParam
-
A header, query parameter or form field: key and value may hold
${input}placeholders. A disabled entry is kept but not sent. - IconAction
-
An icon with its own size, color and tooltip: an app bar's leading icon
or action (Flutter's
IconButtoninAppBar.actions). actions are its reactions, as a node's. - IconActionFields
- IconButtonProps
-
IconButton: an icon, styled by aButtonStyle. - IconProps
-
Flutter
Icon(font icons) or an SVG/image icon. - IfAction
-
Runs then when condition holds, else orElse. JSON:
{"type": "if", "condition": {...}, "then": [...], "else": [...]}. - IfFields
- IfAction.
- ImagePaint
-
An image source and how it fills its box (Flutter's
DecorationImage). - ImagePaintFields
- IndicatorCodecs
- Codecs shared by the indicators declarations.
- InkWellStyle
-
The ink a tappable box shows, as Flutter's
InkWell: ripples and the overlays of its states. Clipped to the box's radius. - InkWellStyleFields
- InputBorder
-
Flutter's
InputBorder: anOutlineInputBorder(the default here), anUnderlineInputBorderorInputBorder.none. - InputBorderFields
- InputCodecs
- Codecs for the inputs' value types.
- InputDecoration
-
Flutter's
InputDecoration: a text field's border, label, hint, helper, error, prefix and suffix. Every field has Flutter's default (unset: the theme's). - InputDecorationFields
- InputIcon
-
An icon an input shows (
Icon): a glyph as the icon node'siconprop ({"source", "name", "codepoint", ...}or an image), its size and color, and the actions a tap on it runs. - InputIconFields
- IntCodec
- Junction
-
All of parts (
and) or any of them (or). Every part is evaluated. JSON:{"and": [...]}/{"or": [...]}. - KeyCombo
-
A key with the modifiers held with it, as Trigger.key names it:
Enter,Meta+Enter,Shift+Tab,Meta+b,ArrowDown,Escape. Every part but the last is a modifier:Meta(alsoCmd,Command,Ctrl,Control,Mod: Command on macOS, Control elsewhere),Shift,Alt(alsoOption). The key compares without case or spaces;Escreads asEscape,ReturnasEnter. - Layout
- A node's layout.
- LayoutDocument
- A layout: a set of node trees (one per canvas/screen) in one flat map.
- LayoutFields
-
A node's Layout, field by field (JSON under
layout). - LayoutLogic
- The variables and conditions of each screen of a layout, by canvas id. JSON (two keys of the layout document):
- LineChartProps
- A line chart of data rows (xField, yField; dates or numbers on x), with bands, ticks, markers and lines given as data (usually bound).
-
ListCodec<
T> - ListReorder
-
Dragging a list's items to a new place, within the list and, with a
group, into other lists of the group (a Kanban board). A drop runs the
list's
reorderreactions with${result.from},${result.to},${result.item},${result.fromList}and${result.toList}. - ListReorderFields
- ListSections
-
Groups a data list's consecutive items with the same groupBy value into
sections, each under the list's
sectionHeaderslot. - ListSectionsFields
- ListTileProps
-
ListTile, its widgets in theleading,title,subtitleandtrailingslots. - ListViewProps
-
Flutter
ListView: its first child repeated per item. - LoadCloudDataAction
-
Streams a cloud document, or a collection query's documents, into
variable variable while the screen shows:
{status: loading|loaded| error, isLoading, data, error, hasMore}. A variable of type list gets the documents themselves, and with an aggregate, a number variable the number. Blocking actions wait for the first value; an initial failure stops the chain. A later subscription failure stops any remaining actions from that invocation and fires the canvas's actionError reaction. Subscriptions close on error or when the screen is disposed. - LoadCloudDataFields
- LoadCloudDataAction.
- LoopAnimation
-
An animation that repeats while the node is shown (a pulsing halo, a
spinning icon). A run takes duration ms, eased by curve, from the
fromvalues to thetoones (and back with reverse). The design canvas draws its first frame. - LoopAnimationFields
- ManagedBuild
- An instance's nodes built from a version, and the variables they need.
- ManagedComponentContract
- What a managed component lets an instance customize, and what it needs: the schema the editor's instance panel is generated from.
- ManagedComponentMaster
-
A managed component (
managed_components/{id}): its versions, what each channel offers per major, staged rollouts and blocked versions. - ManagedComponentRef
- A managed instance's reference (ComponentLink.managed): what it follows and how it customizes the component without forking it.
- ManagedComponentVersion
-
One immutable release of a managed component
(
managed_components/{id}/versions/{n}). - ManagedEvent
- Something a managed component reports, which an instance can run its own action chain after.
- ManagedRollout
- A staged release: version goes to the projects of channel whose rollout bucket (managedRolloutBucket) is below percent.
- ManagedSlot
- A place in a managed component that holds the instance's own nodes.
- ManagedSnapshot
-
What a publish recorded of one managed instance in a layout
(
PublishLayout.extra.managed, by the instance's top node id): the version its nodes (the snapshot) were built from. - ManagedVersionInfo
- What a master knows of one of its versions, without its nodes.
- Measure
-
Writes where the node is laid out,
{x, y, width, height, centerX, centerY}in pixels, to a variable as layout changes: in the coordinates of the ancestor node relativeTo (empty: the screen), under key when the variable is a map. Other nodes then follow it: a marker travelling to the chip of the reader's layer on a timeline whose chips are laid out by data. The design canvas measures too. - MeasureFields
- ModalProps
-
A dialog: its
triggerslot is shown in place and opens thecontentslot in aDialog. - Motion
- How a node moves: a transform drawn over its layout (CSS-like: it doesn't move anything else), the transitions between its values when they change, an entrance, a loop and a spin. Its values are the node's rest pose; the design canvas draws the node there.
- MotionFields
- Motion: the node's rest pose (a transform over its layout) and how it moves to it.
- MotionKeyframe
- The values a Motion passes through at t (0–1) between its start and its values; null values follow the curve.
- MotionKeyframeFields
- MotionKeyframe: values at t; unset values follow the curve.
- MotionShimmer
- A band of light sweeping across what the node paints, over and over (a loading skeleton's shimmer). Blended over the node's own pixels only. The design canvas draws it still, halfway across.
- MotionShimmerFields
- MotionShimmer: a band of light sweeping across the node.
- NamedColorStyle
- A named color style: a paint (a solid color or a gradient), and optionally the dark paint it has in dark mode.
- NamedTextStyle
- A named text style.
-
Goes to another screen. JSON:
{"type": "navigate", "mode": "push", "to": "canvas-b", "params": {"id": "${item.id}"}}. The destination reads params as${route.<name>}. - NavigateAction.
-
What
NavigationBarandBottomNavigationBarshare: items, the selection, and the selected/unselected label and icon styles. -
A navigation bar item: Flutter's
NavigationDestination(andBottomNavigationBarItem). Icon colors are the item's own, over the bar's. actions are its reactions. - Node
- One node: a widget declaration's values, placed in a tree by id.
- NodeFields
- A node's own top-level fields.
- NodeValue
- One property a SetValueAction sets: a binding path of the node (DESIGN.md §5.1) and its value (a string is an expression).
- NullableDoublesCodec
-
A list of numbers with gaps (
nullitems kept, e.g. a bar with no value). - Offset
-
An offset. JSON:
[dx, dy]. - OpenLinkAction
-
Opens a URL (a web page,
mailto:,tel:, an app link). - OpenLinkFields
- OpenLinkAction.
- OpenModalAction
-
Shows a screen (canvas) as a modal: a dialog, a sheet, a popover. The
CloseModalAction that closes it gives the chain that opened it its
${result}. JSON:{"type": "openModal", "to": "canvas-d", "presentation": "bottomSheet"}. - OpenModalFields
- OpenModalAction.
- OpenTypeFeature
-
An OpenType feature setting: a four-character tag and its value
(1 on, 0 off, n an alternate). JSON is a string,
"lnum"or"liga=0". - OptionalBoolCodec
- A bool that may be absent (null: the widget's own default).
- OptionalDoubleCodec
-
A double that may be absent (
itemExtent,mainAxisExtent). -
OptionalEnumCodec<
T extends Enum> - An enum value that may be absent (Flutter's nullable enum parameters).
- OptionalIntCodec
-
An int that may be absent (
maxLines). - OptionalStringCodec
- A string that may be absent (a font family that falls back).
- OrderBy
- One sort of a query.
- PageIdentity
- One page's (or screen's) title and description override, keyed in AppIdentity.pages by an editor page id, or a canvas or layout id.
- PageViewProps
-
Flutter
PageView: its first child repeated per page. - PaginateAction
-
Moves the pagination controller of a list or grid (its
pagination, by controller, the pagination's name). - PaginateFields
- PaginateAction.
- Pagination
-
A pagination controller: loads a list's items page by page and exposes
its state as a map variable named name (
${name.items},${name.page},${name.pageCount},${name.hasMore},${name.isLoadingMore},${name.error}...). Paginate actions move it. - PaginationFields
- PaginationProps
-
Page controls for a list's pagination (found by its name,
controller): first, previous, page numbers with ellipses
(1 … 4 5 6 … 16), next, last, a page size select and a summary. Choosing
a page fires the node's
changedreactions with the page as${result}. - Paint
- A fill or stroke paint: a solid color, a gradient or an image. Several paints stack, first at the bottom.
- PaintFields
- ParticleEmitter
- Confetti, stars or emoji the node bursts with on cue.
- ParticleEmitterFields
- PathProps
-
An SVG path, filled and stroked with the node's decoration
(Flutter
CustomPaint). - PaywallAction
- A paywall interaction: buy the selected (or slot's) product, restore purchases, select a product, close the paywall, open a legal url, or open a server-resolved placement.
- PaywallConfig
- A project's paywall setup: its product slots, placements and legal links.
- PaywallFields
- PaywallAction.
- PaywallPlacement
-
A named entry point (
onboarding,settings) the app opens a paywall at: the layout it shows and the product slots in it. - PickerFieldProps
-
The look of a date or time picker: by default an
OutlinedButtonshowing the value; with a PickerFieldProps.decoration a read-only text field (InputDecorator: border, fill, prefix and suffix icons, error text) showing it in PickerFieldProps.format. Tapping opens Flutter's picker, themed by PickerFieldProps.pickerTheme. - PlaceholderProps
-
An empty slot shown at design time (Flutter
SizedBox). - PlayAnimationAction
- Plays node node's one-shot animation (or particles) named animation.
- PlayAnimationFields
- PlayAnimationAction.
- PlaySoundAction
- Plays a synthesised sound (a voice name), now or at a time on the sound clock, or the sound file at url. Every field is an expression.
- PlaySoundFields
- PlaySoundAction.
- PlotChartLabel
- A label on a plot chart's x axis, centered on x.
- PlotChartMarker
- A labeled dot on a plot chart (on the curve when y is null).
- PlotChartProps
- A line/area chart of points spread evenly over an x domain, with an x value selected by tapping or dragging.
- PlotChartRange
- A shaded x range of a plot chart, painted behind the curve.
- PlotChartSeries
- One more curve on a plot chart, over the chart's x domain: points are evenly spaced from xMin to xMax like the chart's own, and a null point is a gap (the line breaks there: an undefined value or an asymptote).
- PlotChartYLine
- A horizontal line across a plot chart at y: a grid line, or a reference such as a target (dashed, with an inline label). axisLabel is written in the chart's y-axis gutter (PlotChartProps.yAxisWidth).
- Predicate
- What a branch tests.
- PreloadImagesAction
-
Loads images ahead of showing them (a story's pages before reading), so
they draw at once: urls is an expression giving a list of URLs (or a
comma-separated text). While it runs, progressVariable (a variable's
name; empty for none) holds the share done (0–1). It waits for every image
and gives
{loaded, failed, total}. - PreloadImagesFields
- PreloadImagesAction.
- PrintAction
- Requests the platform print dialog for a rendered node. The user chooses the destination and confirms; this action never silently submits a job.
- PrintFields
- PrintAction.
- ProductSlot
-
A product slot: a stable id (
monthly,annual) bindings use, mapped to each store's product id. - ProductTestData
- A product slot's made-up store data for the SDK's test store: what a paywall shows and does on the web (preview and demo sites), where there is no store. Never charges and never grants a real entitlement: the test store's grants stay on the device and the paywall server rejects test receipts.
- ProgressBand
- A colored zone of an arc progress bar, from start to end as fractions of the max value.
- ProgressBarProps
- A progress bar filled to value of max: a bar (horizontal, or vertical filling upward) or an arc with ticks, bands and a needle.
-
PropCodec<
T> - Reads and writes one prop's JSON. Decoding returns null for values it can't read (the prop then has its default).
-
PropDef<
T> - One prop of a widget.
- PropertySet
-
Sets property path (a binding path, DESIGN.md §5.1) of node node to
value: a JSON value, where a string is an expression read like a
binding's (
${= qty * 2},#FF0000,Hello ${name}). - PropRecord
- A small immutable model whose fields are declared as PropDefs in schema (as a widget's props are): only non-default fields are held and encoded; unknown keys round-trip.
- Props
- A widget's prop values: only the ones that differ from Flutter's defaults are held. Keys a declaration doesn't know round-trip untouched.
- PropType
- What a prop holds (see PropKind). Pure data, read from a codec (PropCodec.type); a prop is nullable when its default is null (PropDef.nullable).
- PropTypes
- The Flutter value types' PropTypes.
- PublishBundle
- A publish model with its layouts in one piece: what a slug serves, an app bundles as an asset to run offline.
- PublishCanvas
- A canvas (screen) of a published layout, as the model lists it: enough to route to it before its layout is loaded.
- PublishFont
- A font a published layout uses. Fonts of one family register together, so text picks a file by its weight and style.
- PublishLayout
- PublishLayoutInfo
- What the publish model knows of one layout without loading it.
- PublishModel
- A published project: its layouts (by id, loaded on their own), entry screen, fonts, theme and APIs.
- RadialGaugeProps
- A radial dial: zones, ticks, labels, a value arc (continuous or in segments), a target notch and a needle.
- RadioProps
-
Flutter
Radio<String>, scaled to its box (32 px is its own size; its ring, 18 px, when compact). - Reaction
- A trigger and the actions it runs, in order: one chain. A blocking action is awaited before the next; a failing one stops the chain. JSON:
- ReloadCloudDataAction
-
Runs again the live load of variable (a LoadCloudDataAction that ran
on this screen): it subscribes afresh, with the values its query reads
now, and waits for the first value. Nothing when the variable has no
load. A list's pull to refresh (its
refreshreaction) runs it. - ReloadCloudDataFields
- ReloadCloudDataAction.
- RetryFailedAction
-
Runs again the action chain whose failure the screen's
actionErrorreaction is handling (a toast's Retry after an offline save or a failed load): the same node's reactions to the same trigger, with the same event and list item. Nothing happens outside anactionErrorreaction or when that failure can't be retried (${error.retryable}is false). - Reveal
-
Scrolls the node into view when it appears (or when its
reveal.whenbinding turns true), to alignment of the viewport (0 top, 1 bottom). With follow it stays there while the content around it moves (lines added above an end marker, an image that loads late), until the user scrolls away: a chat or transcript pinned to its newest line. - RevealFields
- RouteDismiss
- A drag anywhere on a screen that closes it interactively: the drag runs the transition backwards, and on release the pop completes or cancels with spring.
- RouteDismissFields
- RouteTransition
- A composable route transition. enter is where the incoming screen starts, exit where the covered one ends; closing plays them in reverse unless popEnter (where the screen revealed by the pop starts) or popExit (where the closing screen goes) are given. A preset fills in what's left null. JSON: an object, or a bare preset name.
- RouteTransitionFields
- RunScriptAction
-
Runs script script (a layout's
scripts, by id) with arguments (by parameter name; expressions: one${...}passes its value as is, other text passes as JSON when it is JSON, else as text). Its result is the chain's${result}(and goes in resultVariable when set). When it fails, onError runs with${result}{error: {type, message, line, column}, logs}; without onError a failure stops the chain. - RunScriptFields
- RunScriptAction.
- SchemaField
- A typed field of a collection.
- ScreenRoute
-
One published layout: a LayoutDocument whose roots are its canvases
(one per screen size, picked by
breakpoints), and what the runtime needs to run it. - ScriptDef
-
A script. Its params are variables in its source; what it returns at
its top level (or what its
mainreturns) is its result. It runs in a sandbox with no network, files or timers, reaching the app only through what its capabilities grant, and stops past timeoutMs of computing or memoryLimitMb. A page script (pageId set) wins over a project script of the same name. JSON (sparse): - ScriptFields
-
ScriptDef (a layout's
scripts). - ScriptParam
- A parameter of a ScriptDef: a JavaScript identifier, and the value a caller that passes none gets (defaultValue, JSON).
- ScriptTest
-
A sample run of a ScriptDef and what it should give (the editor's test
console): args by parameter, sample vars and input nodes values,
and the result expected, or the error expectError (its type, its
message, or
Type: message). - ScrollProps
-
Scrolling, for any container that can scroll its content
(
SingleChildScrollView). - ScrollToAction
- Scrolls node node into view: alignment 0 puts it at the start of the view, 1 at the end; offset moves it further. axis limits it to the scroll views along one axis (a map in a sideways window centers a point without scrolling the page under it); null scrolls every one around it.
- ScrollToFields
- ScrollToAction.
- SegmentedButtonProps
-
Flutter
SegmentedButton<String>. - Semver
-
A semantic version,
major.minor.patch(missing parts are 0; anything after a-or+is ignored). - ServiceConfig
-
The services part of a publish model (its
serviceskey): - SetStorageAction
-
Changes the app's values on the device (read as
${storage.<key>}). A key may be a path (prefs.theme) into a stored map or list. - SetStorageFields
- SetStorageAction.
- SettingTarget
-
Where a ComponentSetting writes: a node and a binding path into it
(DESIGN.md §5.1), as a condition's
setentries. A field path in the olderproperties.*form that has no binding path is kept as v1 (the stored key's name). - SetValueAction
- Sets properties of node node at runtime (until the screen goes). A property bound to a variable sets the variable instead.
- SetValueFields
- SetValueAction.
- SetVariableAction
-
Changes variable variable (of the screen, or the app): write. JSON:
{"type": "setVariable", "variable": "count", "op": "add", "value": "1"}. A computed variable can't be set. A number can glide to its new value (animateMs, curve): the variable changes every frame (what's bound to it moves with it), and the chain goes on when it arrives. - SetVariableFields
- SetVariableAction.
- SetVariantAction
- Shows variant variant of variance node node.
- SetVariantFields
- SetVariantAction.
- ShapeBorder
-
One of Flutter's
OutlinedBorders: its kind, corner radius and side. JSON:{"type": "stadium", "borderRadius": 8, "side": {...}}. - ShapeBorderFields
- ShowToastAction
- Shows a short message (a snackbar). Its button (actionLabel) runs actions on the chain that showed it. Cosmetics beyond the fields below (colors, radius, shadows, text styles, offsets per breakpoint) are in style, JSON.
- ShowToastFields
- ShowToastAction.
- SignatureProps
- A signature pad: strokes drawn with a finger or mouse, on a bordered card with a placeholder and a sign line.
- SinglePlaceholderProps
- A slot that shows its one child, or keeps its size when empty.
- SliderProps
-
Flutter
Sliderwith itsSliderThemeData, at its box's design size. - SpacerProps
-
Flexible empty space in a row/column (
Spacer), or a fixed gap. - SpeakAction
- Reads text aloud, or stops speaking. rate and pitch are numbers or expressions.
- SpeakFields
- SpeakAction.
- StackProps
-
A freeform container: children placed by
layout.x/layout.y(FlutterStackwithPositioned/Alignchildren). - StateStyles
-
What a node and its descendants change to in each WidgetState: per
state, node id → a patch of that node's JSON (a merge patch: maps
merge,
nullremoves, anything else replaces; see mergePatch). Later states in WidgetState's order win where active states overlap. - StateStylesFields
- StateStyles: one field per WidgetState. Each holds that state's patches (node id → a merge patch of the node's JSON), which are free-form JSON (nodePatchesType): a patch can override any key of any node.
- Sticky
-
Pins the node inside the scrolling row or column it scrolls in, as CSS
position: sticky: once its leading edge reaches offset from the view's leading edge it stays there, drawn above the content scrolling under it, until the end of its parent (the section it heads) pushes it on.${sticky.stuck}says whether it is pinned now (the node's own bindings and the nodes inside it read it). The design canvas, which doesn't scroll, draws it in place. JSONtrueor{"offset": 8}. - StickyFields
- StringCodec
- StrokePath
- A line drawn through points in the node's box (a dotted trail, a connector), behind its content or inFront of it. x and y are fractions of the box or pixels, per xUnit/yUnit.
- StrokePathFields
- StyleSheet
-
A project's style sheet (
style_sheets/{projectId},schema: 2). - SubmitFormAction
-
Validates a form's answers and stores them in the app's own variables
(
service: local). Seedocs/submit_form.md. - SubmitFormFields
- SubmitFormAction.
- SwipeAction
- One action revealed behind a list item as it is swiped.
- SwipeActionFields
- SwipeActions
-
Swipe actions on a list's items (
Dismissible): toward the start reveals endActions, toward the end startActions; past threshold the first of the side runs. Running one fires the list'sswipeActionreactions with${result.action},${result.item},${result.index}. - SwipeActionsFields
- SwitchProps
-
Flutter
Switch, scaled to its box (59 px wide is Flutter's own size). - TabBarProps
-
Flutter
TabBar(labels only; no pages). - TableColumn
-
One column of a table view: the row field its cells show (key, read
as
${item.value}), its header text (label,${item.label}) and its width (null: the table'scolumnWidth). - TableColumnFields
- TableViewProps
-
Flutter's
TableView(two_dimensional_scrollables): a table that scrolls on both axes, with a header row and column that stay pinned. Rows are the bounddata(or rowCount); columns are columns (or boundprops.columns). Its slots are templates built per cell with${item}:cell({value, row, column, rowIndex, columnIndex}),columnHeader({label, column, columnIndex}),rowHeader({row, rowIndex}) andcorner. - TabsProps
-
A
TabBarover the selected child: one tab per child, titled by titles. - TextFieldProps
-
Flutter
TextField(aTextFormFieldwhen it validates). - TextProps
-
Text.rich: a string with styled runs. - TextRun
-
A styled range of a text's characters,
[start, end). - TextRunFields
- TextStyle
-
Flutter's
TextStyle. Every field is optional: a span's style is merged over its text's base style, as inText.rich. - TextStyleFields
- ThemeTokens
-
A project's theme as published: what the runtime draws itself (dialogs,
toasts, the loading and error screens), what layouts read at run time
(
${theme.primary},${theme.colors.brand},${theme.text.title.fontSize},${theme.isDark}) and what an app can read to match its own widgets to a layout. Every token is optional. - Tilt
-
Tilts the node in 3D toward the pointer while it hovers or drags over
it. max holds the Motion values reached with the pointer at an
edge: the edge under it tips away (rotateX at the top and bottom,
rotateY at the sides, with its perspective); scale and translate are
reached while the pointer is over the node at all. Inside it
${tilt.x},${tilt.y}(-1–1) can be read, for parallax. - TiltFields
- TimePickerProps
-
An
OutlinedButton(or, with a decoration, a read-only field) showing a time (HH:mm) that opensshowTimePicker. - TransformGesture
-
Makes the node pannable, zoomable and rotatable by touch, mouse and
trackpad (Flutter's
InteractiveViewer, and more): pinch and ctrl+wheel zoom about the focal point, one finger pans, two rotate, a double tap zooms to a point; a release flings and settles by physics within bounds and minScale–maxScale. The pose binds two-way to variables (xVariable...); inside it reads as${transform.x},${transform.scale}... Each change runs the node'schangedreactions, the end of a gesture itschangeEndones. - TransformGestureFields
- TransformHandles
- On-canvas handles that make a node an editable object (a sticker, a collage): corners scale it, edges stretch it, a knob rotates it.
- TransformHandlesFields
- Transition
-
An implicit animation's duration (ms) and curve, as Flutter's
AnimatedOpacity(duration:, curve:). - TransitionFields
- TransitionReveal
- A clip that reveals a screen as a transition plays: a circle or rectangle growing from origin until it covers the screen.
- TransitionRevealFields
- Transitions
- How changes to a node animate at runtime. The design canvas shows the new values at once.
- TransitionsFields
- TransitionSide
-
How one screen moves during a RouteTransition: an entering screen
starts at motion and comes to rest; a leaving one starts at rest and
ends at motion. Only the motion's values are used (the 3D ones,
shiftX/shiftYin screen sizes, opacity, blur); this side's curve, delayMs and durationMs time it inside the route's duration. - TransitionSideFields
- TransitionSpring
-
The spring a released interactive transition settles with (Flutter's
SpringDescription). - TransitionSpringFields
- Trigger
-
A trigger and its settings. JSON (sparse):
{"type": "click"},{"type": "changed", "debounceMs": 300},{"type": "timer", "intervalMs": 500},{"type": "keyDown", "key": "Meta+Enter"}. - TriggerFields
-
A reaction's trigger (
Trigger, its JSON keys). - Typewriter
- Text that types itself out in a running app, like a typewriter or a terminal: charsPerSecond characters a second after delayMs, with a blinking block caret after the last one while it types. It types when the text first shows and again from the start when playKey changes; when the text grows by appending (a streamed reply) only the new characters type, and when it changes otherwise it types afresh. skip (bindable, e.g. to a tap that sets a variable) shows the rest at once; off enabled it shows all of it. The layout never changes as it types: the whole text is laid out and only what's typed is painted. The design canvas shows it all.
- TypewriterFields
- UnknownAction
- An action of a type this version doesn't know: its JSON, kept. Running it does nothing.
-
ValueCodec<
T> -
A value type with its own
fromJson/toJson. - ValueWrite
-
How a value is changed: op with value (an expression), at index
in a list or mapKey in a map (expressions too). Stored flat in its
action's JSON:
"op": "insert", "value": "${item}", "index": "0". - ValueWriteFields
- The ValueWrite keys, stored flat in SetVariableAction, SetStorageAction and CloudDocumentsAction JSON.
- Variable
- A variable: a name, a type and a default value, or a formula that computes it from other variables. JSON (sparse):
- VariableOption
- One option of a VariableType.choice variable.
- VarianceProps
- Shows one of several variants of its content (by id, or by breakpoint).
- VideoProps
-
A network video (
video_player'sVideoPlayer). - ViewProgress
-
How far the node has scrolled through the viewport of the scrolling row
or column (or list) it is in, as
${view.progress}(0–1) and${view.visible}for its own bindings and the nodes inside it: a figure that draws itself as it scrolls up the screen (a path'strimEnd), a heading that fades in, a gauge reading how far through a section the reader is. Positions are fractions of the viewport's extent from its leading edge (0 top, 1 bottom), plus offset pixels. With variable, the progress is also written to that screen (or app) variable, under key when it's a map, for nodes elsewhere to read. The design canvas reads progress 0 above the fold and 1 for a node it shows whole. - ViewProgressFields
- VisualDensity
-
Flutter's
VisualDensity. - VisualDensityFields
- WebViewProps
-
A web page (
webview_flutter'sWebViewWidget). - WhereFilter
-
One filter of a query. value is text that may hold
${...}expressions; the SDK evaluates it when the query runs. - Widgets
- Every widget declaration, by node type.
- WidgetSpec
- The declaration of one widget type.
Enums
- AnimateVariableMode
- What an AnimateVariableAction does.
- AnimationCurve
-
An easing curve, by the name of its Flutter
Curvesconstant.springis a damped spring (see Motion.springStiffness);stepjumps half way. - ArcFit
- How an arc progress bar sits in its box: the arc fitted to the box, or its whole circle (so arcs of any length line up into one ring).
- AuthOperation
- What an AuthAction does.
- AutomationTrigger
- What starts an Automation.
- AutovalidateMode
-
Flutter's
AutovalidateMode. - Axis
- BarcodeErrorCorrection
- How much of a QR code can be damaged and still be read.
- BarcodeSymbology
- The encoding of a barcode.
- BlendMode
- BorderStyle
-
Flutter's
BorderStyle. - BoxFit
- BoxHeightStyle
-
Flutter's
BoxHeightStyle(selection boxes). - BoxWidthStyle
-
Flutter's
BoxWidthStyle(selection boxes). - CaptureTarget
- What a CaptureScreenshotAction captures.
- ChartGridLineMode
- How a series chart places its grid lines (and solid reference lines). centered: centred on the value's rounded y (the bottom line one pixel row up, inside the plot); a 1 px line there straddles two pixel rows. crisp (the default): whole pixel rows from the value's rounded y down (the bottom line's up, inside the plot), so a line of whole width is sharp; other widths stay centred on the value. exact: the rows just above the value's unrounded y, like a Flutter box of that height whose bottom edge sits at the value (sharp when that is a whole pixel, soft otherwise).
- ChartSeriesKind
- How a chart series draws its values.
- ChartType
- What a series chart draws.
- ChartYLabelAlign
- Where a series chart's y labels sit in the gutter left of the plot: end right-aligned 8 px left of the plot, start left-aligned at the chart's left edge.
- ChildModel
- How a widget takes children.
- ChipVariant
- How a chip is drawn.
- Clip
- CloudDataOperation
- What a CloudDataAction does.
- CloudDataScope
- Who keeps a LoadCloudDataAction's live subscription.
- CloudDocumentsOperation
- What a CloudDocumentsAction writes.
- CloudFieldOperation
- How a CloudFieldWrite changes its field.
- CloudFileAccess
- Who can read an uploaded file.
- CloudFileKind
- What files an upload picks.
- CloudFilesOperation
- What a CloudFilesAction does.
- CloudLoadAggregate
- What a LoadCloudDataAction keeps in its variable instead of the documents: a number computed by the database over the query.
- ComponentRole
- What a node is to its component.
- ConditionOp
- How a Comparison compares its operands. Loose: numbers as numbers, booleans as booleans, anything else as case-insensitive text.
- CrossAxisAlignment
- DataRule
- Who can read and write a collection.
- DateTimeInputMode
- What a date/time input picks.
- DateTimeInputPicker
- What tapping a date/time input opens: Material's date and time dialogs, or nothing (its own click reactions show a picker the design builds, and set its value).
- DragAxis
- DragCommand
-
What a ControlDragAction does to a draggable node. step turns a
drag track control by ControlDragAction.steps of its step, as if
dragged there (a dial's nudge buttons and arrow keys). On a node with a
transform gesture (a map, a photo): reset springs it to its rest pose,
zoom scales it by ControlDragAction.value (a factor:
1.5in,0.67out) about the middle of what its viewport shows (zoom buttons), and pose springs it to the pose ControlDragAction.value gives ({x, y, scale, rotation}, keys left out kept: "fit to route"). - DragDirection
- DragRelease
- What a dragged node does when let go.
- DragSourceStyle
- What the node shows where it was picked up while dragged.
- DragStart
- How a node starts a drag: on press, on long press, or long press on touch and press with a mouse.
- DragTrackHitArea
- Where a DragTrack's node takes the pointer: on itself, or anywhere in its parent (a knob turned from anywhere in its box).
- DragTrackInput
- How the pointer moves along a DragTrack: following it, or dragging up/down, left/right, or either (up or right raises it: dx − dy).
- DragTrackShape
- The shape of a DragTrack.
- DragTrackUnits
- What a DragTrack's geometry is measured in: pixels, or fractions of the parent's size (x values of its width, y of its height).
- DropSlot
- Where a DropTarget inserts what's dropped on a list.
- DropSlotSize
- How big the slot a DropTarget opens in its list is: the dragged node's size, the slot node's own (room for an insertion line), or none: inGap draws the slot node in the gap between the items it would land between, moving nothing (a board's column insertion bar).
- EditTextOperation
- What an EditTextAction does to its text field.
- EffectAnimationType
-
A one-shot effect's shape.
keyframesplays the effect's own EffectAnimation.keyframes (a hop with squash and stretch, a fly-away and back) from rest and back to rest. - EffectType
- EmbeddedVideoSource
- Where an embedded video is hosted.
- FeedbackAnchor
- Which point of the copy that follows the pointer sits under it: where it was grabbed, or its center (a feedback node of another size).
- FlipAxis
- The axis a FlipCard turns around.
- FloatingActionButtonLocation
-
Flutter's
FloatingActionButtonLocations, by name. - FloatingActionButtonType
-
Which
FloatingActionButtonconstructor:FloatingActionButton(),.small,.largeor.extended. - FloatingLabelBehavior
-
Flutter's
FloatingLabelBehavior. - FontStyle
- FormService
- Where a form goes.
- GaugeLimitStyle
- How a gauge meter's limit line is drawn.
- GaugeShape
- The shape of a gauge meter.
- GestureBounds
- What a gesture keeps a node inside of.
- HapticKind
-
How strong a HapticAction buzz is (Flutter's
HapticFeedback). - HeroFlightShuttle
- How a shared element flies between screens.
- HeroPlaceholder
- What a shared element's destination shows while its own drawing isn't ready (a network image still loading).
- HttpBodyType
- How an API's body is sent.
- HttpContentType
- The content type of a text body.
- HttpMethod
- An HTTP request method.
- IconAlignment
-
Where a button's icon sits: Flutter's
IconAlignment. - ImageRepeat
- InputBorderType
-
Which of Flutter's
InputBorders. - Join
- KeyboardDismissBehavior
-
When a view's keyboard is dismissed (
ScrollViewKeyboardDismissBehavior). - LineChartXLabelAnchor
- Where a line chart's x labels sit about their tick. edgeClamped: centred, the first starting at the tick and the last ending there (so both stay over the plot). start: starting at the tick. center: centred on it. end: ending at it.
- ListApply
- What a reorder (or a swipe action that removes the item) changes on its own, before the list's reactions run.
- ListLayout
- How a list arranges its items.
- ListSeparator
- What a list draws between its items.
- ListTileControlAffinity
-
Which side of a tile its control sits on (
ListTileControlAffinity). - ListTileTitleAlignment
- LoopAnimationType
- What a LoopAnimation changes.
- MainAxisAlignment
- MainAxisSize
- ManagedChannel
- A release channel of managed components.
- MasonryPlacement
- Which lane a masonry grid puts each item in.
- ModalAnchor
-
What a popover is anchored to: nothing, the node that opened it, the
pointer, or a named node (OpenModalAction.anchorNode; in a list, the
copy built for OpenModalAction.anchorItem), so a modal opened from a
keyboard shortcut or a screen's
loadcan sit by a node too. - ModalPresentation
- How a modal shows.
- MotionLoop
- How a Motion repeats.
- MotionPathPacing
- How Motion.pathProgress maps to a point on Motion.path.
-
Flutter's
NavigationDestinationLabelBehavior(plus showing only the unselected labels, whichBottomNavigationBarcan). - How a NavigateAction moves.
- NodeValueMode
- How a NodeValue sets its property.
- PagePaintOrder
- Which pages of a page view draw on top where they overlap.
- PageTransition
- A page transition.
- PaginateCommand
- What a PaginateAction does to a pagination controller.
- PaginationMode
- How a list shows the pages.
- PaginationSource
- Where a pagination reads its items from.
- PaginationStrategy
- How a page is asked for.
- PaintType
- ParticleShape
-
A particle's shape;
imagedraws the emitter's ParticleEmitter.image. - PathCurve
- How a StrokePath joins its points.
- PathUnit
- The unit of a StrokePath coordinate.
- PaywallOperation
- Opens a placement, or acts inside a paywall screen.
- PlotChartGridAnchor
- Where a plot chart's grid lines start: at xMin (every step from the left edge, as a category axis), or at multiples of the step (0, ±step, …: a Cartesian graph whose grid stays put as the domain pans).
- PlotChartMarkerPosition
- Where a plot chart marker's label sits relative to its dot.
- PlotChartMarkerShape
- How a plot chart marker is drawn: a filled dot (the default), a hollow ring, a square or a diamond.
- PlotChartSelectionGuides
- How the selection is marked: a full-height line, dashed guides from the point to both axes, or only the dot.
- PopoverPlacement
- Where a popover sits relative to its anchor.
- ProgressBarShape
- A straight progress bar, or an arc like a dial.
- PropKind
-
The shape of a prop's value, for tools: PropType.name is the Flutter
type (
double,Color,EdgeInsets,MainAxisAlignment,List<Paint>,ButtonStyle), so a properties panel picks the control a Flutter developer expects, docs print it and codegen emits it. - PublishSource
-
Where published data comes from. A project's
publish model is
publish/{projectId}(a Firestore document) and each layoutpublish/{projectId}/layouts/{layoutId}, in the current format withschema: 2; the preview's and the templates' the same underpublish_previewandtemplates. A slug's bundle is the storage filepublish/{slug}.json. - QueryPaging
- How a list loads the pages after its first.
- ReorderPlaceholder
- What shows where a dragged item would land.
- ReorderStart
- How a drag of a list item to a new place starts.
- RevealOrigin
- Where a TransitionReveal grows from.
- RevealShape
- The shape a TransitionReveal clips a screen to.
- RouteSwipeBack
- When a route can be swiped back from its left edge (iOS style).
- RouteTransitionPreset
- A ready-made RouteTransition; sides given next to it override its own.
- ScaleMode
- How a screen fits the device.
- SchemaFieldType
- The type of a collection field.
- ScriptCapability
- What a script may do besides computing; anything else it calls fails. JSON: the capability's id.
- ScrollAxis
- The scroll views a ScrollToAction moves.
- ScrollPhysicsType
- SegmentedVariant
- How a segmented button is drawn.
- ShapeBorderType
-
Which of Flutter's
OutlinedBorders a ShapeBorder is. - ShowValueIndicator
-
Flutter's
ShowValueIndicator. - SignaturePlaceholderPosition
- Where a signature pad's placeholder sits.
- SignLineStyle
- How a signature pad's sign line is stroked.
- SignMarkPlacement
- Where a signature pad's mark sits: over the line's start, or before the line (centred on it, the line starting after it).
- SizeFit
- How a node sizes along one axis.
- SliderThumbShape
-
The slider's thumb (
SliderThemeData.thumbShape). - SliderTickMarkStyle
- The tick marks of a discrete slider.
- SliderTrackShape
-
The slider's track (
SliderThemeData.trackShape). - SliderValueIndicatorShape
-
The value indicator (
SliderThemeData.valueIndicatorShape). - SnapKind
- Where a GestureSnap settles a released node.
- StorageOperation
- What a SetStorageAction does.
- StrokeAlign
-
Where a stroke sits relative to the box edge (Flutter's
BorderSide.strokeAlign: inside -1, center 0, outside 1). - StrokeCap
- StrokeJoin
- StrokeSides
-
Which sides a box's stroke runs along: every side (rounded with the
corners), one side, a pair of opposite sides (a ruled band), two sides
meeting at a corner (
topRight: the top and right sides, as a table's header corner), or every side but one (noTop), as Flutter'sBordertakes any of its sides. - TabAlignment
-
Flutter's
TabAlignment. - TabBarIndicatorSize
-
Flutter's
TabBarIndicatorSize. - TabContent
- What a tab shows.
- TabIndicatorStyle
- How the selected tab is marked.
- TestPurchaseOutcome
- How a test purchase of a slot ends in the SDK's test store.
- TextAlign
- TextAlignVertical
-
Vertical placement of text inside its box (Flutter's
TextAlignVertical). - TextCapitalization
-
Flutter's
TextCapitalization. - TextDecoration
- TextDecorationStyle
- TextDirection
- TextInputAction
-
Flutter's
TextInputAction. - TextInputType
-
Flutter's
TextInputType. - TextLeadingDistribution
- How a line's extra height is shared above and below its glyphs.
- TextOverflow
- TileMode
- ToastPosition
- Where a toast shows.
- ToastStyle
- A toast's look.
- TransformPan
- When one finger (or a mouse) pans a TransformGesture.
- TransformTarget
- What a TransformGesture moves.
- TriggerType
- What starts a reaction.
- VariableType
- What a variable holds.
- VerticalDirection
- ViewProgressMode
- How a ViewProgress measures its node against the viewport.
- WebViewGesture
-
Gestures a web view takes from the page around it
(
WebViewWidget.gestureRecognizers). - WebViewSourceType
- What a web view's WebViewProps.source is.
- WheelZoom
- What the mouse wheel does over a TransformGesture.
- WhereOperator
- A where filter's comparison, Firestore's operators.
- WidgetState
-
The interaction states of Flutter's
WidgetStatea node can style. - WrapAlignment
-
How the items of a run are placed along it (Flutter's
WrapAlignment). - WrapCrossAlignment
-
How the items of a run are placed across it (
WrapCrossAlignment). - WriteOp
- How a write changes a value.
Extensions
-
CanvasBreakpointsForWidth
on Iterable<
CanvasBreakpoint> - LayoutDocumentBreakpoints on LayoutDocument
- A page document's copy of its project's breakpoints, until the editor keeps per-project data (as it keeps project scripts in the document).
- LayoutDocumentLogic on LayoutDocument
- LayoutDocumentScripts on LayoutDocument
-
The scripts of a layout document (its
scriptskey, in LayoutDocument.extra): project scripts and its page's. - Let on T
- PublishLayoutManaged on PublishLayout
-
A layout's managed instances as published (PublishLayout.extra's
managed). - PublishModelAutomations on PublishModel
-
A publish model's automations (its
automations, kept in PublishModel.extra so that a model without them is unchanged). - VarianceBreakpoints on Node
- A variance node's responsive layout (DESIGN.md §5.3).
Constants
- axisPositionType → const PropType
-
AxisPosition: where a child of a freeform parent sits on one axis (Positioned/Align). - axisSizeType → const PropType
-
AxisSize: a design size and how it fits (SizedBox/Expanded/Flexible/ intrinsic). JSON: a number or{"fill"|"flexible"|"hug": v}. -
collectionsSpecs
→ const List<
WidgetSpec> - dragMotionType → const PropType
- dragSourceType → const PropType
- dragTrackType → const PropType
- dropTargetType → const PropType
- effectAnimationType → const PropType
- everyItem → const String
- The wildcard key: every item of a list.
- flightType → const PropType
- flipCardType → const PropType
- flipSpringType → const PropType
- gesturePhysicsType → const PropType
- gestureSnapType → const PropType
- heroTagType → const PropType
-
indicatorsSpecs
→ const List<
WidgetSpec> - inkWellStyleType → const PropType
-
inputsSpecs
→ const List<
WidgetSpec> - jsonEquality → const DeepCollectionEquality
- Deep equality for JSON-like values (maps, lists, scalars).
- kAutomationsKey → const String
- The publish model's key holding its automations.
- kComponentEventAction → const String
-
The action type a master's chains name an event by:
{"type": "componentEvent", "event": "onSuccess"}. Building an instance splices the instance's chain for that event in its place; an unbuilt one is an unknown action, which runtimes skip. - kDefaultCloudLoadLimit → const int
- The most documents a LoadCloudDataAction query loads when neither the action nor its query gives a limit.
- kDefaultHoldMs → const int
- How long a TriggerType.hold is held by default, in milliseconds.
- kDefaultTitleTemplate → const String
-
${page.title} · ${app.name}: the default title template. - kDefaultVisibleFraction → const double
- How much of a node must be visible, by default, for TriggerType.enterViewport.
- kErrorWithoutMessage → const String
-
The InputDecorationFields.errorText of a field in error that shows no
message (its error text bound to
true): the error border only. - kManagedComponentsCollection → const String
-
The collection of managed component masters; versions are its
versionssubcollection. - kMaxCloudBatchWrites → const int
- The most writes one atomic cloud commit takes (Firestore's limit).
- kPublishSchemaVersion → const int
- The schema version of the publish model and bundle this package reads and writes. Layouts carry the document schema (kSchemaVersion).
- kSchemaVersion → const int
- The schema version this package reads and writes.
- loopAnimationType → const PropType
-
materialSpecs
→ const List<
WidgetSpec> - measureType → const PropType
-
mediaSpecs
→ const List<
WidgetSpec> - motionKeyframeType → const PropType
- motionShimmerType → const PropType
- motionType → const PropType
- nodePatchesType → const PropType
- One interaction state's patches: node id → a merge patch of that node's JSON (see StateStyles). Free-form: a patch can touch any node key.
- particleEmitterType → const PropType
-
publishSchemaMigrations
→ const Map<
int, SchemaMigration> - Upgrades of a publish model's (or bundle's) JSON for schemas after 2, by the version they produce.
- revealType → const PropType
- routeDismissType → const PropType
-
routeTransitionCodec
→ const ValueCodec<
RouteTransition?> - RouteTransition; a bare preset name reads as that preset.
- routeTransitionType → const PropType
-
schemaMigrations
→ const Map<
int, SchemaMigration> - Upgrades for schemas after 2, by the version they produce.
- scriptType → const PropType
- stateStylesType → const PropType
- stickyType → const PropType
- strokePathType → const PropType
-
tableColumnCodec
→ const ValueCodec<
TableColumn> - tiltType → const PropType
- transformGestureType → const PropType
- transformHandlesType → const PropType
- transitionRevealType → const PropType
- transitionSideType → const PropType
- transitionSpringType → const PropType
- transitionsType → const PropType
- transitionType → const PropType
- typewriterType → const PropType
- viewProgressType → const PropType
Functions
-
actionsEqual(
List< ActionDef> a, List<ActionDef> b) → bool -
Whether
aandbhold equal actions in the same order. -
allowedChildFits(
Node? parent, {required bool horizontal}) → List< SizeFit> -
The fits allowed under
parentalong an axis. -
borderSideFields(
) → List< PropDef< Object?> > -
breakpointKey(
String label) → String -
labelas a formula key: lower camel case of its letters and digits ("Large desktop" →largeDesktop, "XL" →xl). Empty for none. -
buildManagedInstance(
{required ManagedComponentVersion version, required String topId, ManagedComponentRef ref = const ManagedComponentRef(), Layout? layout, ThemeTokens? theme}) → ManagedBuild -
Instance
topId's nodes built fromversionwithrefapplied: -
cellChildFits(
Node parent, SizeFit fit, bool horizontal) → String? - A grid or page view sizes its children: they fill their cell or page.
-
childFitOptions(
Node? parent, {required bool horizontal}) → Map< SizeFit, String?> -
Every fit, each with the reason it isn't allowed under
parent(null: allowed). With no parent (a top-level node on the board), fixed, hug and fill. -
colorStopFields(
) → List< PropDef< Object?> > -
componentEventAction(
String key) → ActionDef -
The placeholder action for event
key(see kComponentEventAction). -
componentEventOf(
ActionDef action) → String? -
The event
actionis the placeholder of, or null. -
defaultChildFits(
Node parent, SizeFit fit, bool horizontal) → String? - Most parents (stacks, screens' slots...): no Flexible; no Fill along an axis the parent scrolls.
-
diffPatch(
Json from, Json to) → Json? -
The merge patch that turns
fromintoto(null when they're equal). -
dragMotionFields(
) → List< PropDef< Object?> > -
dragSourceFields(
) → List< PropDef< Object?> > -
dragTrackFields(
) → List< PropDef< Object?> > -
dropTargetFields(
) → List< PropDef< Object?> > -
effectAnimationFields(
) → List< PropDef< Object?> > -
effectFields(
) → List< PropDef< Object?> > -
findScript(
Iterable< ScriptDef> scripts, String idOrName) → ScriptDef? -
The script of
scriptsthatidOrNamenames: by id, else by name, a page script over a project one. -
flexChildFits(
Node parent, SizeFit fit, bool horizontal) → String? - A row or column: Flexible along its main axis only; no Fill or Flexible along the main axis when it wraps or scrolls.
-
flickerAt(
double t) → double -
How far (0–1) a LoopAnimationType.flicker is between its
fromandtovalues att(0–1) of a run: waves of 3, 7 and 17 per run, so it wavers, flares and dips like a flame and ends where it began. -
flightFields(
) → List< PropDef< Object?> > -
flipCardFields(
) → List< PropDef< Object?> > -
flipSpringFields(
) → List< PropDef< Object?> > -
gesturePhysicsFields(
) → List< PropDef< Object?> > -
gestureSnapFields(
) → List< PropDef< Object?> > -
heroTagFields(
) → List< PropDef< Object?> > -
imagePaintFields(
) → List< PropDef< Object?> > -
inkWellStyleFields(
) → List< PropDef< Object?> > -
listChildFits(
Node parent, SizeFit fit, bool horizontal) → String? - A list: its items fill across it; along it, they size themselves unless the list gives each the same extent (then they fill it).
-
listEquals<
T> (List< T> ? a, List<T> ? b) → bool - Element-wise list equality.
-
loopAnimationFields(
) → List< PropDef< Object?> > -
managedInstancesOf(
LayoutDocument document) → Iterable< Node> -
The managed instances of
document: their top nodes. -
managedNodeId(
String topId, String nodeId) → String -
The id an instance with top node
topIdgives the version's nodenodeId: stable across versions while the master keeps its node ids. -
managedRolloutBucket(
String projectId, String componentId) → int -
A project's rollout bucket for managed component
componentId, 0..99: FNV-1a (32 bit) of"projectId/componentId"'s UTF-8 bytes, mod 100. Per project, so every user of one app sees the same version. -
managedUpdateTarget(
ComponentLink link, ManagedComponentMaster master, {String projectId = '', String? sdkVersion}) → int? -
The version instance
linkshould show now instead of its snapshot (version ComponentLink.version), bymaster; null to keep the snapshot. -
materialIconNamed(
String name) → Json? -
The Material icon
namenames (check_circle,lock_open_rounded): a suffix (_outlined,_rounded,_sharp) sets its style. Null whennameisn't an icon name. -
measureFields(
) → List< PropDef< Object?> > -
mergePatch(
Json base, Json patch, {bool keepNulls = false}) → Json -
basewithpatchmerged in (RFC 7386): maps merge recursively, anullvalue removes the key (kept asnullwithkeepNulls, to merge two patches), anything else replaces. -
motionFields(
) → List< PropDef< Object?> > -
motionKeyframeFields(
) → List< PropDef< Object?> > -
motionShimmerFields(
) → List< PropDef< Object?> > -
paintFields(
) → List< PropDef< Object?> > -
particleEmitterFields(
) → List< PropDef< Object?> > -
put(
Json json, String key, Object? value, [Object? defaultValue]) → void -
Puts
keyinjsonunlessvalueis null or equalsdefaultValue. -
readBool(
Object? v) → bool? -
vas a bool, or null. -
readDouble(
Object? v) → double? -
vas a finite double, or null. -
readEnum<
T extends Enum> (List< T> values, Object? v, T fallback) → T -
The enum value named
v, orfallback. -
readFontFeatures(
Object? json) → List< String> -
A
fontFeatureslist read loosely: a list of settings (strings or{tag, value}maps) or one string of them separated by commas or spaces, as canonical strings; settings that aren't valid are dropped. -
readInt(
Object? v) → int? -
vas an int, or null. -
readList(
Object? v) → List< Object?> ? -
vas a list, or null. -
readMap(
Object? v) → Json? -
vas a JSON object, or null. Keys are stringified. -
readString(
Object? v) → String? -
vas a string, or null. -
readStrings(
Object? v) → List< String> -
vas a list of strings (non-strings dropped). -
readTimestamp(
Object? v) → DateTime? -
v(milliseconds since the epoch, UTC; or an ISO 8601 string) as a time, or null. -
renderTitle(
String template, {required String appName, String? pageTitle}) → String -
Fills title
template:${page.title},${app.name}(and${page},${app}). The text touching an empty value goes too, so${page.title} · ${app.name}with no page title is the app name alone. -
replaceManagedInstance(
LayoutDocument document, String topId, ManagedBuild build) → LayoutDocument -
documentwith managed instancetopIdreplaced bybuild: the instance's old nodes go, except its slots' content (the page's own nodes), andbuild's come in. The top node keeps its id and its place. -
revealFields(
) → List< PropDef< Object?> > -
routeDismissFields(
) → List< PropDef< Object?> > -
routeTransitionFields(
) → List< PropDef< Object?> > -
scriptFields(
) → List< PropDef< Object?> > -
sdkSatisfies(
String? sdkVersion, String? minSdk) → bool -
Whether an SDK at
sdkVersioncan run a version needingminSdk(either empty or unreadable: yes). -
setJsonPath(
Object? root, List< PathKey> keys, Object? value) → Json? - setJsonPathValue for a JSON object root.
-
setJsonPathValue(
Object? root, List< PathKey> keys, Object? value) → Object? -
Sets
keysin JSONroot(copied along the way) tovalue. Maps are created for missing keys; an index past a list's end (or a list missing) fails. Null when it can't be set. -
settingSlug(
String label) → String -
labelas a setting key: lower case, runs of other characters as_. -
stateStylesFields(
) → List< PropDef< Object?> > -
stickyFields(
) → List< PropDef< Object?> > -
strokePathFields(
) → List< PropDef< Object?> > -
textRunFields(
) → List< PropDef< Object?> > -
textStyleFields(
) → List< PropDef< Object?> > -
tiltFields(
) → List< PropDef< Object?> > -
transformGestureFields(
) → List< PropDef< Object?> > -
transformHandlesFields(
) → List< PropDef< Object?> > -
transitionFields(
) → List< PropDef< Object?> > -
transitionRevealFields(
) → List< PropDef< Object?> > -
transitionsFields(
) → List< PropDef< Object?> > -
transitionSideFields(
) → List< PropDef< Object?> > -
transitionSpringFields(
) → List< PropDef< Object?> > -
typewriterFields(
) → List< PropDef< Object?> > -
unknownActionKeys(
Object? reactions, {String at = 'actions'}) → List< String> -
Keys of action JSON that no field of its type reads, found in
reactions(a node'sactions: reactions{trigger, actions}, or a bare list of actions), nested chains included (then,else,actions,onSuccess,onError,cancelActions). Decoding drops such keys silently (adelaygivendurationMswaits its default 500 ms), so tools report them: each as " -
viewProgressFields(
) → List< PropDef< Object?> > -
writeDouble(
double v) → num - Rounds a double for storage: integral values become ints, others keep up to 4 decimals (sub-pixel noise from editors goes away).
-
writeRatio(
double v) → num - A ratio for storage: integral values become ints, others keep 12 significant decimals. Rounding a ratio to 4 decimals (writeDouble) is off by up to 0.00005 per unit, which a size scales: 320/180 stored as 1.7778 made a 300 px drawing 168.748 tall instead of 168.75.
-
writeTimestamp(
DateTime t) → int -
tas stored: milliseconds since the epoch.
Typedefs
- ChildFitRule = String? Function(Node parent, SizeFit fit, bool horizontal)
-
Why
fitisn't allowed on a child ofparentalong thehorizontalaxis, or null when it is. - IconGlyph = Json
-
An icon glyph, as
IconProps.iconholds it:{"source", "codepoint", "name", "style", "fontFamily"?, ...}or{"image": url}. -
Json
= Map<
String, Object?> - A JSON object.
- LoopPose = ({double dy, double opacity, double scale, double turns})
- The pose of a LoopAnimation at one moment, about the node's center.
- PathKey = Object
-
One step of a binding path: a key, an index (
[2]), or every item (*). - SchemaMigration = Json Function(Json document)
-
One step that upgrades a document's JSON from schema
n - 1ton.