More comments and small fixes

Author: buh

README.md

@@ -50,8 +50,8 @@ https://github.com/buh/CompactSlider.git
 
 # Documentation
 
-- [CompactSlider](https://swiftpackageindex.com/buh/compactslider/2.0.0/documentation/compactslider/compactslider)
-- [SystemSlider](https://swiftpackageindex.com/buh/compactslider/2.0.0/documentation/compactslider/systemslider)
+- [CompactSlider](https://swiftpackageindex.com/buh/compactslider/2.0.1/documentation/compactslider/compactslider)
+- [SystemSlider](https://swiftpackageindex.com/buh/compactslider/2.0.1/documentation/compactslider/systemslider)
 
 ## Version 1.0 (deprecated)
 

Sources/CompactSlider/Components/Background/EnvironmentBackgroundViewKey.swift

@@ -24,6 +24,9 @@ extension EnvironmentValues {
 // MARK: - View
 
 extension View {
+    /// Set a custom background view for the slider.
+    ///
+    /// - Parameter backgroundView: a custom background view. The view builder provides the configuration and padding.
     public func compactSliderBackground<V: View>(
         @ViewBuilder backgroundView: @escaping (
             _ configuration: CompactSliderStyleConfiguration,

Sources/CompactSlider/Components/Background/GridBackgroundView.swift

@@ -5,6 +5,7 @@
 
 import SwiftUI
 
+/// A background view for a grid slider.
 public struct GridBackgroundView<
         BackgroundShapeStyle: ShapeStyle,
         GridShapeStyle: ShapeStyle

Sources/CompactSlider/Components/Background/GridView.swift

@@ -5,6 +5,7 @@
 
 import SwiftUI
 
+/// A grid view. It renders a grid with a specified size and padding, using the `Grid` shape.
 public struct GridView<GridShapeStyle: ShapeStyle>: View {
     @Environment(\.colorScheme) var colorScheme
 

Sources/CompactSlider/Components/Grid/Grid.swift

@@ -5,19 +5,42 @@
 
 import SwiftUI
 
+/// A grid shape type.
 public enum GridType: Equatable, Sendable {
     case square
     case circle
 }
 
+/// A grid shape. It can be a square or a circle.
+///
+/// If it needs to to render in reverse order, set `inverse` to `true` and make `eoFill` to `true`.
+/// For example:
+/// ```swift
+/// Grid(countX: 10, countY: 10, size: 10, inverse: true)
+///    .fill(Color.blue, style: .init(eoFill: true))
+/// ```
 public struct Grid: Shape {
+    /// A grid shape type.
     let type: GridType
+    /// The number of shapes in the X-axis.
     let countX: Int
+    /// The number of shapes in the Y-axis.
     let countY: Int
+    /// The size of grid shapes.
     let size: CGFloat
+    /// The padding from the edges.
     let padding: EdgeInsets
+    /// Enable to render in reverse order, using `eoFill`.
     let inverse: Bool
 
+    /// Create a grid shape.
+    ///
+    /// - Parameters:
+    ///   - type: a grid shape type (default is `.circle`).
+    ///   - countX: the number of shapes in the X-axis.
+    ///   - countY: the number of shapes in the Y-axis.
+    ///   - size: the size of grid shapes.
+    ///   - padding: the padding from the edges (default is `.zero`).
     public init(
         type: GridType = .circle,
         countX: Int,

Sources/CompactSlider/Components/Handle/EnvironmentHandleStyleKey.swift

@@ -17,6 +17,9 @@ extension EnvironmentValues {
 }
 
 extension View {
+    /// Set a handle style for a compact slider.
+    ///
+    /// - Parameter style: a handle style.
     public func compactSliderHandleStyle(_ style: HandleStyle) -> some View {
         environment(\.handleStyle, style)
     }

…andle/CompactSliderStyleHandleView.swift …ts/Handle/EnvironmentHandleViewKey.swiftSources/CompactSlider/Components/Handle/CompactSliderStyleHandleView.swift renamed to Sources/CompactSlider/Components/Handle/EnvironmentHandleViewKey.swift Sources/CompactSlider/Components/Handle/CompactSliderStyleHandleView.swift renamed to Sources/CompactSlider/Components/Handle/EnvironmentHandleViewKey.swift

@@ -5,17 +5,6 @@
 
 import SwiftUI
 
-public struct CompactSliderStyleHandleView: View {
-    @Environment(\.compactSliderHandleView) var handleView
-    
-    public var body: some View {
-        handleView
-            .allowsTightening(false)
-    }
-}
-
-// MARK: - Environment
-
 struct HandleViewKey: EnvironmentKey {
     static var defaultValue: AnyView =
         HandleViewContainerView { configuration, style, _, _ in
@@ -25,7 +14,7 @@ struct HandleViewKey: EnvironmentKey {
 }
 
 extension EnvironmentValues {
-    public var compactSliderHandleView: AnyView {
+    var compactSliderHandleView: AnyView {
         get { self[HandleViewKey.self] }
         set { self[HandleViewKey.self] = newValue }
     }
@@ -34,6 +23,10 @@ extension EnvironmentValues {
 // MARK: - View
 
 extension View {
+    /// Set a custom handle view for the slider.
+    ///
+    /// - Parameter handleView: a custom handle view. The view builder provides the configuration,
+    ///                         style, progress, and index. The index is the index of the handle for multiple handles.
     public func compactSliderHandle<V: View>(
         @ViewBuilder handleView: @escaping (
             _ configuration: CompactSliderStyleConfiguration,

Sources/CompactSlider/Components/Handle/HandleStyle.swift

@@ -5,6 +5,7 @@
 
 import SwiftUI
 
+/// A handle type. It could be a rectangle, rounded rectangle, circle, capsule, or a symbol.
 public enum HandleType: Equatable {
     case rectangle
     case roundedRectangle
@@ -14,18 +15,30 @@ public enum HandleType: Equatable {
     case `default`
 }
 
+/// A handle alignment with the progress view. It could be inside, center, or outside.
+///
+/// - inside: The handle is inside the progress view.
+/// - center: The handle is in the center of the edge of the progress view.
+/// - outside: The handle is outside the progress view.
 public enum HandleProgressAlignment: Equatable {
     case inside, center, outside
 }
 
 /// A handle style.
 public struct HandleStyle: Equatable {
+    /// The handle type.
     public let type: HandleType
+    /// The visibility of the handle. It could be always visible, hidden, or visible on focus (on drag or hover).
     public let visibility: CompactSliderVisibility
+    /// The alignment of the handle with the progress view.
     public let progressAlignment: HandleProgressAlignment
+    /// The color of the handle.
     public let color: Color
+    /// The width of the handle.
     public let width: CGFloat
+    /// The corner radius of the handle.
     public let cornerRadius: CGFloat
+    /// The stroke style of the handle. If it's nil the handle will be filled.
     public let strokeStyle: StrokeStyle?
 
     init(
@@ -50,6 +63,14 @@ public struct HandleStyle: Equatable {
 // MARK: - Constructors
 
 extension HandleStyle {
+    /// Creates a rectangle handle style.
+    ///
+    /// - Parameters:
+    ///   - visibility: a visibility of the handle.
+    ///   - progressAlignment: a handle alignment with the progress view.
+    ///   - color: a handle color.
+    ///   - width: a handle width. It's used to calculate the position of the handle and progress view.
+    ///   - strokeStyle: a handle stroke style. If it's nil the handle will be filled.
     public static func rectangle(
         visibility: CompactSliderVisibility = .default,
         progressAlignment: HandleProgressAlignment = .center,
@@ -68,6 +89,15 @@ extension HandleStyle {
         )
     }
 
+    /// Creates a rounded rectangle handle style.
+    ///
+    /// - Parameters:
+    ///   - visibility: a visibility of the handle.
+    ///   - progressAlignment: a handle alignment with the progress view.
+    ///   - color: a handle color.
+    ///   - width: a handle width. It's used to calculate the position of the handle and progress view.
+    ///   - cornerRadius: a handle corner radius.
+    ///   - strokeStyle: a handle stroke style. If it's nil the handle will be filled.
     public static func roundedRectangle(
         visibility: CompactSliderVisibility = .default,
         progressAlignment: HandleProgressAlignment = .center,
@@ -87,6 +117,14 @@ extension HandleStyle {
         )
     }
 
+    /// Creates a circle handle style.
+    ///
+    /// - Parameters:
+    ///   - visibility: a visibility of the handle.
+    ///   - progressAlignment: a handle alignment with the progress view.
+    ///   - color: a handle color.
+    ///   - radius: a handle radius. It's used to calculate the position of the handle and progress view.
+    ///   - strokeStyle: a handle stroke style. If it's nil the handle will be filled.
     public static func circle(
         visibility: CompactSliderVisibility = .default,
         progressAlignment: HandleProgressAlignment = .center,
@@ -105,6 +143,14 @@ extension HandleStyle {
         )
     }
 
+    /// Creates a capsule handle style.
+    ///
+    /// - Parameters:
+    ///   - visibility: a visibility of the handle.
+    ///   - progressAlignment: a handle alignment with the progress view.
+    ///   - color: a handle color.
+    ///   - width: a handle width. It's used to calculate the position of the handle and progress view.
+    ///   - strokeStyle: a handle stroke style. If it's nil the handle will be filled.
     public static func capsule(
         visibility: CompactSliderVisibility = .default,
         progressAlignment: HandleProgressAlignment = .center,
@@ -123,6 +169,14 @@ extension HandleStyle {
         )
     }
 
+    /// Creates a symbol handle style. The symbol is a system image. For example, "circle.fill".
+    ///
+    /// - Parameters:
+    ///   - name: a system image name.
+    ///   - visibility: a visibility of the handle.
+    ///   - progressAlignment: a handle alignment with the progress view.
+    ///   - color: a handle color.
+    ///   - width: a handle width. It's used to calculate the position of the handle and progress view.
     public static func symbol(
         _ name: String,
         visibility: CompactSliderVisibility = .default,

Sources/CompactSlider/Styles/HandleViewWrapper.swift

@@ -7,15 +7,19 @@ import SwiftUI
 
 struct HandleViewWrapper: View {
     @Environment(\.handleStyle) var environmentHandleStyle
+    @Environment(\.compactSliderHandleView) var handleView
     var handleStyle: HandleStyle { environmentHandleStyle.byType(configuration.type) }
     let configuration: CompactSliderStyleConfiguration
 
     var body: some View {
         if configuration.isHandleVisible(handleStyle: handleStyle) {
             if configuration.progress.isMultipleValues, configuration.progress.progresses.count == 0 {
-                Rectangle().fill(Color.clear)
+                Rectangle()
+                    .fill(Color.clear)
+                    .allowsTightening(false)
             } else {
-                CompactSliderStyleHandleView()
+                handleView
+                    .allowsTightening(false)
             }
         }
     }