OSOnboardingScreen class

A customizable Flutter onboarding screen widget.

This widget allows you to create onboarding experiences with multiple pages. It uses a PageController to manage transitions between onboarding pages and offers customizable attributes for button texts, styles, and background color.

The OSOnboardingScreen supports two types of onboarding:

  • simple: Basic onboarding with skip and next buttons.
  • simpleWithProgressButton: Onboarding with a circular progress button.

Parameters:

  • pages: List of OnboardingModel representing the pages.
  • onDone: Callback function triggered when onboarding is completed.
  • onboardingType: The type of onboarding.
  • buttonSkipTitle: Text for the "Skip" button. Defaults to "Skip".
  • buttonDoneTitle: Text for the "Done" button. Defaults to "Get Started".
  • buttonNextTitle: Text for the "Next" button. Defaults to "Next".
  • styles: Customizable styles for onboarding.

Usage: Create an OSOnboardingScreen with a list of OnboardingModel pages and an onDone callback to handle when onboarding is completed. Customize styles using the optional OnboardingStyles parameter.

Inheritance

Constructors

OSOnboardingScreen.new({Key? key, required List<OnboardingModel> pages, required void onDone(), required OnboardingType onboardingType, String buttonSkipTitle = "Skip", String buttonDoneTitle = "Get Started", String buttonNextTitle = "Next", OnboardingStyles? styles})
const

Properties

buttonDoneTitle → String
final
buttonNextTitle → String
final
buttonSkipTitle → String
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onboardingType → OnboardingType
final
onDone → void Function()
final
pages → List<OnboardingModel>
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
styles → OnboardingStyles?
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<OSOnboardingScreen>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited