搜索插件、代码仓与 APP 分类

collapsible_sidebar 封面
插件详情v2.0.7

collapsible_sidebar

一个用于实现 Material Design 的可折叠侧边栏,适用于 Flutter 应用。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
2430
喜欢数
370
Pub 分数
140

安装插件

flutter pub add collapsible_sidebar

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一个符合 Material Design 指南的可折叠侧边栏 Flutter 包。它支持在展开和折叠状态之间实现平滑过渡,非常适合响应式应用中的导航。该侧边栏支持自定义内容、图标、标签以及跨平台的自适应行为。专为需要高效利用空间同时保持直观导航的应用设计。使用极少的设置即可无缝集成到现有的 Flutter 项目中。

适合场景

  • 响应式仪表板界面
  • 移动和桌面应用程序导航
  • 节省空间的用户界面布局
  • 符合 Material Design 的侧边栏
  • 跨平台应用程序

主要特点

  • Material Design 兼容性
  • 平滑的展开/折叠动画
  • 可自定义的内容和样式
  • 跨平台支持(Android、iOS、Web、macOS、Windows、Linux)
  • 与 MaterialApp 的轻松集成

适合对象

  • 开发响应式仪表板的开发者
  • 遵循材料设计原则的团队
  • 需要自适应导航的应用程序
  • 跨平台 Flutter 项目
  • UI设计师优先考虑可用性

使用建议

  • 需要适当的布局约束以实现最佳显示
  • 可能需要为非 Material 主题添加额外的样式
  • 大型内容列表带来的性能影响
  • 超出基本结构的自定义功能有限
  • 最适合具有中等导航项的应用程序

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

collapsible_sidebar


A collapsible sidebar for Flutter apps implementing the Material Design.

responsive-ui

🌟 Version 2.0.7 ✨


Features

  • Material Design
  • Pre-built customizable tile widgets (CollapsibleItems)
  • Smooth Animation
  • Supports both LTR & RTL languages
  • Supports MULTI-LEVEL Menu
  • Alert Badges on CollapsibleItems

Supported platforms

  • Flutter Android
  • Flutter iOS
  • Flutter web
  • Flutter desktop

Contributors

A big thank you to all the contributors without whom this project would be impossible to maintain and enhance. 👏👏👏

Live preview

https://drunkonbytes.github.io/flutter_collapsible_sidebar

Note: this page is built with flutter-web. For a better user experience, please use a mobile device to open this link.

Installation

Add collapsible_sidebar: ^2.0.7 to your pubspec.yaml dependencies. And import it:

import 'package:collapsible_sidebar/collapsible_sidebar.dart';

How to use

  1. Create a list of CollapsibleItems named _items (or whatever fancy name you like)
For a collapsible item with sub-items to be the default selected item MARK ALL OF ITS SUB-ITEMS WITH THE isSelected: true property.
List<CollapsibleItem> get _items {
    return [
      CollapsibleItem(
          text: 'Shop',
          iconImage: AssetImage("assets/shop_icon.png"), //`iconImage` has priority over `icon` property
          icon: Icons.ac_unit,
          onPressed: () => setState(() => _headline = 'Shop'),
          onHold: () => ScaffoldMessenger.of(context).showSnackBar(
              SnackBar(content: const Text("Shop"))
          ),
          isSelected: true,
          subItems: [
            CollapsibleItem(
              text: 'Cart',
              icon: Icons.shopping_cart,
              onPressed: () => setState(() => _headline = 'Cart'),
              onHold: () => ScaffoldMessenger.of(context).showSnackBar(
                  SnackBar(content: const Text("Cart"))
              ),
              isSelected: true,
            )
          ]
      ),
      CollapsibleItem(
        text: 'Dashboard',
        badgeCount: 7,
        icon: Icons.assessment,
        onPressed: () => setState(() => _headline = 'DashBoard'),
        onHold: () => ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(content: const Text("DashBoard"))
        ),
      ),
      CollapsibleItem(
        text: 'Ice-Cream',
        icon: Icons.icecream,
        onPressed: () => setState(() => _headline = 'Ice-Cream'),
        onHold: () => ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(content: const Text("Ice-Cream"))
        ),
      ),
      CollapsibleItem(
        text: 'Search',
        icon: Icons.search,
        onPressed: () => setState(() => _headline = 'Search'),
        onHold: () => ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(content: const Text("Search"))
        ),
      ),
    ];
  }
  1. Define the body of the app (the widget where the main working of the app will be) and name it say _body.
Widget _body(Size size, BuildContext context) {
    return Container(
      height: double.infinity,
      width: double.infinity,
      color: Colors.blueGrey[50],
      child: .........,
    );
  }
  1. Finally completely define the CollapsibleSidebar widget by adding the list of CollapsibleItems named _items, the body of the app named _body and the customizable parameters as needed:
CollapsibleSidebar(
  items: _items,
  avatarImg: _avatarImg,
  title: 'John Smith',
  body: _body(size, context),
)

Also you can use the isCollapsed condition depending how you want the state of the sidebar to change (collapsed/expanded) for example [size.width]

CollapsibleSidebar(
  isCollapsed: MediaQuery.of(context).size.width <= 800,
  items: _items,
  avatarImg: _avatarImg,
  title: 'John Smith',
  body: _body(size, context),
)

Parameters (customizable attributes)

Name Data Type Default Value Description
isCollapsed bool true can set condition to control state of sidebar (collapsed/expanded) on some property change
collapseOnBodyTap bool true flag to enable/disable tapping on the body of the app (area other than the sidebar) to collapse the sidebar
items List<CollapsibleItems> --- List of CollapsibleItems
showTitle bool true can set to false to hide title and avatar Image
title String --- Title of the Collapsible Sidebar
titleBack bool false set to 'true' to use a back icon instead of avatar picture
titleBackIcon Icons Icons.arrow_back the back icon is 'arrow_back' by default (customizable)
onTitleTap Function --- custom callback function called when title avatar or back icon is pressed
onHoverPointer SystemMouseCursors SystemMouseCursors.click the default hover mouse pointer is set to 'click' type by default (customizable)
textStyle TextStyle --- custom style for sidebar title
titleStyle TextStyle --- custom style for collapsible items text
toggleTitleStyle TextStyle --- custom style for toggle button title
avatarImg Image --- Image to be displayed
body Widget --- The main body of the app (the underlying main widget other than the sidebar)
height double double.infinity height of the Sidebar
minWidth double 80 Width of Sidebar when Collapsed
maxWidth double 270 Width of Sidebar when Expanded
borderRadius double 15 Radius of the borders
iconSize double 40 Size of the icons
customContentPaddingLeft double -1 Padding to the left of CollapsibleItems (keep value less than 0 for default padding)
toggleTitle String 'Collapse' title text of Toggle Button
toggleButtonIcon Icons Icons.chevron_right Icon of the Toggle button
backgroundColor Color Color(0xff2B3138) The background color
avatarBackgroundColor Color Color(0xff6A7886) The avatar background color
selectedIconBox Color Color(0xff2F4047) Color of Icon Box when selected
selectedIconColor Color Color(0xff4AC6EA) Color of Icon when selected
selectedTextColor Color Color(0xffF3F7F7) Color of text when selected
unselectedIconColor Color Color(0xff6A7886) Color of Icon when not selected
unselectedTextColor Color Color(0xffC0C7D0) Color of text when not selected
badgeBackgroundColor Color Color(0xffFF6767) Background color of badges on Collapsible Items
badgeTextColor Color Color(0xffF3F7F7) Badge Text color of badges on Collapsible Items
duration Duration Duration(milliseconds: 500) Animation duration for collapsed->expanded & vice-versa
curve Curves Curves.fastLinearToSlowEaseIn Animation curve for collapsed->expanded & vice-versa
screenPadding double 4 Padding to the screen
topPadding double 0 space between image avatar and icons
bottomPadding double 0 space between icons and toggle button
itemPadding double 10 space between collapsible items
customItemOffsetX double -1 X axis offset for collapsible items (keep value less than 0 for default offset)
fitItemsToBottom bool true fit all icons to the end of the space between image avatar and toggle button
showToggleButton bool true flag to enable/disable showing the toggle button
sidebarBoxShadow List<BoxShadow> [BoxShadow(color: Colors.blue, blurRadius: 10, spreadRadius: 0.01, offset: Offset(3, 3),),] Just like the "BoxDecoration" parameter of a "Container"

License


Apache 2.0

所属分类

源码仓库

使用此插件的项目