zan1456/flutter
1
0
Fork 0
forked from firka/flutter
Code Pull Requests Activity

Add some color to the ShapeDecoration.shape docs (#14100)

Browse Source 
...especially about TextDirection.
This commit is contained in:
Ian Hickson
2018-01-15 12:43:43 -08:00
committed by GitHub
parent 09a6df7461
commit 299ddb4320
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
packages/flutter/lib/src/painting/shape_decoration.dart
View File

@@ -150,6 +150,20 @@ class ShapeDecoration extends Decoration {
///
/// The [shape] property specifies the outline (border) of the decoration. The
/// shape must not be null.
///
/// ## Directionality-dependent shapes
///
/// Some [ShapeBorder] subclasses are sensitive to the [TextDirection]. The
/// direction that is provided to the border (e.g. for its [ShapeBorder.paint]
/// method) is the one specified in the [ImageConfiguration]
/// ([ImageConfiguration.textDirection]) provided to the [BoxPainter] (via its
/// [BoxPainter.paint method). The [BoxPainter] is obtained when
/// [createBoxPainter] is called.
///
/// When a [ShapeDecoration] is used with a [Container] widget or a
/// [DecoratedBox] widget (which is what [Container] uses), the
/// [TextDirection] specified in the [ImageConfiguration] is obtained from the
/// ambient [Directionality], using [createLocalImageConfiguration].
final ShapeBorder shape;
/// The inset space occupied by the [shape]'s border.