ReactiveRatingBar<T> constructor
- {Key? key,
- String? formControlName,
- FormControl<
T> ? formControl, - Map<
String, ValidationMessageFunction> ? validationMessages, - ControlValueAccessor<
T, double> ? valueAccessor, - ShowErrorsFunction<
T> ? showErrors, - InputDecoration decoration = const InputDecoration(border: InputBorder.none, contentPadding: EdgeInsets.fromLTRB(0, 0, 0, 0), isDense: true, isCollapsed: true),
- required RatingWidget ratingWidget,
- RatingBarBuilder? ratingBarBuilder,
- Color? glowColor,
- double? maxRating,
- TextDirection? textDirection,
- Color? unratedColor,
- bool allowHalfRating = false,
- Axis direction = Axis.horizontal,
- bool glow = true,
- double glowRadius = 2,
- bool ignoreGestures = false,
- int itemCount = 5,
- EdgeInsets itemPadding = EdgeInsets.zero,
- double itemSize = 40.0,
- double minRating = 0,
- bool tapOnlyMode = false,
- bool updateOnDrag = false,
- WrapAlignment wrapAlignment = WrapAlignment.start}
Creates a ReactiveRatingBar that contains a TouchSpin
.
Can optionally provide a formControl
to bind this widget to a control.
Can optionally provide a formControlName
to bind this ReactiveFormField
to a FormControl
.
Must provide one of the arguments formControl
or a formControlName
,
but not both at the same time.
Can optionally provide a validationMessages
argument to customize a
message for different kinds of validation errors.
Can optionally provide a valueAccessor
to set a custom value accessors.
See ControlValueAccessor
.
Can optionally provide a showErrors
function to customize when to show
validation messages. Reactive Widgets make validation messages visible
when the control is INVALID and TOUCHED, this behavior can be customized
in the showErrors
function.
Example:
Binds a text field.
final form = fb.group({'email': Validators.required});
ReactiveRatingBar(
formControlName: 'email',
),
Binds a text field directly with a FormControl.
final form = fb.group({'email': Validators.required});
ReactiveRatingBar(
formControl: form.control('email'),
),
Customize validation messages
ReactiveRatingBar(
formControlName: 'email',
validationMessages: {
ValidationMessage.required: 'The email must not be empty',
ValidationMessage.email: 'The email must be a valid email',
}
),
Customize when to show up validation messages.
ReactiveRatingBar(
formControlName: 'email',
showErrors: (control) => control.invalid && control.touched && control.dirty,
),
For documentation about the various parameters, see the TouchSpin
class
and TouchSpin
, the constructor.
Implementation
ReactiveRatingBar({
Key? key,
String? formControlName,
FormControl<T>? formControl,
Map<String, ValidationMessageFunction>? validationMessages,
ControlValueAccessor<T, double>? valueAccessor,
ShowErrorsFunction<T>? showErrors,
////////////////////////////////////////////////////////////////////////////
InputDecoration decoration = const InputDecoration(
border: InputBorder.none,
contentPadding: EdgeInsets.fromLTRB(0, 0, 0, 0),
isDense: true,
isCollapsed: true,
),
required RatingWidget ratingWidget,
RatingBarBuilder? ratingBarBuilder,
Color? glowColor,
double? maxRating,
TextDirection? textDirection,
Color? unratedColor,
bool allowHalfRating = false,
Axis direction = Axis.horizontal,
bool glow = true,
double glowRadius = 2,
bool ignoreGestures = false,
int itemCount = 5,
EdgeInsets itemPadding = EdgeInsets.zero,
double itemSize = 40.0,
double minRating = 0,
bool tapOnlyMode = false,
bool updateOnDrag = false,
WrapAlignment wrapAlignment = WrapAlignment.start,
}) : super(
key: key,
formControl: formControl,
formControlName: formControlName,
valueAccessor: valueAccessor,
validationMessages: validationMessages,
showErrors: showErrors,
builder: (field) {
final InputDecoration effectiveDecoration = decoration
.applyDefaults(Theme.of(field.context).inputDecorationTheme);
final child = RatingBar(
ratingWidget: ratingWidget,
onRatingUpdate: field.didChange,
glowColor: glowColor,
maxRating: maxRating,
textDirection: textDirection,
unratedColor: unratedColor,
allowHalfRating: allowHalfRating,
direction: direction,
glow: glow,
glowRadius: glowRadius,
ignoreGestures: ignoreGestures,
initialRating: field.value ?? 0,
itemCount: itemCount,
itemPadding: itemPadding,
itemSize: itemSize,
minRating: minRating,
tapOnlyMode: tapOnlyMode,
updateOnDrag: updateOnDrag,
wrapAlignment: wrapAlignment,
);
return Listener(
onPointerDown: (_) {
if (field.control.enabled) {
field.control.markAsTouched();
}
},
child: InputDecorator(
textAlign: TextAlign.center,
decoration: effectiveDecoration.copyWith(
errorText: field.errorText,
enabled: field.control.enabled,
),
child: ratingBarBuilder?.call(field.context, child) ?? child,
),
);
},
);