OudsSkeleton class

OUDS Skeleton Design Guidelines

Reference design version : 1.0.0

A skeleton is a UI element that indicates when content is loading. The skeleton enhances user experience by temporarily replacing content with gray areas or animations that simulate the visual structure of the forthcoming content.

OudsSkeleton does not expose width/height parameters of its own and relies on the size constraints provided by its parent. To display it at a specific size, wrap it in a SizedBox (or any other size-constraining widget) instead of passing size values directly:

SizedBox(
  width: 250,
  height: 80,
  child: OudsSkeleton(),
)

OudsSkeleton(
  animated: true,
  securityMargin: false,
)
Inheritance

Constructors

OudsSkeleton({Key? key, bool animated = true, bool securityMargin = false})
Creates an OudsSkeleton.
const

Properties

animated → bool
Whether the shimmer sweep animation is enabled. Defaults to true. Automatically disabled when the system "reduce motion" accessibility setting is active, regardless of this value.
final
hashCode → int
The hash code for this object.
no setterinherited
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
securityMargin → bool
Whether to apply vertical padding to the skeleton. Defaults to true.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<OudsSkeleton>
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