onboarding_view library
A modern, highly customizable onboarding package for Flutter.
Multiple visual styles (glassmorphism, Apple liquid glass, minimal, material, adaptive), rich page + indicator transitions, network / GIF / asset / icon / custom media, and zero-dependency local persistence.
Classes
- GlassContainer
- A reusable frosted-glass surface built on BackdropFilter.
- IndicatorConfig
- Fully describes how a PageIndicator looks and animates.
- JsonFileOnboardingStorage
-
Default, dependency-free OnboardingStorage that persists state to a local
JSON file via
dart:io. - MemoryOnboardingStorage
- A non-persistent OnboardingStorage kept entirely in memory.
- OnboardingActionButton
- A navigation button rendered according to OnboardingButtonConfig.variant.
- OnboardingAnimationConfig
- Timing for page + indicator animations.
- OnboardingAssetMedia
- Asset-backed OnboardingMedia.
- OnboardingButtonConfig
- Styling + labels for the skip / back / next / finish buttons.
- OnboardingController
- Drives an onboarding flow: page navigation, progress and lifecycle.
- OnboardingCustomMedia
- Custom-widget OnboardingMedia.
- OnboardingGifMedia
- GIF OnboardingMedia; resolves to an asset or network image.
- OnboardingIconMedia
- Icon-backed OnboardingMedia.
- OnboardingMedia
- A piece of visual content shown at the top of an onboarding page.
- OnboardingNetworkMedia
- Network-backed OnboardingMedia with loading + error handling.
- OnboardingPage
- Immutable data description of a single onboarding page.
- OnboardingStorage
- Contract for persisting onboarding completion state.
- OnboardingTheme
- The single source of truth for how an onboarding flow looks and animates.
- OnboardingView
- A fully-featured, highly customizable onboarding flow.
- PageIndicator
- Animated page indicator driven by a fractional page value so it stays in sync with the live swipe position, not just settled indices.
Enums
- IndicatorEffect
- The visual animation style of the page indicator.
- OnboardingButtonVariant
- Visual variant for the navigation buttons.
- OnboardingStyle
-
High-level visual presets. Each maps to a fully-formed
OnboardingThemeviaOnboardingTheme.fromStyle, which you can thencopyWithto tweak. - OnboardingSurfaceStyle
- How page content is framed. Derived from OnboardingStyle but exposed so custom themes can opt into the glass surface independently.
- OnboardingTransition
- Animated transition applied to each page as it scrolls.
Functions
-
applyOnboardingTransition(
{required OnboardingTransition transition, required double delta, required Widget child}) → Widget -
Wraps
childwith the giventransition, using the livedeltabetween this page's index and the current fractional scroll position.
Typedefs
- OnboardingButtonBuilder = Widget Function(BuildContext context, OnboardingController controller)
- Signature for replacing a default navigation button.