From 28176458a8d1488fed5a3aaa09d749d24f039bd1 Mon Sep 17 00:00:00 2001 From: Akshath Jain Date: Thu, 2 Apr 2020 01:05:13 -0400 Subject: [PATCH] added beta warnings --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c34e5de..77c9a84 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ There are several options that allow for more control: | `body` | The Widget that lies underneath the sliding panel. This Widget automatically sizes itself to fill the screen. | | `minHeight` | The height of the sliding panel when fully collapsed. | | `maxHeight` | The height of the sliding panel when fully open. | -| `snapPoint` [beta] | A point between `minHeight` and `maxHeight` that the panel snaps to while animating. A fast swipe on the panel will disregard this point and go directly to the open/close position. This value is represented as a percentage of the total animation distance (`maxHeight` - `minHeight`), so it must be between 0.0 and 1.0, exclusive. | +| `snapPoint` [beta] | NOTE: This feature is still in beta and may have some problems. Please open an issue on [GitHub](https://github.com/akshathjain/sliding_up_panel) if you encounter something unexpected.

A point between `minHeight` and `maxHeight` that the panel snaps to while animating. A fast swipe on the panel will disregard this point and go directly to the open/close position. This value is represented as a percentage of the total animation distance (`maxHeight` - `minHeight`), so it must be between 0.0 and 1.0, exclusive. | | `border` | A border to draw around the sliding panel sheet. | | `borderRadius` | If non-null, the corners of the sliding panel sheet are rounded by this. | | `boxShadow` | A list of shadows cast behind the sliding panel sheet. | @@ -443,7 +443,7 @@ At times, it can be useful to manually change the state of the `SlidingUpPanel`. |`hide()`| `Future` | Hides the sliding panel (i.e. is invisible) | |`show()`| `Future` | Shows the sliding panel in its collapsed state (i.e. "un-hide" the sliding panel) | |`animatePanelToPosition(double value, {Duration duration, Curve curve = Curves.linear})`| `Future` | Animates the panel position to the value. The value must between 0.0 and 1.0 where 0.0 is fully collapsed and 1.0 is completely open. (optional) `duration` specifies the time for the animation to complete. (optional) `curve` specifies the easing behavior of the animation. | -|`animatePanelToSnapPoint(double value, {Duration duration, Curve curve = Curves.linear})` [beta]| `Future` | Animates the panel position to the snap point. Requires that the SlidingUpPanel `snapPoint` property is not null. (optional) `duration` specifies the time for the animation to complete. (optional) `curve` specifies the easing behavior of the animation. | +|`animatePanelToSnapPoint(double value, {Duration duration, Curve curve = Curves.linear})` [beta]| `Future` | NOTE: This feature is still in beta and may have some problems. Please open an issue on [GitHub](https://github.com/akshathjain/sliding_up_panel) if you encounter something unexpected.

Animates the panel position to the snap point. Requires that the SlidingUpPanel `snapPoint` property is not null. (optional) `duration` specifies the time for the animation to complete. (optional) `curve` specifies the easing behavior of the animation. | ```dart