Merge pull request #43 from splashbyte/version0.8.0

Version0.8.0

Author: maeddin

CHANGELOG.md

@@ -1,57 +1,32 @@
-## 0.8.0-beta.6 (2023-08-22)
-
-- adds parameter to `onTap` ([#41](https://github.com/splashbyte/animated_toggle_switch/issues/41))
-
-## 0.8.0-beta.5 (2023-08-18)
-
-- fixes `AnimationType.onHover`
-
-## 0.8.0-beta.4 (2023-08-18)
-
-- BREAKING: removes `IconTheme` for controlling default size of `Icon`s
-- BREAKING: changes default background color from `ThemeData.scaffoldBackgroundColor` to `ThemeData.colorScheme.surface`
-- BREAKING: renames `dif` to `spacing` in all constructors
-
-## 0.8.0-beta.3 (2023-08-11)
-
-- BREAKING: replaces `transitionType` with `indicatorTransition` in `AnimatedToggleSwitch.rolling()`,
-  `AnimatedToggleSwitch.rollingByHeight()` and `AnimatedToggleSwitch.dual()`
-- BREAKING: replaces `iconSize` and `selectedIconSize` in `AnimatedToggleSwitch` constructors
-  - `rolling()`, `rollingByHeight()`, `dual()`: now uses IconTheme for controlling default size of `Icon`s
-  - `size()`, `sizeByHeight()`: new parameter `selectedIconScale` controls scaling
-
-## 0.8.0-beta.2 (2023-08-01)
-
-- minor fixes
-- updates README
-
-## 0.8.0-beta.1 (2023-07-31)
-
-- adds `active` to all constructors
-- closes [#30](https://github.com/splashbyte/animated_toggle_switch/issues/30)
-- minor improvements
-- BREAKING: changes `separatorBuilder` parameters
-- BREAKING: moves all cursor parameters to `cursors`
-
-## 0.8.0-beta.0 (2023-07-29)
-
+## 0.8.0 (2023-09-02)
 - adds tests for all `AnimatedToggleSwitch` constructors
 - adds `separatorBuilder`, `customSeparatorBuilder`, `style` and `styleAnimationType` to `AnimatedToggleSwitch`
 - adds `separatorBuilder` to `CustomAnimatedToggleSwitch`
-- fixes initial loading
+- adds `active` to all constructors ([#30](https://github.com/splashbyte/animated_toggle_switch/issues/30))
+- adds `styleBuilder` and `styleList` to `AnimatedToggleSwitch`
+- adds `iconList` to `AnimatedToggleSwitch.size`, `AnimatedToggleSwitch.sizeByHeight`, `AnimatedToggleSwitch.rolling` and `AnimatedToggleSwitch.rollingByHeight`
 - BREAKING: moves many parameters in `AnimatedToggleSwitch` to `style`:
-    - `innerColor` (renamed to `backgroundColor`)
-    - `innerGradient` (renamed to `backgroundGradient`)
-    - `borderColor`
-    - `indicatorColor`
-    - `borderRadius`
-    - `indicatorBorderColor`
-    - `indicatorBorder`
-    - `indicatorBorder`
-    - `foregroundBoxShadow` (renamed to `indicatorBoxShadow`)
-    - `boxShadow`
-- BREAKING: merges `borderColorBuilder` with `styleBuilder`
+  - `innerColor` (renamed to `backgroundColor`)
+  - `innerGradient` (renamed to `backgroundGradient`)
+  - `borderColor`
+  - `indicatorColor`
+  - `borderRadius`
+  - `indicatorBorderColor`
+  - `indicatorBorder`
+  - `indicatorBorder`
+  - `foregroundBoxShadow` (renamed to `indicatorBoxShadow`)
+  - `boxShadow`
+- BREAKING: moves all cursor parameters to `cursors`
+- BREAKING: removes `borderColorBuilder` in favor of the new `styleBuilder`
 - BREAKING: `indicatorAnimationType` handles `ToggleStyle.indicatorColor`, `ToggleStyle.indicatorBorderRadius`, `ToggleStyle.indicatorBorder` and `ToggleStyle.indicatorBoxShadow` now
+- BREAKING: adds parameter to `onTap` ([#41](https://github.com/splashbyte/animated_toggle_switch/issues/41))
+- BREAKING: changes default background color from `ThemeData.scaffoldBackgroundColor` to `ThemeData.colorScheme.surface`
+- BREAKING: renames `dif` to `spacing` in all constructors
+- BREAKING: replaces `transitionType` with `indicatorTransition` in `AnimatedToggleSwitch.rolling()`,
+  `AnimatedToggleSwitch.rollingByHeight()` and `AnimatedToggleSwitch.dual()`
+- BREAKING: removes `iconSize` and `selectedIconSize` in `AnimatedToggleSwitch` constructors
+  - `rolling()`, `rollingByHeight()`, `dual()`: new parameter `selectedIconScale` controls scaling now
+  - `size()`, `sizeByHeight()`: new parameter `indicatorIconScale` controls scaling now
 
 ## 0.7.0 (2023-06-19)
 
@@ -69,94 +44,94 @@
 ## 0.6.0 (2022-12-22)
 
 - fixes README
-- fixes #28
-- BREAKING: Increases minimum SDK to 2.17
-- BREAKING: Renames `value` to `current` and `previousValue` to `previous` in `DetailedGlobalToggleProperties`
-- BREAKING Feature: Adds loading animation to all switches. You can disable it by setting `loading` to false.
-- Adds `innerGradient` to `AnimatedToggleSwitch`
-- Adds `transitionType` to `AnimatedToggleSwitch.rolling`, `AnimatedToggleSwitch.rollingByHeight` and `AnimatedToggleSwitch.dual`
+- fixes ([#28](https://github.com/splashbyte/animated_toggle_switch/issues/28))
+- BREAKING: increases minimum SDK to 2.17
+- BREAKING: renames `value` to `current` and `previousValue` to `previous` in `DetailedGlobalToggleProperties`
+- BREAKING feature: Adds loading animation to all switches. You can disable it by setting `loading` to false.
+- adds `innerGradient` to `AnimatedToggleSwitch`
+- adds `transitionType` to `AnimatedToggleSwitch.rolling`, `AnimatedToggleSwitch.rollingByHeight` and `AnimatedToggleSwitch.dual`
 
 ## 0.5.2 (2022-04-22)
 
-- Minor performance improvement
-- Minor fixes
-- Improves code documentation
-- Adds `dragCursor` and `draggingCursor` to `CustomAnimatedToggleSwitch`
-- Adds `iconsTappable`, `defaultCursor`, `dragCursor` and `draggingCursor` to `AnimatedToggleSwitch`
+- minor performance improvement
+- minor fixes
+- improves code documentation
+- adds `dragCursor` and `draggingCursor` to `CustomAnimatedToggleSwitch`
+- adds `iconsTappable`, `defaultCursor`, `dragCursor` and `draggingCursor` to `AnimatedToggleSwitch`
 
 ## 0.5.1 (2022-04-21)
 
-- Fixes #20
+- fixes ([#20](https://github.com/splashbyte/animated_toggle_switch/issues/20))
 
 ## 0.5.0 (2022-04-20)
 
-- Minor performance improvement
-- Fixes problems with tight constraints
-- BREAKING: Changes default values of `animationOffset` and `clipAnimation` in `AnimatedToggleSwitch.dual`
+- minor performance improvement
+- fixes problems with tight constraints
+- BREAKING: changes default values of `animationOffset` and `clipAnimation` in `AnimatedToggleSwitch.dual`
 
 ## 0.4.0 (2022-04-03)
 
-- Minor fixes and performance improvements
-- Adds `indicatorBorderRadius` to `AnimatedToggleSwitch`
-- Adds `animationOffset`, `clipAnimation` and `opacityAnimation` to `AnimatedToggleSwitch.dual`
-- BREAKING: Sets default values of `animationOffset`, `clipAnimation` and `opacityAnimation` in `AnimatedToggleSwitch.dual`
-- BREAKING: Renames `foregroundBorder` to `indicatorBorder`
+- minor fixes and performance improvements
+- adds `indicatorBorderRadius` to `AnimatedToggleSwitch`
+- adds `animationOffset`, `clipAnimation` and `opacityAnimation` to `AnimatedToggleSwitch.dual`
+- BREAKING: sets default values of `animationOffset`, `clipAnimation` and `opacityAnimation` in `AnimatedToggleSwitch.dual`
+- BREAKING: renames `foregroundBorder` to `indicatorBorder`
 
 ## 0.3.1 (2022-03-23)
 
-- Minor fixes
+- minor fixes
 
 ## 0.3.0 (2022-03-21)
 
-- Introduces `CustomAnimatedToggleSwitch` for maximum customizability
-- Most constructors of `AnimatedToggleSwitch` have a standard and a more customizable parameter for their builders now
-- Full support of `TextDirection.rtl`
-- Adds animation when dragging the switch
-- Adds `minTouchTargetSize`, `dragStartDuration`, `dragStartCurve` and `textDirection` to `AnimatedToggleSwitch`
+- introduces `CustomAnimatedToggleSwitch` for maximum customizability
+- most constructors of `AnimatedToggleSwitch` have a standard and a more customizable parameter for their builders now
+- full support of `TextDirection.rtl`
+- adds animation when dragging the switch
+- adds `minTouchTargetSize`, `dragStartDuration`, `dragStartCurve` and `textDirection` to `AnimatedToggleSwitch`
 - BREAKING: `TextDirection` is taken from `BuildContext` by default now!!!
-- BREAKING: Changes parameters and names of some builders
-- BREAKING: Renames `AnimatedToggleSwitch.byHeight` to `AnimatedToggleSwitch.customByHeight`
-- BREAKING: Adds default `textMargin` to `AnimatedToggleSwitch.dual`
-- Fixes #9
+- BREAKING: changes parameters and names of some builders
+- BREAKING: renames `AnimatedToggleSwitch.byHeight` to `AnimatedToggleSwitch.customByHeight`
+- BREAKING: adds default `textMargin` to `AnimatedToggleSwitch.dual`
+- fixes ([#9](https://github.com/splashbyte/animated_toggle_switch/issues/9))
 
 ## 0.2.3 (2022-02-28)
 
-- BREAKING: Removes `indicatorType`
-- BREAKING: Changes default `innerColor`
-- Adds `BoxShadow` parameters
+- BREAKING: removes `indicatorType`
+- BREAKING: changes default `innerColor`
+- adds `BoxShadow` parameters
 
 ## 0.2.2 (2022-01-27)
 
-- Minor performance improvements
+- minor performance improvements
 
 ## 0.2.2 (2022-01-27)
 
-- Minor changes/fixes
+- minor changes/fixes
 
 ## 0.2.1 (2021-10-03)
 
-- Migrates to Flutter 2.5
-- Minor changes/fixes
+- migrates to Flutter 2.5
+- minor changes/fixes
 
 ## 0.2.0 (2021-05-21)
 
-- Minor Changes
-- Fixes `FittingMode.preventHorizontalOverlapping`
-- Improves Web support
+- minor Changes
+- fixes `FittingMode.preventHorizontalOverlapping`
+- improves Web support
 
 ## 0.1.3 (2021-03-27)
 
-- Updates README.md
+- updates README.md
 
 ## 0.1.2 (2021-03-27)
 
-- Adds `AnimatedToggleSwitch.dual`
-- Adds some settings (`AnimationType`)
+- adds `AnimatedToggleSwitch.dual`
+- adds some settings (`AnimationType`)
 
 ## 0.1.1 (2021-03-26)
 
-- Minor fix
+- minor fix
 
 ## 0.1.0 (2021-03-26)
 
-- Initial release
+- initial release

README.md

@@ -10,12 +10,12 @@
 
 [![buy me a coffee](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20pizza&emoji=🍕&slug=splashbyte&button_colour=FF8838&font_colour=ffffff&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff')](https://www.buymeacoffee.com/splashbyte)
 
-### If you like this package, please leave a like there on [pub.dev](https://pub.dev/packages/animated_toggle_switch) and star on [GitHub](https://github.com/SplashByte/animated_toggle_switch).
+### If you like this package, please like it on [pub.dev](https://pub.dev/packages/animated_toggle_switch) and star it on [GitHub](https://github.com/SplashByte/animated_toggle_switch).
 
 Fully customizable, draggable and animated switch with multiple choices and [smooth loading animation](#loading-animation). It has prebuilt constructors for rolling and size animations, but it also allows you to create your own switches with `CustomAnimatedToggleSwitch`.  
 `LTR` and `RTL` are both supported.  
 [Switches without an (initial) selection](#nullable-selection) are also possible.  
-Most builder arguments of `AnimatedToggleSwitch` have a standard and a custom version. This ensures that you can get started easily and still customize a lot if necessary.
+Most builder arguments of `AnimatedToggleSwitch` have a standard and a custom version. This ensures that you can [get started easily](#simple-rolling-animation) and still customize a lot if necessary. There are several options for [styling](#styling) it.
 
 For a slider with a similar look you can check out [action_slider](https://pub.dev/packages/action_slider).
 
@@ -26,16 +26,14 @@ For a slider with a similar look you can check out [action_slider](https://pub.d
 `AnimatedToggleSwitch.dual()`  
 ![animated_toggle_switch_example_dual](https://user-images.githubusercontent.com/43761463/161432631-e6dd3d16-7b64-410b-a9fa-c956d3442598.gif)
 ![animated_toggle_switch_example_borderradius_builder](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/ee615f64-d897-43f1-b508-0318805195e4)
-![animated_toggle_switch_example_lite_rolling_gradient](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/6cd5d2d3-b4bd-4020-8568-354c71221e40)
+![animated_toggle_switch_example_gradient](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/b0d390fc-cd18-45ad-b2ce-61e453f098ad)
 
 Switch inspired by [lite_rolling_switch](https://pub.dev/packages/lite_rolling_switch) (made with `AnimatedToggleSwitch.dual()`)  
-![animated_toggle_switch_example_lite_rolling](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/f1bec7cd-4885-4e8d-ac13-176d6b46245a)
-
+![animated_toggle_switch_example_lite_rolling_switch](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/34751d16-cbb1-42b5-a14d-6bd3340d676a)
 
 Switch inspired by [toggle_switch](https://pub.dev/packages/toggle_switch) (made with `AnimatedToggleSwitch.size()`)  
 ![animated_toggle_switch_example_toggle_switch](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/884c8433-3b11-4fe1-b2a8-c02599c56aee)
 
-
 Switch inspired by [crazy-switch](https://github.com/pedromassango/crazy-switch) (made with `CustomAnimatedToggleSwitch()`)  
 ![animated_toggle_switch_example_crazy_switch](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/106afaf5-88a0-4d4b-ad59-2b22182d18be)
 
@@ -58,7 +56,8 @@ You can build any other switch with `CustomAnimatedToggleSwitch()`
 ![animated_toggle_switch_example_6](https://user-images.githubusercontent.com/43761463/161432744-f60b660d-30d9-4d1d-9b87-14b62bc54e39.gif) 
 
 `AnimatedToggleSwitch.rolling()` with custom `indicatorSize`, `borderRadius` and `indicatorBorderRadius`  
-![animated_toggle_switch_example_7](https://user-images.githubusercontent.com/43761463/161432823-6cf3c855-2a9a-4f4a-9e5c-2951c4166f49.gif) ![animated_toggle_switch_example_8](https://user-images.githubusercontent.com/43761463/161432826-4b0c3e57-eed7-4567-8e7e-31b8a2ba6bee.gif)  
+![animated_toggle_switch_example_7](https://user-images.githubusercontent.com/43761463/161432823-6cf3c855-2a9a-4f4a-9e5c-2951c4166f49.gif)
+![animated_toggle_switch_example_8](https://user-images.githubusercontent.com/43761463/161432826-4b0c3e57-eed7-4567-8e7e-31b8a2ba6bee.gif)  
 
 ## Easy Usage
 
@@ -72,13 +71,14 @@ AnimatedToggleSwitch<int>.rolling(
   values: [0, 1, 2, 3],
   onChanged: (i) => setState(() => value = i),
   iconBuilder: iconBuilder,
+  // iconList: [...], you can use iconBuilder, customIconBuilder or iconList
   style: ToggleStyle(...), // optional style settings
   ... // many more parameters available
 )
 ```
 
 ### Styling
-`style`, `styleBuilder` and `customStyleBuilder` can be used to style the switch.  
+`style`, `styleBuilder`, `customStyleBuilder` and `styleList` can be used to style an `AnimatedToggleSwitch`.  
 For the general look of the switch, you can use `style`.  
 For parameters that should change with the selection, you can use `styleBuilder`.  
 If you need additional parameters, you can use `customStyleBuilder`.  
@@ -141,29 +141,36 @@ CustomAnimatedToggleSwitch<int>(
 ```
 
 ### `AnimatedToggleSwitch.size` with some settings
-![animated_toggle_switch_example_4](https://user-images.githubusercontent.com/43761463/161432714-435d8369-7e54-432a-8b9b-6b55a0764f4a.gif) 
+![animated_toggle_switch_example_size](https://github.com/splashbyte/animated_toggle_switch/assets/43761463/805a0e3f-b3a2-4801-baf9-7a5509905452)  
 ```dart
 AnimatedToggleSwitch<int>.size(
+  textDirection: TextDirection.rtl,
   current: value,
   values: const [0, 1, 2, 3],
   iconOpacity: 0.2,
   indicatorSize: const Size.fromWidth(100),
+  iconBuilder: iconBuilder,
+  borderWidth: 4.0,
   iconAnimationType: AnimationType.onHover,
-  colorAnimationType: AnimationType.onHover,
-  iconBuilder: (value, size) {
-    IconData data = Icons.access_time_rounded;
-    if (value.isEven) data = Icons.cancel;
-    return Icon(data, size: min(size.width, size.height));
-  },
-  style: const ToggleStyle(borderColor: Colors.transparent),
-  borderWidth: 0.0,
-  styleBuilder: (i) => ToggleStyle(indicatorColor: i.isEven == true ? Colors.amber : Colors.red),
+  style: ToggleStyle(
+    borderColor: Colors.transparent,
+    borderRadius: BorderRadius.circular(10.0),
+    boxShadow: [
+      BoxShadow(
+        color: Colors.black26,
+        spreadRadius: 1,
+        blurRadius: 2,
+        offset: Offset(0, 1.5),
+      ),
+    ],
+  ),
+  styleBuilder: (i) => ToggleStyle(indicatorColor: colorBuilder(i)),
   onChanged: (i) => setState(() => value = i),
 )
 ```
 
 ### Self-made rolling animation (with `foregroundIndicatorIconBuilder`)
-![animated_toggle_switch_example_6](https://user-images.githubusercontent.com/43761463/161432744-f60b660d-30d9-4d1d-9b87-14b62bc54e39.gif) 
+![animated_toggle_switch_example_6](https://user-images.githubusercontent.com/43761463/161432744-f60b660d-30d9-4d1d-9b87-14b62bc54e39.gif)  
 ```dart
 AnimatedToggleSwitch<int>.size(
   current: value,