ClipRRect class
A widget that clips its child using a rounded rectangle.
By default, ClipRRect uses its own bounds as the base rectangle for the clip, but the size and location of the clip can be customized using a custom clipper.
This example shows various ClipRRects applied to containers.
link
To create a local project with this code sample, run:
flutter create --sample=widgets.ClipRRect.1 mysample
Troubleshooting
Why doesn't my ClipRRect child have rounded corners?
When a ClipRRect is bigger than the child it contains, its rounded corners could be drawn in unexpected positions. Make sure that ClipRRect and its child have the same bounds (by shrinking the ClipRRect with a FittedBox or by growing the child).
This example shows a ClipRRect that adds round corners to an image.
link
To create a local project with this code sample, run:
flutter create --sample=widgets.ClipRRect.2 mysample
See also:
- CustomClipper, for information about creating custom clips.
- ClipRect, for more efficient clips without rounded corners.
- ClipOval, for an elliptical clip.
- ClipPath, for an arbitrarily shaped clip.
- Inheritance
Constructors
-
ClipRRect({Key? key, BorderRadiusGeometry borderRadius = BorderRadius.zero, CustomClipper<
RRect> ? clipper, Clip clipBehavior = Clip.antiAlias, Widget? child}) -
Creates a rounded-rectangular clip.
const
Properties
- borderRadius → BorderRadiusGeometry
-
The border radius of the rounded corners.
final
- child → Widget?
-
The widget below this widget in the tree.
finalinherited
- clipBehavior → Clip
-
Controls how to clip.
final
-
clipper
→ CustomClipper<
RRect> ? -
If non-null, determines which clip 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) → RenderClipRRect -
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 -
A render object previously associated with this widget has been removed
from the tree. The given RenderObject will be of the same type as
returned by this object's createRenderObject.
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}) → 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 RenderClipRRect 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