Update documentation for bottom sheets to accurately reflect usage (#37964)

This commit is contained in:
rami-a 2019-08-12 12:26:54 -04:00 committed by GitHub
parent 7d154e883e
commit b8484e348e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions

View File

@ -410,10 +410,12 @@ class _ModalBottomSheetRoute<T> extends PopupRoute<T> {
/// ///
/// See also: /// See also:
/// ///
/// * [BottomSheet], which is the widget normally returned by the function /// * [BottomSheet], which becomes the parent of the widget returned by the
/// passed as the `builder` argument to [showModalBottomSheet]. /// function passed as the `builder` argument to [showModalBottomSheet].
/// * [showBottomSheet] and [ScaffoldState.showBottomSheet], for showing /// * [showBottomSheet] and [ScaffoldState.showBottomSheet], for showing
/// non-modal bottom sheets. /// non-modal bottom sheets.
/// * [DraggableScrollableSheet], which allows you to create a bottom sheet
/// that grows and then becomes scrollable once it reaches its maximum size.
/// * <https://material.io/design/components/sheets-bottom.html#modal-bottom-sheet> /// * <https://material.io/design/components/sheets-bottom.html#modal-bottom-sheet>
Future<T> showModalBottomSheet<T>({ Future<T> showModalBottomSheet<T>({
@required BuildContext context, @required BuildContext context,
@ -471,7 +473,8 @@ Future<T> showModalBottomSheet<T>({
/// ///
/// See also: /// See also:
/// ///
/// * [BottomSheet], which is the widget typically returned by the `builder`. /// * [BottomSheet], which becomes the parent of the widget returned by the
/// `builder`.
/// * [showModalBottomSheet], which can be used to display a modal bottom /// * [showModalBottomSheet], which can be used to display a modal bottom
/// sheet. /// sheet.
/// * [Scaffold.of], for information about how to obtain the [BuildContext]. /// * [Scaffold.of], for information about how to obtain the [BuildContext].

View File

@ -1737,7 +1737,8 @@ class ScaffoldState extends State<Scaffold> with TickerProviderStateMixin {
/// ///
/// See also: /// See also:
/// ///
/// * [BottomSheet], which is the widget typically returned by the `builder`. /// * [BottomSheet], which becomes the parent of the widget returned by the
/// `builder`.
/// * [showBottomSheet], which calls this method given a [BuildContext]. /// * [showBottomSheet], which calls this method given a [BuildContext].
/// * [showModalBottomSheet], which can be used to display a modal bottom /// * [showModalBottomSheet], which can be used to display a modal bottom
/// sheet. /// sheet.