ClipRRectModifier 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.

{@tool dartpad} This example shows various ClipRRects applied to containers.

** See code in examples/api/lib/widgets/basic/clip_rrect.0.dart ** {@end-tool}

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).

{@tool dartpad} This example shows a ClipRRect that adds round corners to an image.

** See code in examples/api/lib/widgets/basic/clip_rrect.1.dart ** {@end-tool}

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
Available extensions

Constructors

ClipRRectModifier({Key? key, Widget? child, BorderRadiusGeometry? borderRadius = BorderRadius.zero, CustomClipper<RRect>? clipper, Clip clipBehavior = Clip.antiAlias})
Creates a rounded-rectangular clip.
const

Properties

borderRadius BorderRadiusGeometry?
The border radius of the rounded corners.
final
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
modifierKey Key?
The actual key of the widget, which Modifier wrapped
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
inherited
buildWithChild(BuildContext context, Widget? child) Widget
A build method that receives an extra child parameter.
override
createElement() SingleChildStatelessElement
Create a SingleChildStatelessElement
inherited
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.
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

Operators

operator ==(Object other) bool
The equality operator.
inherited