OnboardingPageScaffold class

Shared layout for learner-onboarding screens.

v2 ("Study Hall") edition: an editorial card with a giant § ornament behind the centered headline, a responsive headline that scales from displayXl 88 px down to 48 px on mobile, and an optional right-side _OnboardingSteps panel passed via steps.

Layout rules (matching onboarding.html):

  • At widths ≥ 800 px and when steps is non-null, the body sits in a 1.2 / 1 grid with the steps panel on the right.
  • Otherwise content flows in a single column with the steps panel, if any, beneath the body.
  • The § ornament is positioned top: -60, right: -40 and clipped by the card's Clip.hardEdge rounded rectangle.
Inheritance
Available extensions

Constructors

OnboardingPageScaffold({Key? key, required int step, required int totalSteps, required String title, String? primaryLabel, VoidCallback? onPrimary, Widget? body, String? kicker, List<OnboardingStep>? steps, String? stepsLabel, Widget? secondary})
const

Properties

body → Widget?
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
kicker → String?
Optional uppercase mono kicker rendered above the headline. Defaults to null, in which case the kicker line is omitted.
final
onPrimary → VoidCallback?
final
primaryLabel → String?
Primary CTA label. When null (along with onPrimary), the CTA row is suppressed entirely unless a secondary widget is provided — useful for screens where the body itself contains the affordances (e.g. a list of topic cards to pick from).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondary → Widget?
Secondary action — typically OnboardingSkipLink. Sits next to the primary CTA on wide layouts and below it on mobile.
final
step → int
final
steps → List<OnboardingStep>?
Optional right-side panel rendered per onboarding.html:32-43. Pass null to suppress the panel.
final
stepsLabel → String?
Tiny mono label rendered above the steps panel, e.g. "Today · 3 steps".
final
title → String
final
totalSteps → int
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited