Merge pull request #1 from RichAppz/commenting

Commenting on the public parameters

MacToggle/MacToggle.swift

@@ -35,7 +35,6 @@ class MacToggle: NSView {
     fileprivate let height: CGFloat
     fileprivate let width: CGFloat
 
-    fileprivate var isAnimating = false
     fileprivate var leftConstraint: NSLayoutConstraint?
     fileprivate var heightConstraint: NSLayoutConstraint?
     fileprivate var widthConstraint: NSLayoutConstraint?
@@ -51,7 +50,7 @@ class MacToggle: NSView {
         let view = NSView()
 
         let shadow = NSShadow()
-        shadow.shadowColor = NSColor.agblack.withAlphaComponent(0.4)
+        shadow.shadowColor = NSColor.black.withAlphaComponent(0.4)
         shadow.shadowOffset = CGSize(width: 0, height: -2)
         shadow.shadowBlurRadius = 2
 
@@ -78,6 +77,10 @@ class MacToggle: NSView {
         }
     }
 
+    fileprivate var toggleSize: CGFloat {
+        get { return height-(outlineWidth*2) }
+    }
+
     //================================================================================
     // MARK: Callback
     //================================================================================
@@ -92,11 +95,12 @@ class MacToggle: NSView {
         didSet { animate() }
     }
 
+    /// Change the toggle border on and off
     public var hasToggleBorder = true {
         didSet { circle.layer?.borderWidth = hasToggleBorder ? toggleBorderWidth : 0 }
     }
 
-    // MARK: Size Settings
+    /// Change the width of the outline border
     public var outlineWidth: CGFloat = 2 {
         didSet {
             backVw.layer?.borderWidth = outlineWidth
@@ -104,10 +108,12 @@ class MacToggle: NSView {
         }
     }
 
+    /// Change the width of the border on the toggle
     public var toggleBorderWidth: CGFloat = 2 {
         didSet { circle.layer?.borderWidth = hasToggleBorder ? toggleBorderWidth : 0 }
     }
 
+    /// Change the radius of the complete toggle
     public var radius: CGFloat {
         get {
             if let r = _radius { return r }
@@ -120,19 +126,22 @@ class MacToggle: NSView {
     }
 
 
-    // MARK: Color Settings
+    /// Change the color of the outline border
     public var outlineColor: NSColor = .lightGray {
         didSet { backVw.layer?.borderColor = outlineColor.cgColor }
     }
 
+    /// Change the color of the fill when the toggle is on
     public var fillColor: NSColor = .lightGray {
         didSet { if isOn { backVw.layer?.borderColor = fillColor.cgColor } }
     }
 
+    /// Change the color of the toggle center
     public var toggleColor: NSColor = .white {
         didSet { circle.backgroundColor = toggleColor }
     }
 
+    /// Change the background color of the complete toggle (visible when switch is off)
     public var backColor: NSColor = .white {
         didSet { backVw.backgroundColor = backColor }
     }
@@ -176,6 +185,24 @@ class MacToggle: NSView {
     }
 
     override func mouseDown(with event: NSEvent) {
+        let push: Double = Double(outlineWidth + width) - Double(height)
+        NSAnimationContext.runAnimationGroup({ (context) in
+            context.duration = 0.3
+            context.allowsImplicitAnimation = true
+
+            let adjustment = (toggleSize/4)
+            widthConstraint?.isActive = false
+            widthConstraint = circle.widthAnchor.constraint(equalToConstant: toggleSize+adjustment)
+            widthConstraint?.isActive = true
+
+            if isOn {
+                leftConstraint?.constant = CGFloat(push)-adjustment
+            }
+            animator().layoutSubtreeIfNeeded()
+        })
+    }
+
+    override func mouseUp(with event: NSEvent) {
         isOn = !isOn
     }
 
@@ -205,22 +232,26 @@ class MacToggle: NSView {
     }
 
     fileprivate func animate() {
-        if isAnimating { return }
-        isAnimating = true
+        acceptsTouchEvents = false
+        let push: Double = Double(outlineWidth + width) - Double(height)
+
         NSAnimationContext.runAnimationGroup({ (context) in
-            context.duration = Size.mediumAnimation
+            context.duration = 0.3
             context.allowsImplicitAnimation = true
 
             backVw.animator().layer?.borderWidth = isOn ? (height/2) : outlineWidth
             backVw.animator().layer?.borderColor = isOn ? fillColor.cgColor : outlineColor.cgColor
 
-            let push: Double = Double(outlineWidth + width) - Double(height)
+            widthConstraint?.isActive = false
+            widthConstraint = circle.widthAnchor.constraint(equalToConstant: toggleSize)
+            widthConstraint?.isActive = true
+            
             leftConstraint?.constant = isOn ? CGFloat(push) : outlineWidth
             animator().layoutSubtreeIfNeeded()
         }) {
-            self.isAnimating = false
+            self.acceptsTouchEvents = true
             self.callback?(self.isOn)
         }
     }
-
+    
 }

README.md

@@ -8,6 +8,8 @@
 
 Create Mac OS toggles with the user interaction, desisn and animation of the iOS UISwitch. Completely configurable through quick understandable code. With access to the source, you are able to add more custom features if you want. If their are any tweaks that you feel should be enabled then send me over a PR and I will have a look. **Swift 3 Ready**
 
+<center>![Banner](Resources/mactoggle.gif)</center>
+
 ##Setup
 
 Nothing complicated, download the MacToggle.swift file and add it to your project.
@@ -24,7 +26,7 @@ let toggle: MacToggle = {
 	return view
 }()
 ```
-There a plenty of settings you can play with, have fun and create the designs that you require for your Mac OS developments. Here are a couple of designs, for some ideas:
+There are plenty of settings you can play with, have fun and create the designs that you require for your Mac OS developments. Here are a couple of designs, for ideas:
 
 <br>
 
@@ -46,7 +48,6 @@ If you have any issues with the MacToggle, the shoot me an email <a href="mailto
 
 ## Todo
 
-- Morphing animations to match iOS UISwitch. 
 - Dragging on the toggle.
 - Label support.