development/flutter
development/flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter synced 2024-10-13 19:52:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explain that BoxDecoration doesn't do clip. (#26089)

Browse source 
Fixes https://github.com/flutter/flutter/issues/22370
This commit is contained in:
liyuqian 2019-01-06 07:20:36 +08:00 committed by GitHub
parent 6502a1bed9
commit d06e4325d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
packages/flutter/lib/src/painting/box_decoration.dart
View file

@ -54,6 +54,13 @@ import 'image_provider.dart';
/// ```
/// {@end-tool}
///
/// {@template flutter.painting.boxDecoration.clip}
/// The [shape] or the [borderRadius] won't clip the children of the
/// decorated [Container]. If the clip is required, insert a clip widget
/// (e.g., [ClipRect], [ClipRRect], [ClipPath]) as the child of the [Container].
/// Be aware that clipping may be costly in terms of performance.
/// {@endtemplate}
///
/// See also:
///
/// * [DecoratedBox] and [Container], widgets that can be configured with
@ -130,6 +137,8 @@ class BoxDecoration extends Decoration {
///
/// Applies only to boxes with rectangular shapes; ignored if [shape] is not
/// [BoxShape.rectangle].
///
/// {@macro flutter.painting.boxDecoration.clip}
final BorderRadiusGeometry borderRadius;
/// A list of shadows cast by this box behind the box.
@ -163,6 +172,8 @@ class BoxDecoration extends Decoration {
/// different [ShapeBorder]s; in particular, [CircleBorder] instead of
/// [BoxShape.circle] and [RoundedRectangleBorder] instead of
/// [BoxShape.rectangle].
///
/// {@macro flutter.painting.boxDecoration.clip}
final BoxShape shape;
@override