ReactiveMacosSwitch<T> constructor

ReactiveMacosSwitch<T>({
  1. Key? key,
  2. String? formControlName,
  3. FormControl<T>? formControl,
  4. Map<String, ValidationMessageFunction>? validationMessages,
  5. ControlValueAccessor<T, bool>? valueAccessor,
  6. ShowErrorsFunction<T>? showErrors,
  7. InputDecoration decoration = const InputDecoration(border: InputBorder.none, contentPadding: EdgeInsets.fromLTRB(0, 0, 0, 0), isDense: true, isCollapsed: true),
  8. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  9. MacosColor? activeColor,
  10. MacosColor? trackColor,
  11. String? semanticLabel,
})

Creates a ReactiveMacosSwitch that contains a MacosSwitch.

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});

ReactiveMacosSwitch(
  formControlName: 'email',
),

Binds a text field directly with a FormControl.

final form = fb.group({'email': Validators.required});

ReactiveMacosSwitch(
  formControl: form.control('email'),
),

Customize validation messages

ReactiveMacosSwitch(
  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.

ReactiveMacosSwitch(
  formControlName: 'email',
  showErrors: (control) => control.invalid && control.touched && control.dirty,
),

For documentation about the various parameters, see the MacosSwitch class and MacosSwitch, the constructor.

Implementation

ReactiveMacosSwitch({
  super.key,
  super.formControlName,
  super.formControl,
  super.validationMessages,
  super.valueAccessor,
  super.showErrors,

  ////////////////////////////////////////////////////////////////////////////
  InputDecoration decoration = const InputDecoration(
    border: InputBorder.none,
    contentPadding: EdgeInsets.fromLTRB(0, 0, 0, 0),
    isDense: true,
    isCollapsed: true,
  ),
  DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  MacosColor? activeColor,
  MacosColor? trackColor,
  String? semanticLabel,
}) : super(
        builder: (field) {
          return Listener(
            onPointerDown: (_) {
              if (field.control.enabled) {
                field.control.markAsTouched();
              }
            },
            child: MacosSwitch(
              value: field.value ?? false,
              onChanged: field.control.enabled ? field.didChange : null,
              dragStartBehavior: dragStartBehavior,
              activeColor: activeColor,
              trackColor: trackColor,
              semanticLabel: semanticLabel,
            ),
          );
        },
      );