SliverClipRect class
A sliver that clips its child using a rectangle.
By default, it clips the child to its bounds. It can also clip based on a custom clipper.
This widget is particularly useful when used in a CustomScrollView with pinned slivers (like SliverAppBar with SliverAppBar.pinned set to true).
The clipOverlap parameter controls how the clip reacts to the area that overlaps with a preceding pinned sliver:
- ClipOverlapBehavior.followEdge (default): the clip rectangle is truncated at the overlap boundary.
- ClipOverlapBehavior.preserveShape: behaves exactly like ClipOverlapBehavior.followEdge here, because a plain rectangle has no rounded corners to preserve. Use SliverClipRRect to get the shifting behavior.
- ClipOverlapBehavior.none: the overlap is ignored and no additional clipping is applied.
This example shows a CustomScrollView with a pinned SliverAppBar and a
SliverClipRect wrapping a list. As the list scrolls up, the items are
clipped so they don't appear behind the semi-transparent app bar.
link
CustomScrollView(
slivers: <Widget>[
SliverAppBar(
pinned: true,
expandedHeight: 200.0,
backgroundColor: Colors.blue.withAlpha(128), // Semi-transparent
flexibleSpace: const FlexibleSpaceBar(
title: Text('SliverClipRect'),
),
),
SliverClipRect(
sliver: SliverList(
delegate: SliverChildBuilderDelegate(
(BuildContext context, int index) {
return Container(
height: 100.0,
color: index.isEven ? Colors.grey[200] : Colors.grey[300],
child: Center(child: Text('Item $index')),
);
},
childCount: 20,
),
),
),
],
)
See also:
- SliverClipRRect, which clips a sliver with a rounded rectangle.
- ClipRect, which clips a box widget.
- CustomClipper, for creating custom clips.
- Inheritance
Constructors
-
SliverClipRect({Key? key, required Widget sliver, CustomClipper<
Rect> ? clipper, Clip clipBehavior = .hardEdge, ClipOverlapBehavior clipOverlap = .followEdge}) -
Creates a sliver that clips its child using a rectangle.
const
Properties
- child → Widget?
-
The widget below this widget in the tree.
finalinherited
- clipBehavior → Clip
-
Controls how to clip.
final
- clipOverlap → ClipOverlapBehavior
-
How the clip reacts to the area overlapped by preceding pinned slivers.
final
-
clipper
→ CustomClipper<
Rect> ? -
If non-null, determines which clip rectangle to use.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → SingleChildRenderObjectElement -
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
-
createRenderObject(
BuildContext context) → RenderSliverClipRect -
Creates an instance of the RenderObject class that this
RenderObjectWidget represents, using the configuration described by this
RenderObjectWidget.
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.
override
-
didUnmountRenderObject(
covariant RenderObject renderObject) → void -
This method is called when a RenderObject that was previously
associated with this widget is removed from the render tree.
The provided RenderObject will be of the same type as the one created by
this widget's createRenderObject method.
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
-
updateRenderObject(
BuildContext context, covariant RenderSliverClipRect renderObject) → void -
Copies the configuration described by this RenderObjectWidget to the
given RenderObject, which will be of the same type as returned by this
object's createRenderObject.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited