sf_symbols 0.3.0

Use SF Symbols on iOS, same as Image(systemName:) or UIImage(systemName:) in Swift.

sf_symbols

Use SF Symbols on iOS, the same way you would use Image(systemName:) or UIImage(systemName:) in Swift.

Requirements

Flutter	3.27 or newer
iOS	15.0 or newer
Build system	Swift Package Manager or CocoaPods

Usage

Use SfSymbol like any other widget with picked name, weight, color & size.

Size corresponds to the pointSize in UIImage.SymbolConfiguration, a SF symbol of size 40 will render roughly as big as 40pts x 40pts (pts is points in iOS).

SfSymbol(
    name: 'camera.aperture',
    weight: FontWeight.w900,
    color: Colors.pink,
    size: 40,
)

Names come from the SF Symbols app. If a name does not exist on the running iOS version, the widget renders nothing rather than throwing.

How it works

This package renders SF symbols natively from iOS as a texture, then reposition and resize the texture in Flutter. For more, check out the texture class in Flutter.

Running the example

cd example
flutter run -d <ios simulator or device>

The end-to-end tests exercise the native side and need a real simulator or device:

cd example
flutter test integration_test -d <ios simulator or device>

Roadmap

• Support for macOS