Merge pull request #165 from koukibadr/docs-update-package-version

docs: update version to 2.5.1 and modify changelog

Author: koukibadr

CHANGELOG.md

@@ -1,251 +1,250 @@
+## [2.5.1] - 08/05/2025
+
+- **Changes**
+- Update closeButton action behavior [PR#163](https://github.com/koukibadr/Elegant-Notification/pull/163)
+
 ## [2.5.0] - 03/05/2025
 
-* **Changes**
-* Add `onLongPress` callback to the notification widget [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Add `longPressDuration` to customize the long press duration [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Implement long press detection and animation handling while long press interaction [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Add `verticalDividerWidth` attribute to customize the vertical divider width [PR#161](https://github.com/koukibadr/Elegant-Notification/pull/161)
+- **Changes**
+- Add `onLongPress` callback to the notification widget [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Add `longPressDuration` to customize the long press duration [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Implement long press detection and animation handling while long press interaction [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Add `verticalDividerWidth` attribute to customize the vertical divider width [PR#161](https://github.com/koukibadr/Elegant-Notification/pull/161)
 
-* **Enhancement**
-* Update the package example to demonstrate the new long press feature [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Update padding rendering on notification icon widget [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Update close icon rendering on notification widget [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Refactor closing timer initialization and closing to avoid null check operator error [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
-* Add `autoDismiss` check on `timer.cancel()` method to avoid null check operator error [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- **Enhancement**
+- Update the package example to demonstrate the new long press feature [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Update padding rendering on notification icon widget [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Update close icon rendering on notification widget [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Refactor closing timer initialization and closing to avoid null check operator error [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
+- Add `autoDismiss` check on `timer.cancel()` method to avoid null check operator error [PR#160](https://github.com/koukibadr/Elegant-Notification/pull/160)
 
 ## [2.4.5] - 16/04/2025
 
-* **Changes**
-* Mark `onCloseButtonPressed` as deprecated and replace it with `onDismiss` callback [PR#153](https://github.com/koukibadr/Elegant-Notification/pull/153)
+- **Changes**
+- Mark `onCloseButtonPressed` as deprecated and replace it with `onDismiss` callback [PR#153](https://github.com/koukibadr/Elegant-Notification/pull/153)
 
-* **Bug Fix**
-* Fix null check operator when initializing overlay helper constraints [Issue#152](https://github.com/koukibadr/Elegant-Notification/issues/152)
+- **Bug Fix**
+- Fix null check operator when initializing overlay helper constraints [Issue#152](https://github.com/koukibadr/Elegant-Notification/issues/152)
 
 ## [2.4.4] - 30/03/2025
 
-* **Bug Fix**
-* Update progress indicator padding display to prevent overflow when using `borderRadius` [Issue#150](https://github.com/koukibadr/Elegant-Notification/issues/150)
+- **Bug Fix**
+- Update progress indicator padding display to prevent overflow when using `borderRadius` [Issue#150](https://github.com/koukibadr/Elegant-Notification/issues/150)
 
 ## [2.4.3] - 09/03/2025
 
-* **Enhancements**
-* Update notification overlay display geometry calculation by handling bottom padding [Issue#143](https://github.com/koukibadr/Elegant-Notification/issues/143)
-* Add assertions on `StackedOptions` attribute
-
+- **Enhancements**
+- Update notification overlay display geometry calculation by handling bottom padding [Issue#143](https://github.com/koukibadr/Elegant-Notification/issues/143)
+- Add assertions on `StackedOptions` attribute
 
 ## [2.4.2] - 22/02/2025
 
-* **Enhancements**
-* Overlay manager add the current overlay when a new notification is displayed.
-* Enhanced overlay manager rendering method by adding a safe area widget to the overlay.
-* Refacor overlay manager to use a stack widget to display the notification.
-
+- **Enhancements**
+- Overlay manager add the current overlay when a new notification is displayed.
+- Enhanced overlay manager rendering method by adding a safe area widget to the overlay.
+- Refacor overlay manager to use a stack widget to display the notification.
 
 ## [2.4.1] - 21/12/2024
 
-* **Enhancements**
-* `verticalDividerColor` is no longer nullable by default it holds grey color value.
+- **Enhancements**
+- `verticalDividerColor` is no longer nullable by default it holds grey color value.
 
 ## [2.4.0] - 17/11/2024
 
-* **Enhancements**
-* new attribute: `verticalDividerColor` to customize vertical divider color
+- **Enhancements**
+- new attribute: `verticalDividerColor` to customize vertical divider color
 
 ## [2.3.1] - 07/11/2024
 
-* **Bug Fix**
-* Fix using show callback with GetX package context
+- **Bug Fix**
+- Fix using show callback with GetX package context
 
 ## [2.3.0] - 05/09/2024
 
-* **Changes**
-* `icon` is optional when using the default contructor
-* `icon` parameter is exposed when using success, info and error constructors
-
-* **Enhancement**
-* Reduced package size by removing all unnecessary code and files
+- **Changes**
+- `icon` is optional when using the default contructor
+- `icon` parameter is exposed when using success, info and error constructors
 
+- **Enhancement**
+- Reduced package size by removing all unnecessary code and files
 
 ## [2.2.2] - 09/07/2024
 
-* **Changes**
-* Update package deployment track
+- **Changes**
+- Update package deployment track
 
 ## [2.2.1] - 30/06/2024
 
-* **Bug Fix**
-* Add safearea rendering support for top notifications [Issue#127](https://github.com/koukibadr/Elegant-Notification/issues/127)
+- **Bug Fix**
+- Add safearea rendering support for top notifications [Issue#127](https://github.com/koukibadr/Elegant-Notification/issues/127)
 
 ## [2.2.0] - 09/06/2024
 
-* **Enhancement**
-* Remove package assets svg files to reduce package size
-* Replace assets with Material icons
+- **Enhancement**
+- Remove package assets svg files to reduce package size
+- Replace assets with Material icons
 
 ## [2.1.2] - 17/04/2024
 
-* **Bug Fix:**
-* Fix offsetAnimation initialization error
+- **Bug Fix:**
+- Fix offsetAnimation initialization error
 
 ## [2.1.1] - 13/04/2024
 
-* **Enhancements:**
-* Update package documentation and pubspec file
+- **Enhancements:**
+- Update package documentation and pubspec file
 
 ## [2.1.0] - 06/04/2024
 
-* **Enhancements:**
-* Add border attribute of type `BoxBorder` [Issue #119](https://github.com/koukibadr/Elegant-Notification/issues/119)
-* Migrate radius to borderRadius of type `BorderRadius`
+- **Enhancements:**
+- Add border attribute of type `BoxBorder` [Issue #119](https://github.com/koukibadr/Elegant-Notification/issues/119)
+- Migrate radius to borderRadius of type `BorderRadius`
 
 ## [2.0.0] - 30/03/2024
 
-* **Enhancements:**
-* Elegant notification now support stacked toasts [PR Link](https://github.com/koukibadr/Elegant-Notification/pull/111)
-* Removal of `enableShadow` and `shadowColor` attribute and replace it with `shadow` of `BoxShadow` type.
-* Add `animationCurve` attribute
-* remove `onActionPressed` function attribute.
+- **Enhancements:**
+- Elegant notification now support stacked toasts [PR Link](https://github.com/koukibadr/Elegant-Notification/pull/111)
+- Removal of `enableShadow` and `shadowColor` attribute and replace it with `shadow` of `BoxShadow` type.
+- Add `animationCurve` attribute
+- remove `onActionPressed` function attribute.
 
 ## [1.14.0] - 10/03/2024
 
-* **Enhancements:**
-* Removal of `closeOnTap` attribute and replace it with `isDismissible` with `dismissDirection` attributes [PR Link](https://github.com/koukibadr/Elegant-Notification/pull/109)
-* Rename `onTap` attribute to `onNotificationPressed`
-* Add `dismissDirection` to customize the direction where the notification can be dismissed
-
+- **Enhancements:**
+- Removal of `closeOnTap` attribute and replace it with `isDismissible` with `dismissDirection` attributes [PR Link](https://github.com/koukibadr/Elegant-Notification/pull/109)
+- Rename `onTap` attribute to `onNotificationPressed`
+- Add `dismissDirection` to customize the direction where the notification can be dismissed
 
 ## [1.13.1] - 02/03/2024
 
-* Update lint rules to avoid `Dangling library doc comment` analysis error
-
+- Update lint rules to avoid `Dangling library doc comment` analysis error
 
 ## [1.13.0] - 21/01/2024
 
-* `notificationPosition` and `NotificationPosition` are removed completly from the notification package
-* **Enhancement:**
-* `onTap` added to the package class, a callback that will be invoked when the notification is tapped [PR](https://github.com/koukibadr/Elegant-Notification/pull/105)
-* `closeOnTap` added to indicate if the notification will be dismissed or not when the notification is pressed [PR](https://github.com/koukibadr/Elegant-Notification/pull/105)
-
+- `notificationPosition` and `NotificationPosition` are removed completly from the notification package
+- **Enhancement:**
+- `onTap` added to the package class, a callback that will be invoked when the notification is tapped [PR](https://github.com/koukibadr/Elegant-Notification/pull/105)
+- `closeOnTap` added to indicate if the notification will be dismissed or not when the notification is pressed [PR](https://github.com/koukibadr/Elegant-Notification/pull/105)
 
 ## [1.12.0] - 14/01/2024
 
-* Replace `notificationPosition` with `position` with `Alignment` type instead of `NotificationPosition`
+- Replace `notificationPosition` with `position` with `Alignment` type instead of `NotificationPosition`
 
 ## [1.11.2] - 27/09/2023
 
-* Update package license to MIT license
+- Update package license to MIT license
 
 ## [1.11.1] - 09/09/2023
 
-* Fix const error in `toast_content.dart` file
+- Fix const error in `toast_content.dart` file
 
 ## [1.11.0] - 13/08/2023
 
-* Add width, height and padding to progress indicator widget [#88](https://github.com/koukibadr/Elegant-Notification/issues/88)
-* Update package example
+- Add width, height and padding to progress indicator widget [#88](https://github.com/koukibadr/Elegant-Notification/issues/88)
+- Update package example
 
 ## [1.10.1] - 28/06/2023
 
-* DRY refactorings:
-  * assertions in ```elegant_notification.dart```
-  * Default icon size property 
+- DRY refactorings:
+  - assertions in `elegant_notification.dart`
+  - Default icon size property
 
 ## [1.10.0] - 08/05/2023
 
-* Added RTL support [#84](https://github.com/koukibadr/Elegant-Notification/issues/84)
+- Added RTL support [#84](https://github.com/koukibadr/Elegant-Notification/issues/84)
 
 ## [1.9.1] - 16/03/2023
 
-* Support any type of widget in Title and description attributes
-
+- Support any type of widget in Title and description attributes
 
 ## [1.8.1] - 16/03/2023
 
-* Fix unhandled exception of the overlay creation with Flutter 3.7 [issue](https://github.com/koukibadr/Elegant-Notification/issues/80)
+- Fix unhandled exception of the overlay creation with Flutter 3.7 [issue](https://github.com/koukibadr/Elegant-Notification/issues/80)
 
 ## [1.8.0] - 14/03/2023
 
-* Customizable progress indicator background color [#78](https://github.com/koukibadr/Elegant-Notification/issues/78)
-* Customizable close button widget [PR #77](https://github.com/koukibadr/Elegant-Notification/pull/77)
+- Customizable progress indicator background color [#78](https://github.com/koukibadr/Elegant-Notification/issues/78)
+- Customizable close button widget [PR #77](https://github.com/koukibadr/Elegant-Notification/pull/77)
+
 ## [1.7.0] - 11/02/2023
 
-* Added overlay config to package
-* Added slide back animation
+- Added overlay config to package
+- Added slide back animation
 
 ## [1.6.4] - 09/10/2022
 
-* Add support for all display alignment positions (TopLeft, TopCenter, TopRight, CenterLeft, Center, CenterRight, BottomLeft, BottomCenter, BottomRight)
+- Add support for all display alignment positions (TopLeft, TopCenter, TopRight, CenterLeft, Center, CenterRight, BottomLeft, BottomCenter, BottomRight)
 
 ## [1.6.3] - 18/09/2022
 
-* Fix inactive screen bug when toast is displayed
+- Fix inactive screen bug when toast is displayed
 
 ## [1.6.2] - 13/09/2022
 
-* Fix back button with onDismiss callback usage
+- Fix back button with onDismiss callback usage
 
 ## [1.6.1] - 06/08/2022
 
-* Update package flutter 3 support
+- Update package flutter 3 support
 
 ## [1.6.0] - 02/07/2022
 
-* Fix toast dismiss issues
+- Fix toast dismiss issues
 
 ## [1.5.5] - 02/07/2022
 
-* Fix static analysis issues
+- Fix static analysis issues
 
 ## [1.5.4] - 30/05/2022
 
-* Support Flutter 3 null safety
-* Update enum names
+- Support Flutter 3 null safety
+- Update enum names
 
 ## [1.5.2] - 08/04/2022
 
-* Fix alignment position display bug (Center, Bottom, Top)
+- Fix alignment position display bug (Center, Bottom, Top)
 
 ## [1.5.1] - 15/02/2022
 
-* Fix alignment position display bug (Center, Bottom, Top)
+- Fix alignment position display bug (Center, Bottom, Top)
 
 ## [1.5.0] - 06/02/2022
 
-* Add dismiss and onDismiss parameters
-* Add barrier dismissable option
-* Bug fixes
+- Add dismiss and onDismiss parameters
+- Add barrier dismissable option
+- Bug fixes
 
 ## [1.4.0] - 22/01/2022
 
-* Add fromBottom animation type
-* Add notification width and height parameters
-* Bug fixes
+- Add fromBottom animation type
+- Add notification width and height parameters
+- Bug fixes
 
 ## [1.3.0] - 09/01/2022
 
-* Add notification position parameter
-* Merge title and titleStyle parameters
-* Merge description and descriptionStyle parameters
-* Add action widget with onActionPressed callback
-* Add autoDismiss attribute
-* Bug fixes
+- Add notification position parameter
+- Merge title and titleStyle parameters
+- Merge description and descriptionStyle parameters
+- Add action widget with onActionPressed callback
+- Add autoDismiss attribute
+- Bug fixes
 
 ## [1.2.0] - 31/12/2021
 
-* Optional title
-* Add background attribute to built-in themes
-* Add display progress indicator attribute to built-in themes
-* Customizable notification duration
-* Bug fixes
+- Optional title
+- Add background attribute to built-in themes
+- Add display progress indicator attribute to built-in themes
+- Customizable notification duration
+- Bug fixes
 
 ## [1.1.0] - 26/12/2021
 
-* Enhanced rendering performance
-* Animated progress bar indicator
+- Enhanced rendering performance
+- Animated progress bar indicator
 
 ## [1.0.0] - 14/08/2021
 
-* Built-in notification types
-* Display animations types
-* Full customization of the notification
-* Onclose and ondismiss function callback
+- Built-in notification types
+- Display animations types
+- Full customization of the notification
+- Onclose and ondismiss function callback