Merge branch 'develop'

.gitignore

@@ -0,0 +1,29 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+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
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+build/

.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "5dcb86f68f239346676ceb1ed1ea385bd215fba1"
+  channel: "stable"
+
+project_type: package

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* Initial version, 19.06.2024

LICENSE

@@ -0,0 +1,34 @@
+MIT License
+
+Copyright (c) 2024 Mohammad Alamoudi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+Mohammad Alamoudi and contributors to this Flutter library (the "Author") grant you, the user,
+a nonexclusive, royalty-free, perpetual, irrevocable, worldwide license to use,
+reproduce, modify, distribute, and sublicense the Software, including any
+modifications or derivative works thereof, in source code and/or binary form.
+This license is granted solely for the purpose of using, integrating, or extending
+the functionality of the Flutter library.
+
+You must include the above copyright notice, this permission notice, and the
+following text in all copies or substantial portions of the Software:
+
+"Mohammad Alamoudi (the "Owner") owns and maintains this Flutter library. You may contact
+the Owner at [email protected]."
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,159 @@
-# stage_navigation_bar
+<!--
+This README describes the package. If you publish this package to pub.dev,
+this README's contents appear on the landing page for your package.
+
+For information about how to write a good package README, see the guide for
+[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
+
+For general information about developing packages, see the Dart guide for
+[creating packages](https://dart.dev/guides/libraries/create-library-packages)
+and the Flutter guide for
+[developing packages and plugins](https://flutter.dev/developing-packages).
+-->
+
+![Static Badge](https://img.shields.io/badge/pub-v0.0.1-blue?logo=dart&link=https%3A%2F%2Fpub.dev%2Fpackages%2Fstage_navigation_bar)
+![Static Badge](https://img.shields.io/badge/github-mu7mmd-black?logo=github&link=https%3A%2F%2Fgithub.com%2Fmu7mmd)
+![Static Badge](https://img.shields.io/badge/linkedin-3mdy-blue?logo=linkedin&link=https%3A%2F%2Fwww.linkedin.com%2Fin%2F3mdy)
+
+A beautiful navigation bar with animation when select item.
+
+![style1](doc/assets/top-entering-indicator.gif)
+
+## Table of contents
+
+1. [Installing](#installing)
+2. [How To Use](#how_to_use)
+3. [Showcase](#showcase)
+4. [Example Project](#example)
+5. [Contributors](#contributors)
+
+## 🖥  Installing <a name="installing"></a>
+
+### Add Dependency
+```yaml
+dependencies:
+  stage_navigation_bar: ^0.0.1 #latest version
+```
+
+### Import Package
+```dart
+import 'package:stage_navigation_bar/stage_navigation_bar.dart';
+```
+
+## ℹ️ How To Use <a name="how_to_use"></a>
+
+Place your `StageNavigationBar` to the `bottomNavigationBar` slot of a `Scaffold`. Or in the bottom
+of your main page view.
+
+**❗️ It works with 2 or more navigation items.**
+
+### Code
+```dart
+class StageNavigationBarExample extends StatefulWidget {
+  const StageNavigationBarExample({super.key});
+
+  @override
+  State<StageNavigationBarExample> createState() =>
+      _StageNavigationBarExampleState();
+}
+
+class _StageNavigationBarExampleState extends State<StageNavigationBarExample> {
+  /// Your initial page
+  int _selectedIndex = 0;
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      bottomNavigationBar: StageNavigationBar(
+        items: const [
+          Icon(Icons.home_filled, color: Colors.white),
+          Icon(Icons.favorite, color: Colors.white),
+          Icon(Icons.search, color: Colors.white),
+          Icon(Icons.person, color: Colors.white),
+        ],
+        selectedIndex: _selectedIndex,
+        indicatorColor: Colors.amber,
+        onTap: (int index) {
+          setState(() {
+            _selectedIndex = index;
+          });
+        },
+      ),
+    );
+  }
+}
+```
+
+### Properties
+- `itemEntering`: Define the animation move shape when tap.
+- `alignment`: Alignment of the item inside the shadow colors.
+- `itemHeight`: The height of each item.
+- `indicatorHeight`: Indicator height.
+- `indicatorColor`*: The color of the indicator and the shadow degrees.
+- `selectedIndex`*: Current selected index.
+- `items`*: `StageNavigationBar` items, must be >= 2.
+- `onTap`*: On item tap.
+- `barWidth`: `StageNavigationBar` width.
+- `itemPadding`: The padding of each item.
+- `barPadding`?: `StageNavigationBar` internal padding.
+- `barMargin`?: `StageNavigationBar` external padding.
+- `duration`: The transition duration.
+- `decoration`?: `StageNavigationBar` box decoration.
+
+### Default values
+- `itemEntering = StageNavigationEntering.top`,
+- `alignment = Alignment.center`,
+- `itemHeight = 60`,
+- `indicatorHeight = 5`,
+- `barWidth = double.infinity`
+- `itemPadding = const EdgeInsets.all(0)`,
+- `duration = const Duration(milliseconds: 200)`,
+
+### StageNavigationEntering Values
+```dart
+StageNavigationEntering.top
+StageNavigationEntering.center
+StageNavigationEntering.bottom
+```
+
+### Event
+```dart
+onTap: (index){
+
+}
+```
+
+## 🕹 Showcase <a name="showcase"></a>
+
+**StageNavigationEntering**
+
+```dart
+itemEntering: StageNavigationEntering.top
+```
+
+![style1](doc/assets/top-entering-indicator.gif)
+---
+```dart
+itemEntering: StageNavigationEntering.center
+```
+
+![style1](doc/assets/center-entering-indicator.gif)
+---
+
+```dart
+itemEntering: StageNavigationEntering.bottom
+```
+
+![style1](doc/assets/bottom-entering-indicator.gif)
+
+## 📱 Example Project <a name="example"></a>
+
+[Pub Example Project](https://pub.dev/packages/stage_navigation_bar/example)
+
+[Github Example Project](https://github.com/mu7mmd/stage_navigation_bar/tree/main/example)
+
+<img src="doc/assets/screenshot.png" alt="Image" style="width: 300px;" />
+
+## 👨🏻‍💻 Contributors <a name="contributors"></a>
+
+Mohammad Alamoudi [@mu7mmd](https://github.com/mu7mmd)

analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

example/.gitignore

@@ -0,0 +1,43 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+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/.metadata

@@ -0,0 +1,45 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "5dcb86f68f239346676ceb1ed1ea385bd215fba1"
+  channel: "stable"
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+    - platform: android
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+    - platform: ios
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+    - platform: linux
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+    - platform: macos
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+    - platform: web
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+    - platform: windows
+      create_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+      base_revision: 5dcb86f68f239346676ceb1ed1ea385bd215fba1
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

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/android/.gitignore

@@ -0,0 +1,13 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks