flutter_onboard

Description:

flutter onboard

OnBoard Screen For Flutter #
An awesome OnBoard ui for both android and ios

Installing #
dependencies:
flutter_onboard: ^2.0.0
copied to clipboard
Basic Usage #
import 'package:flutter_onboard/flutter_onboard.dart';
copied to clipboard
OnBoard(
onBoardData: onBoardData ,
pageController: pageController,
// Either Provide onSkip Callback or skipButton Widget to handle skip state
onSkip: () {
print('skipped');
},
// Either Provide onDone Callback or nextButton Widget to handle done state
onDone: () {
print('done tapped');
},
)
copied to clipboard
OnBoardModel Example: #
final List<OnBoardModel> onBoardData = [
const OnBoardModel(
title: "Set your own goals and get better",
description: "Goal support your motivation and inspire you to work harder",
imgUrl: "assets/images/weight.png",
),
const OnBoardModel(
title: "Track your progress with statistics",
description:
"Analyse personal result with detailed chart and numerical values",
imgUrl: 'assets/images/graph.png',
),
const OnBoardModel(
title: "Create photo comparisons and share your results",
description:
"Take before and after photos to visualize progress and get the shape that you dream about",
imgUrl: 'assets/images/phone.png',
),
];
copied to clipboard
Custom Usage #



Properties
Required
Description




onBoardData
true
[List<OnBoardModel>] Data for OnBoard


onSkip
false
[VoidCallback], when skip action performed


onDone
false
[VoidCallback], when done action performed


titleStyles
false
[TextStyles], used to style title text


descriptionStyles
false
[TextStyles], used to style description text


imageWidth
false
[double] OnBoard Image width


imageHeight
false
[double] OnBoard Image height


skipButton
false
[Widget] custom skip button


nextButton
false
[Widget] custom next/done button


pageController
true
[PageController] controller for PageView


duration
false
[Duration] Animation Duration of one screen to another


curve
false
[Curve] Animation Curve of one screen to another


pageIndicatorStyle
false
[PageIndicatorStyle] Configure width, size, active & inactive color of pageIndicator



Custom Usage Example: #

Note: for custom usage in order to access [OnBoardState] example uses provider package

import 'package:flutter/material.dart';
import 'package:flutter_onboard/flutter_onboard.dart';

void main() {
runApp(App());
}

class App extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
home: HomeScreen(),
);
}
}

class HomeScreen extends StatelessWidget {
final PageController _pageController = PageController();
@override
Widget build(BuildContext context) {
return Scaffold(
body: OnBoard(
pageController: _pageController,
// Either Provide onSkip Callback or skipButton Widget to handle skip state
onSkip: () {
// print('skipped');
},
// Either Provide onDone Callback or nextButton Widget to handle done state
onDone: () {
// print('done tapped');
},
onBoardData: onBoardData,
titleStyles: const TextStyle(
color: Colors.deepOrange,
fontSize: 18,
fontWeight: FontWeight.w900,
letterSpacing: 0.15,
),
descriptionStyles: TextStyle(
fontSize: 16,
color: Colors.brown.shade300,
),
pageIndicatorStyle: const PageIndicatorStyle(
width: 100,
inactiveColor: Colors.deepOrangeAccent,
activeColor: Colors.deepOrange,
inactiveSize: Size(8, 8),
activeSize: Size(12, 12),
),
// Either Provide onSkip Callback or skipButton Widget to handle skip state
skipButton: TextButton(
onPressed: () {
// print('skipButton pressed');
},
child: const Text(
"Skip",
style: TextStyle(color: Colors.deepOrangeAccent),
),
),
// Either Provide onDone Callback or nextButton Widget to handle done state
nextButton: OnBoardConsumer(
builder: (context, ref, child) {
final state = ref.watch(onBoardStateProvider);
return InkWell(
onTap: () => _onNextTap(state),
child: Container(
width: 230,
height: 50,
alignment: Alignment.center,
decoration: BoxDecoration(
borderRadius: BorderRadius.circular(30),
gradient: const LinearGradient(
colors: [Colors.redAccent, Colors.deepOrangeAccent],
),
),
child: Text(
state.isLastPage ? "Done" : "Next",
style: const TextStyle(
color: Colors.white,
fontWeight: FontWeight.bold,
),
),
),
);
},
),
),
);
}

void _onNextTap(OnBoardState onBoardState) {
if (!onBoardState.isLastPage) {
_pageController.animateToPage(
onBoardState.page + 1,
duration: const Duration(milliseconds: 250),
curve: Curves.easeInOutSine,
);
} else {
//print("nextButton pressed");
}
}
}

final List<OnBoardModel> onBoardData = [
const OnBoardModel(
title: "Set your own goals and get better",
description: "Goal support your motivation and inspire you to work harder",
imgUrl: "assets/images/weight.png",
),
const OnBoardModel(
title: "Track your progress with statistics",
description:
"Analyse personal result with detailed chart and numerical values",
imgUrl: 'assets/images/graph.png',
),
const OnBoardModel(
title: "Create photo comparision and share your results",
description:
"Take before and after photos to visualize progress and get the shape that you dream about",
imgUrl: 'assets/images/phone.png',
),
];

copied to clipboard
for more info check example
TODO #

Add more custom page indicators.
Writing tests


Need more features feel free to raise an issue

License #
This project is licensed under the MIT - see the LICENSE file for details