Skip to content

A simple and cross-platform SFSymbol picker for SwiftUI

License

Notifications You must be signed in to change notification settings

xnth97/SymbolPicker

Repository files navigation

SymbolPicker

A simple and cross-platform SFSymbol picker for SwiftUI

Features

SymbolPicker provides a simple and cross-platform interface for picking a SFSymbol. SymbolPicker is implemented with SwiftUI and supports iOS, macOS, watchOS, tvOS and visionOS platforms.

Usage

Requirements

  • iOS 15.0+ / macOS 12.0+ / watchOS 8.0+ / tvOS 15.0+ / visionOS 1.0+
  • Xcode 14.0+
  • Swift 5.5+

Installation

SymbolPicker is available as a Swift Package. Add this repo to your project through Xcode GUI or Package.swift.

dependencies: [
    .package(url: "https://github.com/xnth97/SymbolPicker.git", .upToNextMajor(from: "1.5.0"))
]

Example

It is suggested to use SymbolPicker within a sheet.

import SwiftUI
import SymbolPicker

struct ContentView: View {
    @State private var iconPickerPresented = false
    @State private var icon = "pencil"

    var body: some View {
        Button {
            iconPickerPresented = true
        } label: {
            HStack {
                Image(systemName: icon)
                Text(icon)
            }
        }
        .sheet(isPresented: $iconPickerPresented) {
            SymbolPicker(symbol: $icon)
        }
    }
}

TODO

  • Categories support
  • Multiplatform support
  • Platform availability support
  • Codegen from latest SF Symbols
  • Nullable symbol

License

SymbolPicker is available under the MIT license. See the LICENSE file for more info.