sticky_header: Avoid header at sliver/sliver boundary

Author: gnprice

lib/widgets/sticky_header.dart

@@ -766,10 +766,23 @@ class _RenderSliverStickyHeaderListInner extends RenderSliverList {
 
     final RenderBox? child;
     switch (widget.headerPlacement._byGrowth(constraints.growthDirection)) {
+      case _HeaderGrowthPlacement.growthStart:
+        if (constraints.remainingPaintExtent < constraints.viewportMainAxisExtent) {
+          // Part of the viewport is occupied already by other slivers.  The way
+          // a RenderViewport does layout means that the already-occupied part is
+          // the part that's before this sliver in the growth direction.
+          // Which means that's the place where the header would go.
+          child = null;
+        } else {
+          child = _findChildAtStart();
+        }
       case _HeaderGrowthPlacement.growthEnd:
+        // The edge this sliver wants to place a header at is the one where
+        // this sliver is free to run all the way to the viewport's edge; any
+        // further slivers in that direction will be laid out after this one.
+        // So if this sliver placed a child there, it's at the edge of the
+        // whole viewport and should determine a header.
         child = _findChildAtEnd();
-      case _HeaderGrowthPlacement.growthStart:
-        child = _findChildAtStart();
     }
 
     (parent! as _RenderSliverStickyHeaderList)._rebuildHeader(child);

test/widgets/sticky_header_test.dart

@@ -192,14 +192,10 @@ void main() {
       }));
       final itemWidget = itemElement.widget as _Item;
       check(itemWidget.index).equals(index);
-      // TODO the `.first` calls should be unnecessary; that's another bug
-      // check(_headerIndex(tester)).equals(index);
-      check(tester.widget<_Header>(find.byType(_Header).first).index)
-        .equals(index);
+      check(_headerIndex(tester)).equals(index);
       check((itemElement.renderObject as RenderBox).localToGlobal(Offset(0, 0)))
         .equals(Offset(0, item));
-      check(tester.getTopLeft(find.byType(_Header).first))
-        .equals(Offset(0, header));
+      check(tester.getTopLeft(find.byType(_Header))).equals(Offset(0, header));
     }
 
     check(controller.offset).equals(0);