Skip to content

Commit

Permalink
Update resizable pane constructors docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stMerlHin committed Jul 11, 2023
1 parent ef98be5 commit b46ad8e
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions lib/src/layout/resizable_pane.dart
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ enum ResizableSide {
/// {@endtemplate}
class ResizablePane extends StatefulWidget {
/// Creates a [ResizablePane] with an internal [MacosScrollbar].
///
/// Consider going with [ResizablePane.noScrollBar] constructor if the internal
/// [MacosScrollbar] is useless or when dealing with widgets which do not
/// expose their scroll controllers.
/// {@macro resizablePane}.
const ResizablePane({
super.key,
Expand All @@ -55,8 +59,11 @@ class ResizablePane extends StatefulWidget {

/// Create a [ResizablePane] without an internal [MacosScrollbar].
///
/// Very useful when dealing with widgets which does not expose their scroll
/// controller or when not using the platform scroll bar is preferred.
/// Very useful when dealing with widgets which do not expose their scroll
/// controllers or when not using the platform scroll bar is preferred.
///
/// Consider going with the default constructor if showing [MacosScrollbar]
/// when scrolling the content of this widget is the expected behaviour.
/// {@macro resizablePane}.
const ResizablePane.noScrollBar({
super.key,
Expand Down

0 comments on commit b46ad8e

Please sign in to comment.