Merge pull request #47 from mhmzdev/example-dir-updated

Example dir updated to run within project (VSCode)

Author: mhmzdev

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "awesome_snackbar_content_example",
+            "request": "launch",
+            "type": "dart",
+            "program": "example/lib/main.dart",
+            "args": [
+                "--web-port",
+                "8000",
+            ],
+            "deviceId": "chrome"
+        }
+    ]
+}

example/.gitignore

@@ -0,0 +1,45 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.build/
+.buildlog/
+.history
+.svn/
+.swiftpm/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release

example/README.md

@@ -0,0 +1,16 @@
+# example
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+
+For help getting started with Flutter development, view the
+[online documentation](https://docs.flutter.dev/), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

example/analysis_options.yaml

@@ -0,0 +1,28 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at https://dart.dev/lints.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

example/example.dart example/lib/main.dartexample/example.dart renamed to example/lib/main.dart

@@ -1,8 +1,29 @@
 import 'package:flutter/material.dart';
 import 'package:awesome_snackbar_content/awesome_snackbar_content.dart';
 
+void main() {
+  runApp(const MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
+  // This widget is the root of your application.
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'Awesome SnackBar Example',
+      theme: ThemeData(
+        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
+        useMaterial3: true,
+      ),
+      home: const AweseomSnackBarExample(),
+    );
+  }
+}
+
 class AweseomSnackBarExample extends StatelessWidget {
-  const AweseomSnackBarExample({Key? key}) : super(key: key);
+  const AweseomSnackBarExample({super.key});
 
   @override
   Widget build(BuildContext context) {

example/pubspec.yaml

@@ -0,0 +1,91 @@
+name: example
+description: "A new Flutter project."
+# The following line prevents the package from being accidentally published to
+# pub.dev using `flutter pub publish`. This is preferred for private packages.
+publish_to: 'none' # Remove this line if you wish to publish to pub.dev
+
+# The following defines the version and build number for your application.
+# A version number is three numbers separated by dots, like 1.2.43
+# followed by an optional build number separated by a +.
+# Both the version and the builder number may be overridden in flutter
+# build by specifying --build-name and --build-number, respectively.
+# In Android, build-name is used as versionName while build-number used as versionCode.
+# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
+# In iOS, build-name is used as CFBundleShortVersionString while build-number is used as CFBundleVersion.
+# Read more about iOS versioning at
+# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
+# In Windows, build-name is used as the major, minor, and patch parts
+# of the product and file versions while build-number is used as the build suffix.
+version: 1.0.0+1
+
+environment:
+  sdk: '>=3.2.3 <4.0.0'
+
+# Dependencies specify other packages that your package needs in order to work.
+# To automatically upgrade your package dependencies to the latest versions
+# consider running `flutter pub upgrade --major-versions`. Alternatively,
+# dependencies can be manually updated by changing the version numbers below to
+# the latest version available on pub.dev. To see which dependencies have newer
+# versions available, run `flutter pub outdated`.
+dependencies:
+  flutter:
+    sdk: flutter
+  awesome_snackbar_content:
+    path: ../
+
+  # The following adds the Cupertino Icons font to your application.
+  # Use with the CupertinoIcons class for iOS style icons.
+  cupertino_icons: ^1.0.2
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+
+  # The "flutter_lints" package below contains a set of recommended lints to
+  # encourage good coding practices. The lint set provided by the package is
+  # activated in the `analysis_options.yaml` file located at the root of your
+  # package. See that file for information about deactivating specific lint
+  # rules and activating additional ones.
+  flutter_lints: ^2.0.0
+
+# For information on the generic Dart part of this file, see the
+# following page: https://dart.dev/tools/pub/pubspec
+
+# The following section is specific to Flutter packages.
+flutter:
+
+  # The following line ensures that the Material Icons font is
+  # included with your application, so that you can use the icons in
+  # the material Icons class.
+  uses-material-design: true
+
+  # To add assets to your application, add an assets section, like this:
+  # assets:
+  #   - images/a_dot_burr.jpeg
+  #   - images/a_dot_ham.jpeg
+
+  # An image asset can refer to one or more resolution-specific "variants", see
+  # https://flutter.dev/to/resolution-aware-images
+
+  # For details regarding adding assets from package dependencies, see
+  # https://flutter.dev/to/asset-from-package
+
+  # To add custom fonts to your application, add a fonts section here,
+  # in this "flutter" section. Each entry in this list should have a
+  # "family" key with the font family name, and a "fonts" key with a
+  # list giving the asset and other descriptors for the font. For
+  # example:
+  # fonts:
+  #   - family: Schyler
+  #     fonts:
+  #       - asset: fonts/Schyler-Regular.ttf
+  #       - asset: fonts/Schyler-Italic.ttf
+  #         style: italic
+  #   - family: Trajan Pro
+  #     fonts:
+  #       - asset: fonts/TrajanPro.ttf
+  #       - asset: fonts/TrajanPro_Bold.ttf
+  #         weight: 700
+  #
+  # For details regarding fonts from package dependencies,
+  # see https://flutter.dev/to/font-from-package

example/test/widget_test.dart

@@ -0,0 +1,81 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:awesome_snackbar_content/awesome_snackbar_content.dart';
+import 'package:example/main.dart';
+
+void main() {
+  group('AwesomeSnackBar Example Tests', () {
+    testWidgets('App should render with two buttons',
+        (WidgetTester tester) async {
+      await tester.pumpWidget(const MyApp());
+
+      // Verify that both buttons are present
+      expect(find.text('Show Awesome SnackBar'), findsOneWidget);
+      expect(find.text('Show Awesome Material Banner'), findsOneWidget);
+    });
+
+    testWidgets('Tapping SnackBar button shows snackbar with correct content',
+        (WidgetTester tester) async {
+      await tester.pumpWidget(const MyApp());
+
+      // Tap the snackbar button
+      await tester.tap(find.text('Show Awesome SnackBar'));
+      await tester.pump(); // Start the animation
+      await tester
+          .pump(const Duration(seconds: 1)); // Pump until animation ends
+
+      // Verify snackbar content
+      expect(find.byType(SnackBar), findsOneWidget);
+      expect(find.byType(AwesomeSnackbarContent), findsOneWidget);
+      expect(find.text('On Snap!'), findsOneWidget);
+      expect(
+          find.text(
+              'This is an example error message that will be shown in the body of snackbar!'),
+          findsOneWidget);
+
+      // Verify snackbar properties
+      final SnackBar snackBar = tester.widget(find.byType(SnackBar));
+      expect(snackBar.elevation, 0);
+      expect(snackBar.behavior, SnackBarBehavior.floating);
+      expect(snackBar.backgroundColor, Colors.transparent);
+
+      // Verify AwesomeSnackbarContent properties
+      final AwesomeSnackbarContent content =
+          tester.widget(find.byType(AwesomeSnackbarContent));
+      expect(content.contentType, ContentType.failure);
+    });
+
+    testWidgets(
+        'Tapping Material Banner button shows banner with correct content',
+        (WidgetTester tester) async {
+      await tester.pumpWidget(const MyApp());
+
+      // Tap the material banner button
+      await tester.tap(find.text('Show Awesome Material Banner'));
+      await tester.pump(); // Start the animation
+      await tester
+          .pump(const Duration(seconds: 1)); // Pump until animation ends
+
+      // Verify material banner content
+      expect(find.byType(MaterialBanner), findsOneWidget);
+      expect(find.byType(AwesomeSnackbarContent), findsOneWidget);
+      expect(find.text('Oh Hey!!'), findsOneWidget);
+      expect(
+          find.text(
+              'This is an example error message that will be shown in the body of materialBanner!'),
+          findsOneWidget);
+
+      // Verify material banner properties
+      final MaterialBanner banner = tester.widget(find.byType(MaterialBanner));
+      expect(banner.elevation, 0);
+      expect(banner.backgroundColor, Colors.transparent);
+      expect(banner.forceActionsBelow, true);
+
+      // Verify AwesomeSnackbarContent properties
+      final AwesomeSnackbarContent content =
+          tester.widget(find.byType(AwesomeSnackbarContent));
+      expect(content.contentType, ContentType.success);
+      expect(content.inMaterialBanner, true);
+    });
+  });
+}