DismissibleModifier constructor

const DismissibleModifier({
  1. Key? key,
  2. Widget? child,
  3. required Key modifierKey,
  4. Widget? background,
  5. Widget? secondaryBackground,
  6. ConfirmDismissCallback? confirmDismiss,
  7. VoidCallback? onResize,
  8. DismissUpdateCallback? onUpdate,
  9. DismissDirectionCallback? onDismissed,
  10. DismissDirection direction = DismissDirection.horizontal,
  11. Duration? resizeDuration = const Duration(milliseconds: 300),
  12. Map<DismissDirection, double> dismissThresholds = const <DismissDirection, double>{},
  13. Duration movementDuration = const Duration(milliseconds: 200),
  14. double crossAxisEndOffset = 0.0,
  15. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  16. HitTestBehavior behavior = HitTestBehavior.opaque,
})

Creates a widget that can be dismissed.

The key argument must not be null because Dismissibles are commonly used in lists and removed from the list when dismissed. Without keys, the default behavior is to sync widgets based on their index in the list, which means the item after the dismissed item would be synced with the state of the dismissed item. Using keys causes the widgets to sync according to their keys and avoids this pitfall.

Implementation

const DismissibleModifier({
  super.key,
  super.child,
  required Key super.modifierKey,
  this.background,
  this.secondaryBackground,
  this.confirmDismiss,
  this.onResize,
  this.onUpdate,
  this.onDismissed,
  this.direction = DismissDirection.horizontal,
  this.resizeDuration = const Duration(milliseconds: 300),
  this.dismissThresholds = const <DismissDirection, double>{},
  this.movementDuration = const Duration(milliseconds: 200),
  this.crossAxisEndOffset = 0.0,
  this.dragStartBehavior = DragStartBehavior.start,
  this.behavior = HitTestBehavior.opaque,
}) : assert(secondaryBackground == null || background != null);