Merge pull request #2 from ActuallyTaylor/ActuallyTaylor-patch-1

Update the Package Scope

Author: ActuallyTaylor

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.8
+// swift-tools-version: 5.7.1
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

README.md

@@ -1,22 +1,128 @@
 # SFSymbols
-A swift enumeration that can be used to access SF Symbols without having to use their string names.
+SFSymbols gives you access to Apple's SFSymbol library in a type safe and Swifty manner. It get's difficult to remember all of the correct symbol names when using strings to label everything. This enumeration makes it easy to use a type safe interface with SFSymbols with SwiftUI, UIKit and AppKit.
 
 ## Install
 Add the following URL to Swift Package Manager:
 ```
 https://github.com/ActuallyTaylor/SFSymbols
 ```
 
-## How to use
+## Basic Usage
 ```swift
+import SwiftUI
 import SFSymbols // Import SFSymbols
 
-Image(.hammer) // Boom 💥, it is that simple.
+Image(.sparkles) // Boom 💥, it is that simple.
 ```
 
-### Custom Images
+#### Custom Images
 ```swift
+import SwiftUI
 import SFSymbols
 
 Image(.custom("spaceship")) // Will use a custom symbol file located in your assets folder!
 ```
+
+## Advanced Usage
+### SwiftUI
+#### Images
+The default Image initializer is replaced with a custom symbol initializer.
+
+```swift
+Image(.hammer)
+```
+
+#### Buttons
+Two new initializers have been added to Buttons that allow you to initialize them automatically with an SFSymbol label, reducing the amount of code in your views.
+```swift
+// Basic Button initializer 
+Button(.fireplace_fill) {
+    print("Sit by the fireplace with me!")
+}
+
+// Button initializer with a role
+Button(.xmark_app_fill, role: .cancel) {
+    print("Goodbye!")
+}
+```
+
+#### Menus
+Two new initializers have been added to Menus that allow you to automatically create them with an SFSymbol image label.
+```swift
+// Basic menu initializer
+Menu(.command) {
+    Button("Hello World!") {
+        print("Hello World!")
+    }
+}
+
+// Menu initializer with a primary action
+Menu(.command) {
+    Button("Hello World!") {
+        print("Hello World!")
+    }
+} primaryAction: {
+    print("Hello World!")  
+}
+```
+
+#### Labels
+Labels have been given two initializers that allow you to create them with an SFSymbol.
+
+```swift
+// Just a string
+Label("Hello World", symbol: .figure_wave)
+
+// Localized string key
+Label(LocalizedStringKey("hello.world"), symbol: .figure_wave)
+```
+
+### UIKit
+#### UIImage
+UIImages have been given a set of initializers that allow you too use SFSymbols directly
+
+```swift
+UIImage(.sparkles)
+UIImage(.sparkles, withConfiguration: /* some UIImage Configuration */)
+UIImage(.sparkles, compatibleWith: .current)
+```
+
+#### UIButton
+UIButtons have been given a system button initializer along with a way to set the image directly to an SFSymbol instead of needing to create a UIImage.
+
+```swift
+// Create a System Button with an SFSymbol
+UIButton.systemButton(with: .figure_wave, target: self, action: /* any selector */)
+
+// Set an image for a certain state
+UIButton.setImage(.figure_wave, for: .normal)
+```
+
+#### DisplayRepresentation.Image
+DisplayRepresentation images have been given initializers. These are only available when you are importing both UIKit and AppIntents.
+
+```swift
+DisplayRepresentation.Image(.sparkles, isTemplate: false)
+DisplayRepresentation.Image(.sparkles, tintColor: .red, symbolConfiguration: /* some symbol configuration */)
+```
+
+#### UIApplicationShortcutIcon
+UIApplicationShortcutIcon have been given an initializer so they can be created with an SFSymbol.
+
+```swift
+UIApplicationShortcutIcon(.sparkles)
+```
+
+### AppKit
+#### NSImage
+NSImages have been given an initializer allowing you to create them using an SFSymbol.
+
+```swift
+NSImage(.sparkles, variableValue: 1.0)
+```
+
+#### NSButton
+NSButtons have been given an initializer that allows you to initialize them with an SFSymbol. This initializer allows you to setup the button to automatically use an SFSymbol with the given variable value.
+```swift
+NSButton(.sparkles, variableValue: 1.0, target: self, action: /* some selector */)
+```

Sources/SFSymbols/Extensions/AppKit/NSButton+SFSymbol.swift

@@ -0,0 +1,12 @@
+#if canImport(AppKit)
+import AppKit
+
+public extension NSButton {
+    @available(macOS 13.0, *)
+    convenience init(_ symbol: SFSymbol, variableValue: Double, target: Any?, action: Selector?) {
+        let image = NSImage(symbol, variableValue: variableValue)
+
+        self.init(image: image, target: target, action: action)
+    }
+}
+#endif

Sources/SFSymbols/Extensions/AppKit/NSImage+SFSymbol.swift

@@ -0,0 +1,16 @@
+#if canImport(AppKit)
+import AppKit
+
+@available(macOS 13.0, *)
+public extension NSImage {
+    convenience init(_ symbol: SFSymbol, variableValue: Double) {
+        switch symbol {
+        case .custom(let name):
+            self.init(named: name)!
+        default:
+            self.init(symbolName: symbol.name, variableValue: variableValue)!
+        }
+        
+    }
+}
+#endif

Sources/SFSymbols/Extensions/SwiftUI/Button+SFSymbol.swift

@@ -0,0 +1,16 @@
+import SwiftUI
+
+public extension Button {
+    init(_ symbol: SFSymbol, action: @escaping () -> Void) where Label == Image {
+        self = Button(action: action, label: {
+            Image(symbol)
+        })
+    }
+    
+    @available(iOS 15.0, macOS 12.0, *)
+    init(_ symbol: SFSymbol, role: ButtonRole?, action: @escaping () -> Void) where Label == Image {
+        self = Button(role: role, action: action, label: {
+            Image(symbol)
+        })
+    }
+}

Sources/SFSymbols/Image+SFSymbol.swift …/Extensions/SwiftUI/Image+SFSymbol.swiftSources/SFSymbols/Image+SFSymbol.swift renamed to Sources/SFSymbols/Extensions/SwiftUI/Image+SFSymbol.swift Sources/SFSymbols/Image+SFSymbol.swift renamed to Sources/SFSymbols/Extensions/SwiftUI/Image+SFSymbol.swift

@@ -0,0 +1,19 @@
+import SwiftUI
+
+@available(iOS 14.0, *)
+public extension Menu {
+    init(_ symbol: SFSymbol, content: @escaping () -> Content) where Label == Image, Content : View {
+        self = Menu(content: content, label: {
+            Image(symbol)
+        })
+    }
+    
+    @available(iOS 15.0, macOS 12.0, *)
+    init(_ symbol: SFSymbol, content: @escaping () -> Content, primaryAction: @escaping () -> Void) where Label == Image, Content : View {
+        self = Menu(content: content, label: {
+            Image(symbol)
+        }, primaryAction: primaryAction)
+    }
+    
+
+}

Sources/SFSymbols/Label+SFSymbol.swift …/Extensions/SwiftUI/Label+SFSymbol.swiftSources/SFSymbols/Label+SFSymbol.swift renamed to Sources/SFSymbols/Extensions/SwiftUI/Label+SFSymbol.swift Sources/SFSymbols/Label+SFSymbol.swift renamed to Sources/SFSymbols/Extensions/SwiftUI/Label+SFSymbol.swift

@@ -0,0 +1,26 @@
+#if canImport(UIKit) && canImport(AppIntents)
+import AppIntents
+import UIKit
+
+@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
+extension DisplayRepresentation.Image {
+    init(_ symbol: SFSymbol, tintColor: UIColor? = nil, symbolConfiguration: UIImage.SymbolConfiguration? = nil) {
+        switch symbol {
+        case .custom(let name):
+            self.init(named: name)
+        default:
+            self.init(systemName: symbol.name, tintColor: tintColor, symbolConfiguration: symbolConfiguration)!
+        }
+    }
+    
+    init(_ symbol: SFSymbol, isTemplate: Bool?) {
+        switch symbol {
+        case .custom(let name):
+            self.init(named: name)
+        default:
+            self.init(systemName: symbol.name, isTemplate: isTemplate)
+        }
+    }
+}
+
+#endif

Sources/SFSymbols/Extensions/SwiftUI/Menu+SFSymbol.swift

@@ -0,0 +1,14 @@
+#if canImport(UIKit)
+import UIKit
+
+extension UIApplicationShortcutIcon {
+    convenience init(_ symbol: SFSymbol) {
+        switch symbol {
+        case .custom(let name):
+            self.init(templateImageName: name)
+        default:
+            self.init(systemImageName: symbol.name)
+        }
+    }
+}
+#endif