InkWells #1

Author: SaadArdati

lib/src/api/mixins.dart

@@ -4,6 +4,7 @@
 
 import 'package:json_annotation/json_annotation.dart';
 
+import 'models/ink_well.dart';
 import 'models/models.dart';
 import 'nodes/nodes.dart';
 
@@ -40,6 +41,8 @@ abstract class DefaultShapeNode extends SceneNode
     bool isMask = false,
     List<Effect> effects = const [],
     BlendModeC blendMode = BlendModeC.srcOver,
+    InkWellModel? inkWell,
+
     // [GeometryMixin] properties.
     List<PaintModel> fills = const [],
     List<PaintModel> strokes = const [],
@@ -55,6 +58,7 @@ abstract class DefaultShapeNode extends SceneNode
       effects: [...effects],
       isMask: isMask,
       blendMode: blendMode,
+      inkWell: inkWell,
     );
 
     setGeometryMixin(
@@ -242,22 +246,27 @@ mixin BlendMixin on BaseNode {
   /// List of effects applied to the node.
   late List<Effect> effects;
 
+  /// Whether to use ink well on this node, along with its properties.
+  late InkWellModel? inkWell;
+
   /// Sets the blend properties of the node.
   void setBlendMixin({
     required double opacity,
     required bool isMask,
     required List<Effect> effects,
     required BlendModeC blendMode,
+    required InkWellModel? inkWell,
   }) {
     this.opacity = opacity;
     this.isMask = isMask;
     this.effects = effects;
     this.blendMode = blendMode;
+    this.inkWell = inkWell;
   }
 
   @override
   String toString() =>
-      "${super.toString()}\n Blend(${"opacity: $opacity, isMask: $isMask"})";
+      "${super.toString()}\n Blend(${"opacity: $opacity, isMask: $isMask, effects: $effects, blendMode: $blendMode, inkWell: $inkWell"})";
 }
 
 /// Represents the type of sizing a node can have on either axis.

lib/src/api/models/ink_well.dart

@@ -0,0 +1,91 @@
+// Copyright (c) 2022, Codelessly.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE.md file.
+
+import 'package:equatable/equatable.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+import '../../../codelessly_api.dart';
+
+part 'ink_well.g.dart';
+
+/// Represents properties that relate to the [InkWell] widget in Flutter.
+@JsonSerializable()
+class InkWellModel with EquatableMixin, SerializableMixin {
+
+  /// The highlight color of the [InkWell] if [useInkWell] is true.
+  final ColorRGBA? highlightColor;
+
+  /// The splash color of the [InkWell] if [useInkWell] is true.
+  final ColorRGBA? splashColor;
+
+  /// The hover color of the [InkWell] if [useInkWell] is true.
+  final ColorRGBA? hoverColor;
+
+  /// The focus color of the [InkWell] if [useInkWell] is true.
+  final ColorRGBA? focusColor;
+
+  /// Creates an [InkWellModel] instance with the given data.
+  const InkWellModel({
+    this.highlightColor,
+    this.splashColor,
+    this.hoverColor,
+    this.focusColor,
+  });
+
+  /// Duplicates this instance of [InkWellModel] with given useInkWell value.
+  InkWellModel copyWithUseInkWell(bool value) => InkWellModel(
+        highlightColor: highlightColor,
+        splashColor: splashColor,
+        hoverColor: hoverColor,
+        focusColor: focusColor,
+      );
+
+  /// Duplicates this instance of [InkWellModel] with given highlight color.
+  InkWellModel copyWithHighlightColor(ColorRGBA? color) => InkWellModel(
+        highlightColor: color,
+        splashColor: splashColor,
+        hoverColor: hoverColor,
+        focusColor: focusColor,
+      );
+
+  /// Duplicates this instance of [InkWellModel] with given splash color.
+  InkWellModel copyWithSplashColor(ColorRGBA? color) => InkWellModel(
+        highlightColor: highlightColor,
+        splashColor: color,
+        hoverColor: hoverColor,
+        focusColor: focusColor,
+      );
+
+  /// Duplicates this instance of [InkWellModel] with given hover color.
+  InkWellModel copyWithHoverColor(ColorRGBA? color) => InkWellModel(
+        highlightColor: highlightColor,
+        splashColor: splashColor,
+        hoverColor: color,
+        focusColor: focusColor,
+      );
+
+  /// Duplicates this instance of [InkWellModel] with given focus color.
+  InkWellModel copyWithFocusColor(ColorRGBA? color) => InkWellModel(
+        highlightColor: highlightColor,
+        splashColor: splashColor,
+        hoverColor: hoverColor,
+        focusColor: color,
+      );
+
+  /// Factory constructor for creating a new [InkWellModel] instance
+  /// from JSON data.
+  factory InkWellModel.fromJson(Map<String, dynamic> json) =>
+      _$InkWellModelFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$InkWellModelToJson(this);
+
+  @override
+  List<Object?> get props => [
+        highlightColor,
+        splashColor,
+        hoverColor,
+        focusColor,
+      ];
+}

lib/src/api/models/ink_well.g.dart

@@ -32,6 +32,7 @@ export 'font_name.dart';
 export 'google_maps.dart';
 export 'icon.dart';
 export 'icon_model.dart';
+export 'ink_well.dart';
 export 'input_border.dart';
 export 'input_decoration.dart';
 export 'letter_spacing.dart';