custom_onboard 0.0.3

A Flutter package for creating customizable onboarding screens with ease. Supports animations, images, and text to guide users through app features.

example/lib/main.dart

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

/// The entry point of the application.
void main() {
  runApp(const MyApp());
}

/// The root widget of the application.
class MyApp extends StatelessWidget {
  /// Creates an instance of `MyApp`.
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Custom Onboard',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(),
    );
  }
}

/// The home page of the application that displays the onboarding screens.
class MyHomePage extends StatefulWidget {
  /// Creates an instance of `MyHomePage`.
  const MyHomePage({super.key});

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

/// The state for `MyHomePage` that manages onboarding functionality.
class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: CustomOnboard(
        pages: [
          PageModel(
            title: "Onboarding 1",
            body:
                "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text",
            imagePath: "assets/images/onboard1.png",
          ),
          PageModel(
            title: "Onboarding 2",
            body:
                "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s.",
            imagePath: "assets/images/onboard2.png",
          ),
          PageModel(
            title: "Onboarding 3",
            body:
                "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
            imagePath: "assets/images/onboard3.png",
          ),
        ],

        /// The text displayed on the finish button.
        finishButtonText: "Get Started",

        /// Callback function when onboarding is completed.
        onFinishClick: () {
          debugPrint('Onboarding completed');
          // Navigate to your desired page here.
          // Example: Navigator.pushNamed(context, '/your_desired_page');
        },

        /// Callback function when the onboarding is skipped.
        onSkipClick: () {
          debugPrint('Onboarding skipped');
          // Navigate to your desired page here.
          // Example: Navigator.pushNamed(context, '/your_desired_page');
        },
      ),
    );
  }
}