Sheetify

https://pub.dev/packages/sheetify
Admin
Sheetify is a Flutter package that provides customizable bottom sheet widgets with snapping...
Tokens:3,897
Snippets:58
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### MultiStateSheet Usage Example

Source: https://pub.dev/packages/sheetify

Example demonstrating how to use MultiStateSheet with a custom controller, snapping behavior, state mapper, and various UI components.

```dart
import 'package:sheetify/sheetify.dart';

final controller = MultiStateSheetController<YourStateMapper>(
  behavior: YourSnappingBehavior(),
  stateMapper: YourStateMapper(),
);

MultiStateSheet<YourStateMapper>(
  scrollController: controller,
  barrierColorDelegate: YourStateMapper.barrierColorDelegate,
  resizeToAvoidViewPadding: true,
  hitTestBehavior: HitTestBehavior.opaque,
  backgroundColor: Colors.white,
  topHeader: YourAnimatedHeader(),
  header: YourHeader(),
  footer: YourFooter(),
  outsideOpacityDelegate: YourStateMapper.outsideOpacityDelegate,
  outside: YourOutsideWidget(),
  sliver: DecoratedSliver(
    decoration: BoxDecoration(
      color: Colors.grey.shade300,
    ),
    sliver: SliverList(
      delegate: SliverChildBuilderDelegate(
        (context, index) => ListTile(title: Text('Item #\$index')),
        childCount: 20,
      ),
    ),
  ),
)

```

--------------------------------

### SliverChildBuilderDelegate Example

Source: https://pub.dev/packages/sheetify/example

This snippet demonstrates the usage of SliverChildBuilderDelegate within a scrollable widget to build a list of placeholder content. It specifies the builder function and the total number of children.

```dart
delegate: SliverChildBuilderDelegate(
  (context, index) =>
      PlaceholderContainer(text: 'Content $index'),
  childCount: 20,
),
)
```

--------------------------------

### Create FadingHeader with SheetAnimatedWidget

Source: https://pub.dev/packages/sheetify

Extend SheetAnimatedWidget to build animated widgets that react to sheet state and interpolation. This example creates a fading header.

```dart
class FadingHeader extends SheetAnimatedWidget<FourStateSheet> {
  const FadingHeader({super.key}) : super(defaultState: FourStateSheet.halfOpen);

  @override
  Widget build(BuildContext context, FourStateSheet state, double interpolation) {
    return Opacity(
      opacity: (interpolation),
      child: Text('My Header'),
    );
  }
}
```

--------------------------------

### Declare Sheetify Dependency in pubspec.yaml

Source: https://pub.dev/packages/sheetify/install

This is an example of how the sheetify dependency will appear in your pubspec.yaml file after running `flutter pub add sheetify`.

```yaml
dependencies:
  sheetify: ^1.1.3
```

--------------------------------

### Import Sheetify Package in Dart Code

Source: https://pub.dev/packages/sheetify/install

Import the sheetify package into your Dart files to start using its widgets and functionalities.

```dart
import 'package:sheetify/sheetify.dart';
```

--------------------------------

### Create FadingHeader with SheetValueNotifierWidget

Source: https://pub.dev/packages/sheetify

Extend SheetValueNotifierWidget for animated widgets using ValueNotifier for state and interpolation. This example also creates a fading header using FadeTransition.

```dart
class FadingHeader extends SheetValueNotifierWidget<FourStateSheet> {
  const FadingHeader({super.key}) : super(defaultState: FourStateSheet.halfOpen);

  @override
  Widget build(BuildContext context, ValueNotifier<FourStateSheet> state, ValueNotifier<double> interpolation) {
    return FadeTransition(
      opacity: Animation.fromValueListenable(interpolation),
      child: Text('My Header'),
    );
  }
}
```

--------------------------------

### Initialize Sheetify Application

Source: https://pub.dev/packages/sheetify/example

Sets up the main application entry point and initializes the persistent safe area observer.

```dart
void main() {
  PersistentSafeAreaBottom.startObserving();

  runApp(const MyApp());
}
```

--------------------------------

### Implement StatefulSheetDelegate

Source: https://pub.dev/packages/sheetify/example

Calculates opacity based on the current sheet state and scroll position to manage visual transitions.

```dart
final outsideOpacityDelegate = StatefulSheetDelegate.func(
      (MultiStateSheetController<FourStateSheet> controller) {
    final isSheetCoversHalfOfTheScreen = controller.fraction > 0.4;
    final isSheetStateOpen = controller.state == FourStateSheet.open;
    final isSheetScrolledForHalfOfTheState = controller.interpolation > 0.4;

    final isFull = (!controller.isEnabled &&
            isSheetStateOpen &&
            isSheetScrolledForHalfOfTheState) ||
        isSheetCoversHalfOfTheScreen;

    return !isFull ? 1.0 : max(0.0, 1 - (controller.fraction - 0.4) * 9);
  });
```

--------------------------------

### Enable sheetify_lint plugin

Source: https://pub.dev/packages/sheetify_lint

Enable the custom_lint plugin in your analysis_options.yaml file to activate the linter rules.

```yaml
analyzer:
  plugins:
    - custom_lint

```

--------------------------------

### Build MultiStateSheet Widget

Source: https://pub.dev/packages/sheetify/example

Constructs the MultiStateSheet widget with custom header, footer, and interaction delegates.

```dart
return Center(
      child: Padding(
        padding: const EdgeInsets.symmetric(horizontal: 16),
        child: SizedBox(
          width: 600,
          child: MultiStateSheet<FourStateSheet>(
            scrollController: widget.controller,
            barrierColorDelegate: FourStateMapper.barrierColorDelegate,
            resizeToAvoidBottomPadding: true,
            hitTestBehavior: HitTestBehavior.opaque,
            backgroundColor: Colors.white,
            safeAreaColor: Colors.grey,
            topHeader: const AnimatedStateSheetWidgetTemplate(),
            header: header,
            footer: footer,
            outsideOpacityDelegate: outsideOpacityDelegate,
            outside: outside,
            sliver: DecoratedSliver(
              decoration: BoxDecoration(
                color: Colors.grey.shade300,
              ),
              sliver: SliverList(

```

--------------------------------

### SnappingBehavior API

Source: https://pub.dev/packages/sheetify

Defines the logic for where a MultiStateSheet should snap.

```APIDOC
## SnappingBehavior

### Description
Abstract class used by MultiStateSheetController to define snap points.

### Implementations
- **SizeSnappingBehavior** - Snaps to specific heights in logical pixels.
- **FractionSnappingBehavior** - Snaps to a percentage of the viewport height.
- **ComponentsSnappingBehavior** - Calculates snap points based on the height of header/footer/components.
- **MultiSnappingBehavior** - Composes multiple snapping models for complex sheet positions.
```

--------------------------------

### Configure MultiStateSheetController

Source: https://pub.dev/packages/sheetify/example

Defines the snapping behavior and state mapping for a multi-state bottom sheet controller.

```dart
MultiStateSheetController<FourStateSheet> createMultiStateSheetController() =>
    MultiStateSheetController(
      stateMapper: const FourStateMapper(),
      initialState: FourStateSheet.halfOpen,
      behavior: MultiSnappingBehavior(clipByHeader: false, models: [
        OffsetSnappingModel({50}),
        FractionSnappingModel({0}),
        SizeSnappingModel({350.0}),
        ComponentsSnappingModel(componentsDescriptions: [
          SnapComponent.merge(
            a: const SnapComponent.size(component: Components.header),
            b: const SnapComponent.size(component: Components.footer),
            merge: (a, b) => a + b,
          )
        ])
      ]),
    );
```

--------------------------------

### MultiStateSheet API

Source: https://pub.dev/packages/sheetify

A bottom sheet component that supports multiple predefined snap states, draggable behavior, and custom headers/footers.

```APIDOC
## MultiStateSheet

### Description
A bottom sheet that can snap between multiple predefined states. It supports draggable behavior, animated transitions, slivers, and custom headers/footers.

### Controller
- **MultiStateSheetController<StateType>** - Controls the state of the sheet, allowing programmatic snapping between states. Requires a SnappingBehavior and SheetStateMapper.
```

--------------------------------

### Add Sheetify Dependency

Source: https://pub.dev/packages/sheetify

Add the sheetify package to your pubspec.yaml file to include it in your project.

```yaml
dependencies:
  sheetify: ^1.1.3

```

--------------------------------

### Import Sheetify Package

Source: https://pub.dev/packages/sheetify

Import the sheetify package into your Dart file to use its widgets and controllers.

```dart
import 'package:sheetify/sheetify.dart';

```

--------------------------------

### Add sheetify_lint to dev dependencies

Source: https://pub.dev/packages/sheetify_lint

Add both custom_lint and sheetify_lint as dev dependencies in your pubspec.yaml file.

```yaml
dev_dependencies:
  custom_lint: ^0.8.0
  sheetify_lint: ^1.0.1

```

--------------------------------

### Implement ToggleSheet Widget

Source: https://pub.dev/packages/sheetify

Use the ToggleSheet widget to create collapsible sheets with custom headers, footers, and content. Requires a ToggleSheetController for state management. The barrier color can be dynamically controlled.

```dart
final controller = ToggleSheetController();

ToggleSheet(
  scrollController: controller,
  backgroundColor: Colors.white,
  safeAreaColor: Colors.white,
  barrierColorDelegate: ToggleSheetDelegate.func(
    (controller) => Colors.black.withOpacity(controller.interpolation * 0.6),
  ),
  hitTestBehavior: HitTestBehavior.opaque,
  topHeader: const SizedBox(
    height: 10,
    width: double.infinity,
    child: ColoredBox(color: Colors.amber),
  ),
  topHeaderOffset: 10,
  offsetOutsideWidgetByTopheader: false,
  header: YourHeader(),
  footer: SizedBox(
    height: 100,
    child: GestureDetector(
      onTap: () {
        controller.reset();
        Navigator.of(context).pop();
      },
      child: const PlaceholderContainer(text: 'Close'),
    ),
  ),
  content: [
    const PlaceholderContainer(text: 'Content 1'),
    const PlaceholderContainer(text: 'Content 2'),
  ],
)
```

--------------------------------

### Avoid constructing delegates in build() methods

Source: https://pub.dev/packages/sheetify_lint

Demonstrates the correct way to declare delegates as final fields outside the build() method, contrasting with the incorrect practice of creating them inside build().

```dart
// Good: declared outside build()
final barrierColorDelegate = ToggleSheetDelegate.func(...);

// Bad: inside build() method
ToggleSheetDelegate.func(...)

```

--------------------------------

### Add Sheetify Dependency to Flutter Project

Source: https://pub.dev/packages/sheetify/install

Use this command to add the sheetify package as a dependency in your Flutter project. This command automatically updates your pubspec.yaml file.

```bash
$ flutter pub add sheetify
```

--------------------------------

### ToggleSheet API

Source: https://pub.dev/packages/sheetify

A simplified bottom sheet component with two states: open and closed.

```APIDOC
## ToggleSheet

### Description
A simpler sheet with two states: open and closed. Useful for expandable widgets like menus, drawers, or bottom actions.

### Controller
- **ToggleSheetController** - Manages the state of a ToggleSheet, exposing open() and close() methods. Can be initialized with a ToggleSheetHeightModel to define maximum height constraints.
```
Tokens:
Raw