Giter Club home page Giter Club logo

awesome_side_sheet's Introduction

Awesome Side Sheet

moesaid - mohamed s abdrabou - flutter awesome side sheet - sidesheet

License

Awesome Side Sheet is a Flutter package that provides a flexible and customizable side sheet implementation for your Flutter applications. It allows you to easily integrate a sliding panel or drawer with various features and customization options.

Features

  • Slide-in side sheet with configurable width and position.
  • Customizable appearance with options for background color, text color, button colors, and more.
  • Support for header, body, and footer sections within the side sheet.
  • Optional actions, back button, close button, and dividers for improved flexibility.
  • Smooth transition animations for a polished user interface.

Getting Started

To use this package in your Flutter project, add it to your pubspec.yaml file:

dependencies:
  awesome_side_sheet: ^latest_version

Then, run:

$ flutter pub get

For detailed information on how to integrate packages into your Flutter project, refer to the Flutter documentation on dependencies.

Usage

Here is a simple example demonstrating how to use the Awesome Side Sheet:

import 'package:awesome_side_sheet/awesome_side_sheet.dart';

aweSideSheet(context: context);

For more detailed examples and use cases, check the /example folder in the package repository.

exposed api

  // required
  required BuildContext context,
  required SheetPosition sheetPosition,

  // widgets
  Widget? body,
  Widget? footer,
  Widget? header,

  // bools
  bool barrierDismissible = true,
  bool showBackButton = true,
  bool showCloseButton = true,
  bool showActions = true,
  bool showFooterDivider = true,
  bool showHeaderDivider = true,
  bool showSideDivider = true,
  bool safeAreaTop = true,
  bool safeAreaBottom = true,

  // strings
  String confirmActionText = 'Save',
  String cancelActionText = 'Cancel',
  String? title,

  // duration
  Duration? transitionDuration,

  // doubles
  double sheetWidth = 400 <- default,
  double? borderRadius,

  // Colors
  Color? backgroundColor,
  surfaceTintColor,
  textColor,
  iconColor,
  dividerColor,
  confirmButtonBgColor,
  confirmButtonTextColor,
  cancelButtonBgColor,
  cancelButtonTextColor,

  // callbacks
  void Function()? onConfirm,
  void Function()? onCancel,
  void Function()? onDismiss,
  void Function()? onClose,

Additional Information

  • If you encounter any issues or have suggestions for improvement, please file an issue.
  • Contributions are welcome! Feel free to open pull requests to help enhance this package.
  • Enjoy using the Awesome Side Sheet in your Flutter applications!

License

awesome_side_sheet is licensed under the MIT License. See LICENSE for more information.

credits

awesome_side_sheet created by Mohamed S Abdrabou

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.