Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix mistakes in documentation #69

Merged
merged 2 commits into from
Mar 20, 2024
Merged

Fix mistakes in documentation #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b41612b
Fix mistakes in documentation
fujidaiti Mar 20, 2024
6fdeb56
Bump to 0.4.1
fujidaiti Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions package/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.4.1 Mar 20, 2024

- Fix mistakes in the documentation of `BottomBarVisibility` and `ConditionalStickyBottomBarVisibility` which may mislead readers.

## 0.4.0 Mar 20, 2024

- Add `BottomBarVisibility` widgets (#15, #19)
Expand Down
15 changes: 10 additions & 5 deletions package/lib/src/foundation/sheet_content_scaffold.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,10 @@ class _ScaffoldBodyContainer extends StatelessWidget {
///
/// Intended to be used as the [SheetContentScaffold.bottomBar].
/// For example, the [StickyBottomBarVisibility] can be used to keep
/// the [child] always visible regardless of the sheet position
/// including when the onscreen keyboard is open.
/// the [child] always visible regardless of the sheet position. You may want
/// to use the [ResizeScaffoldBehavior.avoidBottomInset] with setting
/// `maintainBottomBar` to true to keep the bottom bar visible even when
/// the onscreen keyboard is open.
///
/// {@macro StickyBottomBarVisibility:example}
///
Expand Down Expand Up @@ -352,8 +354,11 @@ class _RenderFixedBottomBarVisibility extends _RenderBottomBarVisibility {
/// Intended to be used as the [SheetContentScaffold.bottomBar].
///
/// The following example shows the [StickyBottomBarVisibility],
/// which keeps the enclosed [BottomAppBar] always visible including
/// when the onscreen keyboard is open.
/// which keeps the enclosed [BottomAppBar] always visible regardless
/// of the sheet position. You may want to use the
/// [ResizeScaffoldBehavior.avoidBottomInset] with setting `maintainBottomBar`
/// to true to keep the bottom bar visible even when the onscreen keyboard
/// is open.
///
/// {@template StickyBottomBarVisibility:example}
/// ```dart
Expand Down Expand Up @@ -496,7 +501,7 @@ class _RenderAnimatedBottomBarVisibility extends _RenderBottomBarVisibility {
/// the [curve].
///
/// The following example shows the [ConditionalStickyBottomBarVisibility],
/// which keeps the enclosed [BottomAppBar] visible as long as the onscreen
/// which keeps the enclosed [BottomAppBar] visible as long as the keyboard
/// is hidden (`insets.bottom == 0`) and at least 50% of the sheet is visible.
///
/// ```dart
Expand Down
2 changes: 1 addition & 1 deletion package/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: smooth_sheets
description: Sheet widgets with smooth motion and great flexibility. Also supports nested navigation in both imperative and declarative ways.
version: 0.4.0
version: 0.4.1
repository: https://github.com/fujidaiti/smooth_sheets

environment:
Expand Down
Loading