handleBackButton method

bool handleBackButton()

Handle system back button. Returns true if the back was consumed.

  • From fullscreen/expanding → collapse to card.
  • From cardMode/collapsing/disappearing → dismiss to grid.
  • From appearing → cancel and dismiss.
  • From idle → not consumed (let the system handle it).

Implementation

bool handleBackButton() {
  switch (_state.phase) {
    case OverlayPhase.idle:
      return false;
    case OverlayPhase.fullscreen:
    case OverlayPhase.expanding:
      collapse();
      return true;
    case OverlayPhase.cardMode:
    case OverlayPhase.collapsing:
    case OverlayPhase.disappearing:
    case OverlayPhase.appearing:
      dismiss();
      return true;
  }
}