FormMultiMedia<TValue> class

Form for submitting images and videos. Multiple media can be submitted.

Multiple selection version of FormMedia. Common design can be applied with FormStyle. Multiple media can be selected and managed using FormController. It provides features such as multiple selection of images/videos, preview display, reordering, and deletion.

FormMediaの複数選択版。FormStyleで共通したデザインを適用可能。またFormControllerを利用して複数のメディアの選択と管理を行うことができます。画像・動画の複数選択、プレビュー表示、並び替え、削除などの機能を備えています。

All media is managed by FormMediaValue.

メディアはすべてFormMediaValueで管理されます。

Basic Usage Example 基本的な使用例

FormMultiMedia(
  form: formController,
  initialValue: formController.value.mediaList.map((e) => e.toFormMediaValue()).toList(),
  onSaved: (value) => formController.value.copyWith(mediaList: value.map((e) => e.toModelImageUri()).toList()),
  onTap: (ref) async {
    final picked = await picker.pickMulti();
    final uris = picked.map((e) => e.uri).toList();
    if (uris.isEmpty) {
      return;
    }
    ref.update(uris, FormMediaType.image);
  },
  builder: (context, value) {
    return Container(
      width: 200,
      height: 200,
      decoration: BoxDecoration(
        color: Colors.grey[200],
        image: DecorationImage(
          image: value?.toImageProvider(),
          fit: BoxFit.cover,
        ),
      ),
    );
  },
);

Inheritance

Annotations

@immutable

Constructors

FormMultiMedia({required Widget builder(BuildContext context, FormMediaValue value), required void onTap(FormMultiMediaRef ref), Key? key, FormController<TValue>? form, FormStyle? style, void onRemove(FormMediaValue value)?, int? maxLength, String? labelText, List<FormMediaValue>? initialValue, String? emptyErrorText, bool readOnly = false, void onChanged(List<FormMediaValue> value)?, TValue onSaved(List<FormMediaValue> value)?, String validator(List<FormMediaValue> value)?, FormMultiMediaDelegate delegate = const FormMultiMediaInlineDelegate(), bool enabled = true, bool keepAlive = true}): Form for submitting images and videos. Multiple media can be submitted.

Properties

autovalidateMode → AutovalidateMode: Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → FormFieldBuilder<List<FormMediaValue>>: Function that returns the widget representing this form field.
finalinherited
delegate → FormMultiMediaDelegate: A delegate to determine the design of the form.
final
emptyErrorText → String?: Error text. Only displayed if no characters are entered.
final
enabled → bool: Whether the form is able to receive user input.
finalinherited
errorBuilder → FormFieldErrorBuilder?: Function that returns the widget representing the error to display.
finalinherited
forceErrorText → String?: An optional property that forces the FormFieldState into an error state by directly setting the FormFieldState.errorText property without running the validator function.
finalinherited
form → FormController<TValue>?: Context for forms.
final
hashCode → int: The hash code for this object.
no setterinherited
initialValue → List<FormMediaValue>?: An optional value to initialize the form field to, or null otherwise.
finalinherited
keepAlive → bool: If placed in a list, whether or not it should not be discarded on scrolling.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
labelText → String?: Label text for forms.
final
maxLength → int?: If specified, no more items can be added.
final
onChanged → void Function(List<FormMediaValue> value)?: Callback to be executed each time the value is changed.
final
onRemove → void Function(FormMediaValue value)?: Callback when deleting an item.
final
onReset → VoidCallback?: An optional method to call when the form field is reset via FormFieldState.reset.
finalinherited
onSaved → FormFieldSetter<List<FormMediaValue>>?: An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
onTap → void Function(FormMultiMediaRef ref): Describe what to do when the form is tapped.
final
readOnly → bool: If this is true, the form cannot be filled out and changed from its initial value.
final
restorationId → String?: Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
style → FormStyle?: Form Style.
final
validator → FormFieldValidator<List<FormMediaValue>>?: An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

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