Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.25 KB

README.md

File metadata and controls

68 lines (53 loc) · 2.25 KB
Raw

fancy_bottom_bar

A different take on your standard bottom app bar. Inspired by https://dribbble.com/shots/6957731-Reader-app-tab-bar

FancyBottomBar

Demo Gif

Getting Started

Add the plugin:

dependencies:
  ...
  fancy_bottom_bar: ^0.0.1

Basic Usage

Adding the widget to a Scaffold

bottomNavigationBar: FancyBottomBar(
     items: [
              FancyBottomItem(title: Text("Home"), icon: Icon(Icons.home)),
              FancyBottomItem(title: Text("Connect"), icon: Icon(Icons.usb)),
              FancyBottomItem(title: Text("Profile"), icon: Icon(Icons.person))
    ],
    onItemSelected: (i) => setState(() => selectedPos = i),
    selectedPosition: selectedPos,
)

FancyBottomBar

required

items -> List of FancyBottomItem objects
onItemSelected -> Function to handle a tap selection change, receives an int
selectedPosition -> The currently selected position

optional

height -> The height of the FancyBottomBar, defaults to 64
elevation -> The elevation for the FancyBottomBar, defaults to 8
bgColor -> The bottom app bar's background color, defaults to theTheme's bottomAppBarColor
indicatorColor -> The tiny circle indicator color, defaults to Colors.black
selectedColor -> The pulsing circle's color, defaults to theTheme's accentColor

FancyBottomItem

title -> The widget to be used as the Title for this tab, usually a Text Widget
icon -> The widget to be used as the Icon for this tab, usually an Icon Widget

Contributing

Contributions are always welcome, feel free to open a PR.

License


Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.