Improved view modifier names

Author: bpisano

README.md

@@ -37,22 +37,22 @@ The following modifiers are available to customize the sticker effect:
 
 | Modifier | Default Value | Description |
 |----------|---------------|-------------|
-| `.stickerEffectScale(_:)` | 1.4 | Controls the overall scale of the effect pattern |
-| `.stickerEffectIntensity(_:)` | 0.8 | Adjusts the strength of the holographic effect |
-| `.stickerEffectContrast(_:)` | 0.9 | Modifies the contrast between light and dark areas |
-| `.stickerEffectBlendFactor(_:)` | 0.4 | Controls how much the effect blends with the original content |
-| `.stickerEffectNoiseScale(_:)` | 140.0 | Adjusts the scale of the noise pattern |
-| `.stickerEffectNoiseIntensity(_:)` | 0.1 | Controls the intensity of the noise effect |
-| `.stickerEffectLightIntensity(_:)` | 0.3 | Adjusts the intensity of the light reflection |
+| `.stickerScale(_:)` | 1.4 | Controls the overall scale of the effect pattern |
+| `.stickerIntensity(_:)` | 0.8 | Adjusts the strength of the holographic effect |
+| `.stickerContrast(_:)` | 0.9 | Modifies the contrast between light and dark areas |
+| `.stickerBlend(_:)` | 0.4 | Controls how much the effect blends with the original content |
+| `.stickerNoiseScale(_:)` | 140.0 | Adjusts the scale of the noise pattern |
+| `.stickerNoiseIntensity(_:)` | 0.1 | Controls the intensity of the noise effect |
+| `.stickerLightIntensity(_:)` | 0.3 | Adjusts the intensity of the light reflection |
 
 Example usage:
 
 ```swift
 Image(.stickerIcon)
     .stickerEffect()
-    .stickerEffectIntensity(0.5)
-    .stickerEffectNoiseScale(200)
-    .stickerEffectLightIntensity(0.5)
+    .stickerIntensity(0.5)
+    .stickerNoiseScale(200)
+    .stickerLightIntensity(0.5)
 ```
 
 ## Motion

Sources/Sticker/StickerEffect/StickerEffect.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  StickerEffect.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 03/11/2024.
@@ -11,32 +11,37 @@ private struct StickerEffectViewModifier: ViewModifier {
     @State private var motion: StickerMotion = .init()
 
     @Environment(\.stickerMotionEffect) private var effect
-    @Environment(\.stickerEffectScale) private var stickerEffectScale
-    @Environment(\.stickerEffectIntensity) private var stickerEffectIntensity
-    @Environment(\.stickerEffectContrast) private var stickerEffectContrast
-    @Environment(\.stickerEffectBlendFactor) private var stickerEffectBlendFactor
-    @Environment(\.stickerEffectNoiseScale) private var stickerEffectNoiseScale
-    @Environment(\.stickerEffectNoiseIntensity) private var stickerEffectNoiseIntensity
-    @Environment(\.stickerEffectLightIntensity) private var stickerEffectLightIntensity
+    @Environment(\.stickerScale) private var stickerScale
+    @Environment(\.stickerIntensity) private var stickerIntensity
+    @Environment(\.stickerContrast) private var stickerContrast
+    @Environment(\.stickerBlend) private var stickerBlend
+    @Environment(\.stickerNoiseScale) private var stickerNoiseScale
+    @Environment(\.stickerNoiseIntensity) private var stickerNoiseIntensity
+    @Environment(\.stickerLightIntensity) private var stickerLightIntensity
 
     func body(content: Content) -> some View {
         content
-            .visualEffect { [motion, stickerEffectScale, stickerEffectIntensity, stickerEffectContrast, stickerEffectBlendFactor, stickerEffectNoiseScale, stickerEffectNoiseIntensity] view, proxy in
+            .visualEffect {
+                [
+                    motion, stickerScale, stickerIntensity, stickerContrast, stickerBlend,
+                    stickerNoiseScale, stickerNoiseIntensity
+                ] view, proxy in
                 view
                     .colorEffect(
                         ShaderLibrary.foilShader(
-                            offset: motion.isActive ? (motion.transform * -150).point : StickerTransform.neutral.point,
+                            offset: motion.isActive
+                                ? (motion.transform * -150).point : StickerTransform.neutral.point,
                             size: proxy.size,
-                            scale: stickerEffectScale,
-                            intensity: stickerEffectIntensity,
-                            contrast: stickerEffectContrast,
-                            blendFactor: stickerEffectBlendFactor,
-                            noiseScale: stickerEffectNoiseScale,
-                            noiseIntensity: stickerEffectNoiseIntensity
+                            scale: stickerScale,
+                            intensity: stickerIntensity,
+                            contrast: stickerContrast,
+                            blendFactor: stickerBlend,
+                            noiseScale: stickerNoiseScale,
+                            noiseIntensity: stickerNoiseIntensity
                         )
                     )
             }
-            .visualEffect { [motion, stickerEffectLightIntensity] view, proxy in
+            .visualEffect { [motion, stickerLightIntensity] view, proxy in
                 view
                     .colorEffect(
                         ShaderLibrary.reflectionShader(
@@ -46,7 +51,7 @@ private struct StickerEffectViewModifier: ViewModifier {
                                 y: motion.transform.y
                             ),
                             reflectionSize: Float(min(proxy.size.width, proxy.size.height) / 2),
-                            reflectionIntensity: motion.isActive ? stickerEffectLightIntensity : 0
+                            reflectionIntensity: motion.isActive ? stickerLightIntensity : 0
                         )
                     )
             }
@@ -66,9 +71,9 @@ private struct StickerEffectViewModifier: ViewModifier {
     }
 }
 
-public extension View {
+extension View {
     @ViewBuilder
-    func stickerEffect(_ isEnabled: Bool = true) -> some View {
+    public func stickerEffect(_ isEnabled: Bool = true) -> some View {
         if isEnabled {
             modifier(StickerEffectViewModifier())
         } else {

Sources/Sticker/StickerEffectParameter/StickerEffectParameter.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  StickerEffectParameter.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 05/11/2024.
@@ -8,41 +8,41 @@
 import SwiftUI
 
 extension EnvironmentValues {
-    @Entry var stickerEffectScale: Float = 1.4
-    @Entry var stickerEffectIntensity: Float = 0.8
-    @Entry var stickerEffectContrast: Float = 0.9
-    @Entry var stickerEffectBlendFactor: Float = 0.4
-    @Entry var stickerEffectNoiseScale: Float = 140
-    @Entry var stickerEffectNoiseIntensity: Float = 0.1
-    @Entry var stickerEffectLightIntensity: Float = 0.3
+    @Entry var stickerScale: Float = 1.4
+    @Entry var stickerIntensity: Float = 0.8
+    @Entry var stickerContrast: Float = 0.9
+    @Entry var stickerBlend: Float = 0.4
+    @Entry var stickerNoiseScale: Float = 140
+    @Entry var stickerNoiseIntensity: Float = 0.1
+    @Entry var stickerLightIntensity: Float = 0.3
 }
 
-public extension View {
-    func stickerEffectScale(_ scale: Float) -> some View {
-        environment(\.stickerEffectScale, scale)
+extension View {
+    public func stickerScale(_ scale: Float) -> some View {
+        environment(\.stickerScale, scale)
     }
 
-    func stickerEffectIntensity(_ intensity: Float) -> some View {
-        environment(\.stickerEffectIntensity, intensity)
+    public func stickerIntensity(_ intensity: Float) -> some View {
+        environment(\.stickerIntensity, intensity)
     }
 
-    func stickerEffectContrast(_ contrast: Float) -> some View {
-        environment(\.stickerEffectContrast, contrast)
+    public func stickerContrast(_ contrast: Float) -> some View {
+        environment(\.stickerContrast, contrast)
     }
 
-    func stickerEffectBlendFactor(_ blendFactor: Float) -> some View {
-        environment(\.stickerEffectBlendFactor, blendFactor)
+    public func stickerBlend(_ blendFactor: Float) -> some View {
+        environment(\.stickerBlend, blendFactor)
     }
 
-    func stickerEffectNoiseScale(_ scale: Float) -> some View {
-        environment(\.stickerEffectNoiseScale, scale)
+    public func stickerNoiseScale(_ scale: Float) -> some View {
+        environment(\.stickerNoiseScale, scale)
     }
 
-    func stickerEffectNoiseIntensity(_ intensity: Float) -> some View {
-        environment(\.stickerEffectNoiseIntensity, intensity)
+    public func stickerNoiseIntensity(_ intensity: Float) -> some View {
+        environment(\.stickerNoiseIntensity, intensity)
     }
 
-    func stickerEffectLightIntensity(_ intensity: Float) -> some View {
-        environment(\.stickerEffectLightIntensity, intensity)
+    public func stickerLightIntensity(_ intensity: Float) -> some View {
+        environment(\.stickerLightIntensity, intensity)
     }
 }

Sources/Sticker/StickerMotion/StickerMotion.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  StickerMotion.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 04/11/2024.

Sources/Sticker/StickerMotionEffect/Effects/IdentityStickerTransformer.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  IdentityStickerTransformer.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 03/11/2024.
@@ -13,8 +13,8 @@ public struct IdentityStickerTransformer: StickerMotionEffect {
     }
 }
 
-public extension StickerMotionEffect where Self == IdentityStickerTransformer {
-    static var identity: Self {
+extension StickerMotionEffect where Self == IdentityStickerTransformer {
+    public static var identity: Self {
         .init()
     }
 }

Sources/Sticker/Utils/Extensions/ShaderLibraryExtension.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  ShaderLibraryExtension.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 03/11/2024.

Sources/Sticker/Utils/ViewSize/ViewSizePreferenceKey.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  ViewSizePreferenceKey.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 03/11/2024.

Sources/Sticker/Utils/ViewSize/WithViewSizeViewModifier.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  WithViewSizeViewModifier.swift
 //  Sticker
 //
 //  Created by Benjamin Pisano on 03/11/2024.