PrismSkeleton class

A shimmering placeholder shown while content loads.

Skeletons communicate structure better than a spinner: the page keeps its shape and simply "fills in". Every Prism skeleton animation is driven by a single AnimationController per widget, is disabled automatically when the platform requests reduced motion, and never runs off-screen.

if (loading)
  const PrismSkeleton.card()
else
  NoteCard(note);

See also PrismSkeletonList, which lays out several skeletons for the common "list is loading" case.

Inheritance

Constructors

PrismSkeleton({Key? key, double? width, double height = 16, BorderRadius? borderRadius, PrismSkeletonShape shape = PrismSkeletonShape.rounded, Color? baseColor, Color? highlightColor, bool animate = true})
Creates a skeleton block.
const
PrismSkeleton.circle({Key? key, required double diameter, Color? baseColor, Color? highlightColor, bool animate = true})
A skeleton circle, sized by diameter.
const

Properties

animate → bool
Whether to run the shimmer. Set false for a static placeholder.
final
baseColor → Color?
Base (unlit) color; defaults to the theme's surface-container.
final
borderRadius → BorderRadius?
Corner radius override; defaults to PrismTokens.radiusSm.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double
Fixed height.
final
highlightColor → Color?
Shimmer highlight color; defaults to a lightened surface.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → PrismSkeletonShape
Overall shape.
final
width → double?
Fixed width; stretches to the parent when null.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PrismSkeleton>
Creates the mutable state for this widget at a given location in the tree.
override
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