https://github.com/prajapatihet/flutter-walkthrough

Flutter-Walkthrough is a simple Flutter package that helps users create basic walkthrough screens with ease. Published on pub.dev, it offers a straightforward solution for onboarding new users into apps.
https://github.com/prajapatihet/flutter-walkthrough

dart dependency flutter library package

Last synced: 3 months ago
JSON representation

Flutter-Walkthrough is a simple Flutter package that helps users create basic walkthrough screens with ease. Published on pub.dev, it offers a straightforward solution for onboarding new users into apps.

• Host: GitHub
• URL: https://github.com/prajapatihet/flutter-walkthrough
• Owner: prajapatihet
• License: mit
• Created: 2024-04-07T16:35:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T03:47:30.000Z (about 2 years ago)
• Last Synced: 2025-01-23T01:44:40.371Z (over 1 year ago)
• Topics: dart, dependency, flutter, library, package
• Language: Dart
• Homepage:
• Size: 91.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# new_walkthrough

A new Flutter package for both android and iOS which helps developers in creating animated walkthrough of their app.

### Show some :heart: and star the repo to support the project

## Usage

[Example](https://github.com/prajapatihet/Flutter-Walkthrough/blob/main/example/example_app.dart)

To use this package :

* add the dependency to your [pubspec.yaml](https://github.com/prajapatihet/Flutter-Walkthrough/blob/main/pubspec.yaml) file.

```yaml

  dependencies:

    flutter:

      sdk: flutter

    new_walkthrough:

```

### How to use

```dart

class TestScreen extends StatelessWidget {

  

  /*here we have a list of walkthroughs which we want to have, 

  each walkthrough have a title,content and an icon.

  */

  final List list = [

    Walkthrough(

      title: "Title 1",

      content: "Content 1",

      imageIcon: Icons.restaurant_menu,

    ),

    Walkthrough(

      title: "Title 2",

      content: "Content 2",

      imageIcon: Icons.search,

    ),

    Walkthrough(

      title: "Title 3",

      content: "Content 3",

      imageIcon: Icons.shopping_cart,

    ),

    Walkthrough(

      title: "Title 4",

      content: "Content 4",

      imageIcon: Icons.verified_user,

    ),

  ];

  @override

  Widget build(BuildContext context) {

    //here we need to pass the list and the route for the next page to be opened after this.

    return new IntroScreen(

      list,

      new MaterialPageRoute(builder: (context) => new TestScreen()),

    );

  }

}

```

# Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

1.  Match coding style (braces, spacing, etc.) This is best achieved using `Reformat Code` feature of Android Studio `CMD`+`Option`+`L` on Mac and `CTRL` + `ALT` + `L` on Linux + Windows .

2.  If its a feature, bugfix, or anything please only change code to what you specify.

3.  Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)

4.  Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.

5.  Check for existing [issues](https://github.com/prajapatihet/Flutter-Walkthrough/issues) first, before filing an issue.

6.  Make sure you follow the set standard as all other projects in this repo do

7.  Have fun!

### Created & Maintained By

[Hetkumar Prajapati](https://github.com/prajapatihet)

# License

    Copyright 2024 Hetkumar Prajapati

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

## Getting Started

For help getting started with Flutter, view our online [documentation](https://flutter.io/).

For help on editing package code, view the [documentation](https://flutter.io/developing-packages/).