Unverified Commit 891bd95e authored by Yuqian Li's avatar Yuqian Li Committed by GitHub

Add clipBehavior to BoxFit doc (#68662)

parent e9b18c1d
...@@ -29,18 +29,27 @@ enum BoxFit { ...@@ -29,18 +29,27 @@ enum BoxFit {
/// As small as possible while still covering the entire target box. /// As small as possible while still covering the entire target box.
/// ///
/// {@template clip_with_box_fit}
/// To actually clip the content, use `clipBehavior: Clip.hardEdge` alongside
/// this in a [FittedBox].
/// {@endtemplate}
///
/// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_cover.png) /// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_cover.png)
cover, cover,
/// Make sure the full width of the source is shown, regardless of /// Make sure the full width of the source is shown, regardless of
/// whether this means the source overflows the target box vertically. /// whether this means the source overflows the target box vertically.
/// ///
/// {@macro clip_with_box_fit}
///
/// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_fitWidth.png) /// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_fitWidth.png)
fitWidth, fitWidth,
/// Make sure the full height of the source is shown, regardless of /// Make sure the full height of the source is shown, regardless of
/// whether this means the source overflows the target box horizontally. /// whether this means the source overflows the target box horizontally.
/// ///
/// {@macro clip_with_box_fit}
///
/// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_fitHeight.png) /// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_fitHeight.png)
fitHeight, fitHeight,
...@@ -49,6 +58,8 @@ enum BoxFit { ...@@ -49,6 +58,8 @@ enum BoxFit {
/// ///
/// The source image is not resized. /// The source image is not resized.
/// ///
/// {@macro clip_with_box_fit}
///
/// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_none.png) /// ![](https://flutter.github.io/assets-for-api-docs/assets/painting/box_fit_none.png)
none, none,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment