Merge pull request #3 from Iconica-Development/v0.0.2

V0.0.2

Author: Gorter-dev

CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.0.1
+## [0.0.2] - 16 September 2022
 
-* TODO: Describe initial release.
+* Initial release.

README.md

@@ -1,24 +1,40 @@
 [![pub package](https://img.shields.io/pub/v/[PACKAGE NAME ON PUB].svg)](https://github.com/Iconica-Development) [![Build status](URL TO REPO)](URL TO GITHUB ACTIONS) [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) 
 
-Short description of what your package is, why you created it. What issues it fixes and how it works. Also mention the available platforms
+# Introduction Widget
+Flutter Introduction Widget for showing a list of introduction pages on a single scrollable page or horizontal pageview.
 
-## Setup
+If nothing is provided a few default pages are shown with a simple description of the package.
 
-What setup steps are neccesarry and why>
 
-<details>
-<summary>PLATFORM</summary>
-    
-specific platform steps
+Supports all Flutter platforms.
 
-</details>
+## Usage
+
+To use this package, add `flutter_introduction_widget` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).
 
 ## How to use
 
-How can we use the package descibe the most common ways with examples in 
+Simple way to use the introduction widget:
 ```dart
- codeblocks
+Introduction(
+    introductionSettings: const IntroductionSettings(
+        buttonMode: IntroductionScreenButtonMode.Text,
+        showSkipButton: true,
+        showFinishButton: true,
+    ),
+    onComplete: () {
+        debugPrint('done!');
+    },
+    pages: [
+        IntroductionPage(title: 'Page1', text: 'hello'),
+        IntroductionPage(title: 'Page2', text: 'world'),
+        IntroductionPage(title: 'Page3', text: 'text'),
+    ],
+),
 ``` 
+### Example
+
+See [Example Code](example/lib/main.dart) for more info.
 
 ## Issues
 

example/lib/main.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:flutter_introduction_widget/flutter_introduction_widget.dart';
 
 void main() {
   runApp(const MaterialApp(home: FlutterIntroductionDemo()));
@@ -9,6 +10,25 @@ class FlutterIntroductionDemo extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    return const Scaffold(body: Text('FlutterIntroductionDemo'));
+    return Scaffold(
+      body: Theme(
+        data: Theme.of(context).copyWith(backgroundColor: Colors.amber),
+        child: Introduction(
+          introductionSettings: const IntroductionSettings(
+            buttonMode: IntroductionScreenButtonMode.Text,
+            showSkipButton: true,
+            showFinishButton: true,
+          ),
+          onComplete: () {
+            debugPrint('done!');
+          },
+          pages: [
+            IntroductionPage(title: 'Page1', text: 'hello'),
+            IntroductionPage(title: 'Page2', text: 'world'),
+            IntroductionPage(title: 'Page3', text: 'text'),
+          ],
+        ),
+      ),
+    );
   }
 }

lib/flutter_introduction_widget.dart

@@ -1 +1,4 @@
 library flutter_introduction_widget;
+
+export 'package:flutter_introduction_widget/src/introduction.dart';
+export 'package:flutter_introduction_widget/src/models/introduction_page.dart';

lib/src/extensions.dart

@@ -0,0 +1,68 @@
+// ignore_for_file: prefer_mixin
+
+import 'package:flutter/material.dart';
+
+class NavigateWidgetMixin {
+  void navigateFadeTo(
+    BuildContext context,
+    WidgetBuilder buildChild, {
+    String? routeName,
+    bool? opaque,
+    Color? barrierColor,
+  }) {
+    Navigator.of(context).push(
+      PageRouteBuilder(
+        opaque: opaque ?? true,
+        barrierColor: barrierColor,
+        settings: RouteSettings(name: routeName),
+        transitionDuration: const Duration(milliseconds: 500),
+        transitionsBuilder: (context, animation, secondamination, child) =>
+            FadeTransition(opacity: animation, child: child),
+        pageBuilder: (BuildContext ctx, animation, __) => buildChild(ctx),
+      ),
+    );
+  }
+
+  void navigateFadeToReplace(
+    BuildContext context,
+    WidgetBuilder buildChild, {
+    bool popRemaining = false,
+  }) {
+    if (popRemaining) {
+      Navigator.of(context).popUntil((route) => route.isFirst);
+    }
+    Navigator.of(context).pushReplacement(
+      PageRouteBuilder(
+        transitionDuration: const Duration(milliseconds: 500),
+        transitionsBuilder: (context, animation, secondamination, child) =>
+            FadeTransition(opacity: animation, child: child),
+        pageBuilder: (BuildContext ctx, animation, __) => buildChild(ctx),
+      ),
+    );
+  }
+}
+
+abstract class NavigateWidget extends StatelessWidget with NavigateWidgetMixin {
+  const NavigateWidget({super.key});
+}
+
+abstract class StatefulNavigateWidget extends StatefulWidget
+    with NavigateWidgetMixin {
+  const StatefulNavigateWidget({super.key});
+}
+
+extension AlignmentFromTextAlign on TextAlign {
+  CrossAxisAlignment toCrossAxisAlignment() {
+    switch (this) {
+      case TextAlign.left:
+        return CrossAxisAlignment.start;
+      case TextAlign.right:
+        return CrossAxisAlignment.end;
+      case TextAlign.center:
+        return CrossAxisAlignment.center;
+      // ignore: no_default_cases
+      default:
+        return CrossAxisAlignment.end;
+    }
+  }
+}