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.

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

Update YaruMasterDetailPage comments #705

Merged
merged 2 commits into from
Jun 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import 'yaru_master_detail_page.dart';

/// Layout delegate interface which controls a [YaruMasterDetailPage] pane width.
/// Layout delegate interface which controls a [YaruMasterDetailPage] pane width and resizing capacity.
abstract class YaruMasterDetailPaneLayoutDelegate {
const YaruMasterDetailPaneLayoutDelegate();

Expand Down
5 changes: 2 additions & 3 deletions lib/src/widgets/master_detail/yaru_master_detail_page.dart
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@ typedef YaruAppBarBuilder = PreferredSizeWidget? Function(BuildContext context);
/// A responsive master-detail page.
///
/// [YaruMasterDetailPage] automatically switches between portrait and landscape
/// modes using [kYaruMasterDetailBreakpoint] by default as a breakpoint width.
/// mode depending on [layoutDelegate].
///
/// ```dart
/// YaruMasterDetailPage(
/// leftPaneWidth: 280,
/// length: 8,
/// appBar: AppBar(title: const Text('Master')),
/// tileBuilder: (context, index, selected) => YaruMasterTile(
Expand Down Expand Up @@ -85,7 +84,7 @@ class YaruMasterDetailPage extends StatefulWidget {
/// A builder that is called if there are no pages to display.
final WidgetBuilder? emptyBuilder;

/// Specifies the initial width of left pane.
/// Controls the width and resizing capacity of the left pane.
final YaruMasterDetailPaneLayoutDelegate layoutDelegate;

/// An optional custom AppBar for the left pane.
Expand Down