SFUser友好符号

这是用户友好的SF符号。

您可以使用 SF 符号映像而无需对系统名称进行编码，如果您选择不可用的系统映像，则可以通过 Xcode 的警报知道它。

⬇️ 安装

Swift 包管理器（推荐）

on Xcode, choose → → type url: https://github.com/littleossa/SFUserFriendlySymbols.git in the searchbox.FileAdd Packages...

tap if package appears.Add PackageSFUserFriendlySymbols

You can also add this package to , include it in your target dependencies.Package.swift

let package = Package(
    dependencies: [
        .package(url: "https://github.com/littleossa/SFUserFriendlySymbols", .upToNextMajor(from: "0.1.0")),
    ],
    targets: [
        .target(
            name: "<your-target-name>",
            dependencies: ["SFUserFriendlySymbols"]),
    ]
)

📖 How to use

At first, import .SFUserFriendlySymbols

◆ UIKit

for example, if you want use this system symbol named face.smiling

symbol names changed into lower camel cases in SFUserFriendlySymbols.

face.smiling -> faceSmiling

select lower camel cased symbols as the parameter in the initializer.

let image = UIImage(symbol: .faceSmiling)

unfortunately,there are some symbol names which start with numbers.

the example is .in this case,the enum case start with .1.circle_

let image = UIImage(symbol: ._1Circle)

◆ SwiftUI

Image(symbol: .faceSmiling)

❓ Why UserFriendly?

Why this name of SF Symbols library includes UserFriendly?

The symbol can’t use and you can know with the alert on Xcode when your lower OS target version doesn’t reach available version of the given symbol.

And also, you don’t need to type system name when you intialize images with any symbols.

There is just one word. “Happy”

🆕 Features from iOS 15

You can set image palette-colored or hiralical-colored, muluticolored.

use this symbol “pc” as a sample this time.

palette-colored

let image = UIImage(symbol: .pc, paletteColors: [.systemPink, .yellow])

hierarchical-colored

let image = UIImage(symbol: .pc, hierarchicalColor: .systemPink)

multicolored

if symbols have multicolor variant, the symbol’s color prefers the multicolor when they initialize with UIImage(multiColoredSymbol:)

let image = UIImage(multiColoredSymbol: .pc)

💡 Contribution

Feel free to contribute from SF Symbols lovers.

• New Issue
• New pull request

License

This library is released under the MIT License.

GitHub

点击跳转