RatingBar class

A widget to receive rating input from users.

RatingBar can also be used to display rating

Prefer using RatingBarIndicator instead, if read only version is required. As RatingBarIndicator supports any fractional rating value.

Inheritance
Available extensions

Constructors

RatingBar.new({Key? key, required RatingWidget ratingWidget, required ValueChanged<double> onRatingUpdate, Color? glowColor, double? maxRating, TextDirection? textDirection, Color? unratedColor, bool allowHalfRating = false, Axis direction = Axis.horizontal, bool glow = true, double glowRadius = 2, bool ignoreGestures = false, double initialRating = 0.0, int itemCount = 5, EdgeInsetsGeometry itemPadding = EdgeInsets.zero, double itemSize = 40.0, double minRating = 0, bool tapOnlyMode = false, bool updateOnDrag = false, WrapAlignment wrapAlignment = WrapAlignment.start})
Creates RatingBar using the ratingWidget.
const
RatingBar.builder({Key? key, required IndexedWidgetBuilder itemBuilder, required ValueChanged<double> onRatingUpdate, Color? glowColor, double? maxRating, TextDirection? textDirection, Color? unratedColor, bool allowHalfRating = false, Axis direction = Axis.horizontal, bool glow = true, double glowRadius = 2, bool ignoreGestures = false, double initialRating = 0.0, int itemCount = 5, EdgeInsetsGeometry itemPadding = EdgeInsets.zero, double itemSize = 40.0, double minRating = 0, bool tapOnlyMode = false, bool updateOnDrag = false, WrapAlignment wrapAlignment = WrapAlignment.start})
Creates RatingBar using the itemBuilder.
const

Properties

allowHalfRating → bool
Default allowHalfRating = false. Setting true enables half rating support.
final
direction → Axis
Direction of rating bar.
final
glow → bool
if set to true, Rating Bar item will glow when being touched.
final
glowColor → Color?
Defines color for glow.
final
glowRadius → double
Defines the radius of glow.
final
hashCode → int
The hash code for this object.
no setterinherited
ignoreGestures → bool
if set to true, will disable any gestures over the rating bar.
final
initialRating → double
Defines the initial rating to be set to the rating bar.
final
itemCount → int
Defines total number of rating bar items.
final
itemPadding → EdgeInsetsGeometry
The amount of space by which to inset each rating item.
final
itemSize → double
Defines width and height of each rating item in the bar.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
marginZero → Widget

Available on Widget, provided by the WidgetMarginX extension

no setter
maxRating → double?
Sets maximum rating
final
minRating → double
Sets minimum rating
final
onRatingUpdate → ValueChanged<double>
Return current rating whenever rating is updated.
final
paddingZero → Widget

Available on Widget, provided by the WidgetPaddingX extension

no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sliverBox → Widget

Available on Widget, provided by the WidgetSliverBoxX extension

no setter
tapOnlyMode → bool
if set to true will disable drag to rate feature. Note: Enabling this mode will disable half rating capability.
final
textDirection → TextDirection?
The text flows from right to left if textDirection = TextDirection.rtl
final
unratedColor → Color?
Defines color for the unrated portion.
final
updateOnDrag → bool
Defines whether or not the onRatingUpdate updates while dragging.
final
wrapAlignment → WrapAlignment
How the item within the RatingBar should be placed in the main axis.
final

Methods

alignAtBottomCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtBottomLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtBottomRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtCenterLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtCenterRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtLERP(Alignment a, Alignment b, double t, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtTopCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtTopLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignAtTopRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

alignXY(double x, double y, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _RatingBarState
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
expanded([int? flex]) → Widget

Available on Widget, provided by the WidgetsExtension extension

fit([BoxFit fit = BoxFit.scaleDown]) → Widget

Available on Widget, provided by the WidgetsExtension extension

ltr() → Widget

Available on Widget, provided by the WidgetsExtension extension

marginAll(double margin) → Widget

Available on Widget, provided by the WidgetMarginX extension

marginOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget

Available on Widget, provided by the WidgetMarginX extension

marginSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget

Available on Widget, provided by the WidgetMarginX extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

onTapInkWell(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

onTapOpaque(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

paddingAll(double padding) → Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget

Available on Widget, provided by the WidgetPaddingX extension

rtl() → Widget

Available on Widget, provided by the WidgetsExtension extension

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
withTooltip(String message, {Decoration? decoration, double? height, bool? preferBelow, EdgeInsetsGeometry? padding, TextStyle? textStyle, Duration? waitDuration, EdgeInsetsGeometry? margin}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Operators

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