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
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- RatingBar
- Available extensions
Constructors
-
RatingBar({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
- maxRating → double?
-
Sets maximum rating
final
- minRating → double
-
Sets minimum rating
final
-
onRatingUpdate
→ ValueChanged<
double> -
Return current rating whenever rating is updated.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- 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
-
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
-
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}) → 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