Import
import 'package:flutter/widgets.dart';
import 'package:fluttyui/fluttyui.dart' as ui;API Reference
The declarations below match the current FluttyUI source. Types are shown without the optional ui. import prefix.
Onboarding
const Onboarding({
super.key,
required this.pages,
required this.onCompleted,
this.onSkip,
this.onPageChanged,
this.initialPage = 0,
this.nextLabel = 'Continue',
this.completeLabel = 'Get started',
this.backLabel = 'Back',
this.skipLabel = 'Skip',
this.showBack = true,
this.showProgress = true,
this.backgroundColor,
this.activeIndicatorColor,
this.inactiveIndicatorColor,
this.contentPadding = const EdgeInsets.symmetric(horizontal: 24, vertical: 16),
this.footerPadding = const EdgeInsets.symmetric(horizontal: 24),
this.useSafeArea = true,
this.animationDuration,
});| Parameter | Type | Required | Default |
|---|---|---|---|
key | Key? | No | null |
pages | List<OnboardingPage> | Yes | — |
onCompleted | VoidCallback | Yes | — |
onSkip | VoidCallback? | No | null |
onPageChanged | ValueChanged<int>? | No | null |
initialPage | int | No | 0 |
nextLabel | String | No | 'Continue' |
completeLabel | String | No | 'Get started' |
backLabel | String | No | 'Back' |
skipLabel | String | No | 'Skip' |
showBack | bool | No | true |
showProgress | bool | No | true |
backgroundColor | Color? | No | null |
activeIndicatorColor | Color? | No | null |
inactiveIndicatorColor | Color? | No | null |
contentPadding | EdgeInsetsGeometry | No | const EdgeInsets.symmetric(horizontal: 24, vertical: 16) |
footerPadding | EdgeInsetsGeometry | No | const EdgeInsets.symmetric(horizontal: 24) |
useSafeArea | bool | No | true |
animationDuration | Duration? | No | null |
Application Setup
Place components under FluttyApp to provide theme, navigation, localization, and overlay defaults. Use theme tokens for shared appearance settings.
Source
lib/src/widgets/navigation/onboarding/onboarding.dart
This reference is generated from the Onboarding declaration in the FluttyUI core checkout. The component catalog lists the other available building blocks.

