Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xsahil03x/fancy_on_boarding
Fancy OnBoarding Screen Library
https://github.com/xsahil03x/fancy_on_boarding
dart flutter flutter-package flutter-ui google-flutter hacktoberfest library navigation on-boarding
Last synced: 3 days ago
JSON representation
Fancy OnBoarding Screen Library
- Host: GitHub
- URL: https://github.com/xsahil03x/fancy_on_boarding
- Owner: xsahil03x
- License: mit
- Created: 2018-08-05T13:35:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T08:01:36.000Z (over 1 year ago)
- Last Synced: 2025-01-11T08:07:42.700Z (10 days ago)
- Topics: dart, flutter, flutter-package, flutter-ui, google-flutter, hacktoberfest, library, navigation, on-boarding
- Language: Dart
- Homepage: https://pub.dartlang.org/packages/fancy_on_boarding
- Size: 4.2 MB
- Stars: 359
- Watchers: 12
- Forks: 82
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 👏 FancyOnBoarding
[](https://saythanks.io/to/xsahil03x) [](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fxsahil03x%2Ffancy_on_boarding)
A Fancy OnBoarding Screen Library for Easy and Quick Usage.
* Checkout the Original Author : [](https://github.com/matthew-carroll/flutter_ui_challenge_material_page_reveal)
* Checkout the Original Designer : [](https://github.com/Ramotion/paper-onboarding-android)
The source code is **100% Dart**, and everything resides in the [/lib](https://github.com/xsahil03x/fancy_on_boarding/tree/master/lib) folder.
### Show some :heart: and star the repo to support the project
[](https://github.com/xsahil03x/fancy_on_boarding) [](https://github.com/xsahil03x/fancy_on_boarding/fork) [](https://github.com/xsahil03x/fancy_on_boarding) [](https://github.com/xsahil03x/fancy_on_boarding)
[](https://twitter.com/xsahil03x)
[](https://opensource.org/licenses/MIT)
[](https://github.com/xsahil03x/fancy_on_boarding/blob/master/LICENSE)
[](https://travis-ci.com/xsahil03x/fancy_on_boarding)
[](https://codecov.io/gh/xsahil03x/fancy_on_boarding)
### GIF
## 💻 Installation
In the `dependencies:` section of your `pubspec.yaml`, add the following line:
[](https://pub.dartlang.org/packages/fancy_on_boarding)
```
fancy_on_boarding:
```
## ❔ Usage
### Import this class
```dart
import 'package:fancy_on_boarding/fancy_on_boarding.dart';
```
### Create a List of PageModel
```dart
final pageList = [
PageModel(
color: const Color(0xFF678FB4),
heroImagePath: 'assets/png/hotels.png',
title: Text('Hotels',
style: TextStyle(
fontWeight: FontWeight.w800,
color: Colors.white,
fontSize: 34.0,
)),
body: Text('All hotels and hostels are sorted by hospitality rating',
textAlign: TextAlign.center,
style: TextStyle(
color: Colors.white,
fontSize: 18.0,
)),
iconImagePath: 'assets/png/key.png'),
PageModel(
color: const Color(0xFF65B0B4),
heroImagePath: 'assets/png/banks.png',
title: Text('Banks',
style: TextStyle(
fontWeight: FontWeight.w800,
color: Colors.white,
fontSize: 34.0,
)),
body: Text(
'We carefully verify all banks before adding them into the app',
textAlign: TextAlign.center,
style: TextStyle(
color: Colors.white,
fontSize: 18.0,
)),
iconImagePath: 'assets/png/wallet.png'),
PageModel(
color: const Color(0xFF9B90BC),
heroImagePath: 'assets/png/stores.png',
title: Text('Store',
style: TextStyle(
fontWeight: FontWeight.w800,
color: Colors.white,
fontSize: 34.0,
)),
body: Text('All local stores are categorized for your convenience',
textAlign: TextAlign.center,
style: TextStyle(
color: Colors.white,
fontSize: 18.0,
)),
icon: Icon(
Icons.shopping_cart,
color: const Color(0xFF9B90BC),
),
),
// SVG Pages Example
PageModel(
color: const Color(0xFF678FB4),
heroImagePath: 'assets/svg/hotel.svg',
title: Text('Hotels SVG',
style: TextStyle(
fontWeight: FontWeight.w800,
color: Colors.white,
fontSize: 34.0,
)),
body: Text('All hotels and hostels are sorted by hospitality rating',
textAlign: TextAlign.center,
style: TextStyle(
color: Colors.white,
fontSize: 18.0,
)),
iconImagePath: 'assets/svg/key.svg',
heroImageColor: Colors.white),
PageModel(
color: const Color(0xFF65B0B4),
heroImagePath: 'assets/svg/bank.svg',
title: Text('Banks SVG',
style: TextStyle(
fontWeight: FontWeight.w800,
color: Colors.white,
fontSize: 34.0,
)),
body: Text(
'We carefully verify all banks before adding them into the app',
textAlign: TextAlign.center,
style: TextStyle(
color: Colors.white,
fontSize: 18.0,
)),
iconImagePath: 'assets/svg/cards.svg',
heroImageColor: Colors.white),
PageModel(
color: const Color(0xFF9B90BC),
heroImagePath: 'assets/svg/store.svg',
title: Text('Store SVG',
style: TextStyle(
fontWeight: FontWeight.w800,
color: Colors.white,
fontSize: 34.0,
)),
body: Text('All local stores are categorized for your convenience',
textAlign: TextAlign.center,
style: TextStyle(
color: Colors.white,
fontSize: 18.0,
)),
iconImagePath: 'assets/svg/cart.svg',
),
];
```
### Pass it into the FancyOnBoarding widget
```dart
@override
Widget build(BuildContext context) {
return Scaffold(
body: FancyOnBoarding(
doneButtonText: "Done",
skipButtonText: "Skip",
pageList: pageList,
onDoneButtonPressed: () =>
Navigator.of(context).pushReplacementNamed('/mainPage'),
onSkipButtonPressed: () =>
Navigator.of(context).pushReplacementNamed('/mainPage'),
),
);
}
```
## 🎨 Customization and Attributes
#### FancyOnBoarding attributes
Attribute Name
Example Value
Description
pageList
List<PageModel>
The list of pages to be displayed
onDoneButtonPressed
(){}
Function to be called on pressing done button
onSkipButtonPressed
(){}
Function to be called on pressing skip button
doneButtonText
"Let's Go"
Done button text content defaults to "Done"
skipButtonText
"Skip"
Skip button text content defaults to "Skip"
showSkipButton
true
Skip button should be visible or not. Defaults to true
bottomMargin
8.0
Indicator bottom margin. Defaults to 8.0
doneButton
Button(onPressed:(){},child:Text('Done'))
Custom DoneButton. Will replace default doneButton if provided
skipButton
Button(onPressed:(){},child:Text('Skip'))
Custom SkipButton. Will replace default doneButton if provided
#### PageModel attributes
Attribute Name
Example Value
Description
color
Color(0xFF65B0B4)
The background color of the page
heroAssetPath
'assets/banks.png'
The main onboarding image
heroAssetColor
Color(0xFF65B0B4)
Main onboarding image color
title
Text('Banks')
Title of the page
body
Text('We carefully verify all banks before adding them into the app')
Body of the page
iconAssetPath
'assets/wallet.png'
Icon for the floating bubble
icon
Icon(Icons.shopping_cart)
Icon for the floating bubble, Will replace 'iconAssetPath' if provided
# 👍 How to Contribute
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request
# 📃 License
Copyright (c) 2018 Sahil Kumar
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## Getting Started
For help getting started with Flutter, view our online [documentation](https://flutter.io/).
For help on editing package code, view the [documentation](https://flutter.io/developing-packages/).