| name | axiom-sf-symbols-ref |
| description | Use when you need complete SF Symbols API reference including every rendering mode, symbol effect, configuration option, UIKit equivalent, and platform availability - comprehensive code examples for iOS 17 through iOS 26 |
| license | MIT |
| compatibility | iOS 17+, iOS 18+, iOS 26+ |
| metadata | {"version":"1.0.0"} |
SF Symbols — API Reference
When to Use This Skill
Use when:
- You need exact API signatures for rendering modes or symbol effects
- You need UIKit/AppKit equivalents for SwiftUI symbol APIs
- You need to check platform availability for a specific effect
- You need configuration options (weight, scale, variable values)
- You need to create custom symbols with proper template structure
Related Skills
- Use
axiom-sf-symbols for decision trees, anti-patterns, troubleshooting, and when to use which effect
- Use
axiom-swiftui-animation-ref for general SwiftUI animation (non-symbol)
Part 1: Symbol Display
SwiftUI
Image(systemName: "star.fill")
Label("Favorites", systemImage: "star.fill")
Image(systemName: "star.fill")
.font(.title)
Image(systemName: "star.fill")
.imageScale(.large)
Image(systemName: "star.fill")
.font(.system(size: 24))
Image(systemName: "star.fill")
.fontWeight(.bold)
Image(systemName: "person")
.symbolVariant(.circle.fill)
Image(systemName: "speaker.wave.3.fill", variableValue: 0.5)
UIKit
let image = UIImage(systemName: "star.fill")
imageView.image = image
let config = UIImage.SymbolConfiguration(pointSize: 24, weight: .bold)
let image = UIImage(systemName: "star.fill", withConfiguration: config)
let config = UIImage.SymbolConfiguration(textStyle: .title1)
let image = UIImage(systemName: "star.fill", withConfiguration: config)
let config = UIImage.SymbolConfiguration(scale: .large)
let sizeConfig = UIImage.SymbolConfiguration(pointSize: 24, weight: .bold, scale: .large)
let image = UIImage(systemName: "speaker.wave.3.fill", variableValue: 0.5)
AppKit
let image = NSImage(systemSymbolName: "star.fill", accessibilityDescription: "Favorite")
let config = NSImage.SymbolConfiguration(pointSize: 24, weight: .bold)
let configured = image?.withSymbolConfiguration(config)
Part 2: Rendering Modes
SwiftUI
Image(systemName: "cloud.rain.fill")
.foregroundStyle(.blue)
Image(systemName: "cloud.rain.fill")
.symbolRenderingMode(.hierarchical)
.foregroundStyle(.blue)
Image(systemName: "cloud.rain.fill")
.symbolRenderingMode(.palette)
.foregroundStyle(.white, .blue)
.foregroundStyle(.red, .white, .blue)
Image(systemName: "cloud.rain.fill")
.symbolRenderingMode(.multicolor)
Image(systemName: "cloud.rain.fill")
.symbolRenderingMode(.monochrome)
SymbolRenderingMode Enum
| Value | Description |
|---|
.monochrome | Single color for all layers (default) |
.hierarchical | Single color with automatic opacity per layer |
.palette | Explicit color per layer via .foregroundStyle() |
.multicolor | Apple's fixed curated colors |
UIKit
let config = UIImage.SymbolConfiguration(hierarchicalColor: .systemBlue)
imageView.preferredSymbolConfiguration = config
let config = UIImage.SymbolConfiguration(paletteColors: [.white, .systemBlue])
imageView.preferredSymbolConfiguration = config
let config = UIImage.SymbolConfiguration.preferringMulticolor()
imageView.preferredSymbolConfiguration = config
imageView.tintColor = .systemBlue
Combining Configurations (UIKit)
let sizeConfig = UIImage.SymbolConfiguration(pointSize: 24, weight: .bold)
let colorConfig = UIImage.SymbolConfiguration(paletteColors: [.white, .blue, .gray])
let combined = sizeConfig.applying(colorConfig)
imageView.preferredSymbolConfiguration = combined
Part 3: Symbol Effects — Complete API
Effect Protocol Hierarchy
All symbol effects conform to SymbolEffect. Sub-protocols define behavior:
| Protocol | Trigger | Modifier | Loop |
|---|
DiscreteSymbolEffect | value: (Equatable) | .symbolEffect(_:options:value:) | No |
IndefiniteSymbolEffect | isActive: (Bool) | .symbolEffect(_:options:isActive:) | Yes |
TransitionSymbolEffect | View lifecycle | .transition(.symbolEffect(_:)) | No |
ContentTransitionSymbolEffect | Symbol change | .contentTransition(.symbolEffect(_:)) | No |
Remove All Effects (SwiftUI)
Image(systemName: "star.fill")
.symbolEffectsRemoved()
.symbolEffectsRemoved(false)
SymbolEffectOptions
.symbolEffect(.bounce, options: .speed(2.0), value: count)
.symbolEffect(.bounce, options: .repeat(3), value: count)
.symbolEffect(.pulse, options: .repeat(.continuous), isActive: true)
.symbolEffect(.breathe, options: .nonRepeating, isActive: true)
.symbolEffect(.wiggle, options: .repeat(5).speed(1.5), value: count)
Bounce
Protocols: DiscreteSymbolEffect
Image(systemName: "arrow.down.circle")
.symbolEffect(.bounce, value: downloadCount)
.symbolEffect(.bounce.up, value: count)
.symbolEffect(.bounce.down, value: count)
.symbolEffect(.bounce.byLayer, value: count)
.symbolEffect(.bounce.wholeSymbol, value: count)
UIKit:
imageView.addSymbolEffect(.bounce)
imageView.addSymbolEffect(.bounce, options: .repeat(3))
Pulse
Protocols: DiscreteSymbolEffect, IndefiniteSymbolEffect
Image(systemName: "network")
.symbolEffect(.pulse, isActive: isConnecting)
.symbolEffect(.pulse, value: errorCount)
.symbolEffect(.pulse.byLayer, isActive: true)
.symbolEffect(.pulse.wholeSymbol, isActive: true)
UIKit:
imageView.addSymbolEffect(.pulse)
imageView.removeSymbolEffect(ofType: PulseSymbolEffect.self)
Variable Color
Protocols: DiscreteSymbolEffect, IndefiniteSymbolEffect
Image(systemName: "wifi")
.symbolEffect(.variableColor.iterative, isActive: isSearching)
.symbolEffect(.variableColor.cumulative, isActive: true)
.symbolEffect(.variableColor.iterative.reversing, isActive: true)
.symbolEffect(.variableColor.iterative.hideInactiveLayers, isActive: true)
.symbolEffect(.variableColor.iterative.dimInactiveLayers, isActive: true)
UIKit:
imageView.addSymbolEffect(.variableColor.iterative)
imageView.removeSymbolEffect(ofType: VariableColorSymbolEffect.self)
Scale
Protocols: IndefiniteSymbolEffect
Image(systemName: "mic.fill")
.symbolEffect(.scale.up, isActive: isRecording)
.symbolEffect(.scale.down, isActive: isMuted)
.symbolEffect(.scale.up.byLayer, isActive: true)
.symbolEffect(.scale.up.wholeSymbol, isActive: true)
UIKit:
imageView.addSymbolEffect(.scale.up)
imageView.removeSymbolEffect(ofType: ScaleSymbolEffect.self)
Wiggle (iOS 18+)
Protocols: DiscreteSymbolEffect, IndefiniteSymbolEffect
Image(systemName: "bell.fill")
.symbolEffect(.wiggle, value: notificationCount)
.symbolEffect(.wiggle.left, value: count)
.symbolEffect(.wiggle.right, value: count)
.symbolEffect(.wiggle.forward, value: count)
.symbolEffect(.wiggle.backward, value: count)
.symbolEffect(.wiggle.up, value: count)
.symbolEffect(.wiggle.down, value: count)
.symbolEffect(.wiggle.clockwise, value: count)
.symbolEffect(.wiggle.counterClockwise, value: count)
.symbolEffect(.wiggle.custom(angle: .degrees(15)), value: count)
.symbolEffect(.wiggle.byLayer, value: count)
UIKit:
imageView.addSymbolEffect(.wiggle)
Rotate (iOS 18+)
Protocols: DiscreteSymbolEffect, IndefiniteSymbolEffect
Image(systemName: "gear")
.symbolEffect(.rotate, isActive: isProcessing)
.symbolEffect(.rotate.clockwise, isActive: true)
.symbolEffect(.rotate.counterClockwise, isActive: true)
.symbolEffect(.rotate.byLayer, isActive: true)
UIKit:
imageView.addSymbolEffect(.rotate)
imageView.removeSymbolEffect(ofType: RotateSymbolEffect.self)
Breathe (iOS 18+)
Protocols: DiscreteSymbolEffect, IndefiniteSymbolEffect
Image(systemName: "heart.fill")
.symbolEffect(.breathe, isActive: isMonitoring)
.symbolEffect(.breathe.plain, isActive: true)
.symbolEffect(.breathe.pulse, isActive: true)
.symbolEffect(.breathe.byLayer, isActive: true)
UIKit:
imageView.addSymbolEffect(.breathe)
imageView.removeSymbolEffect(ofType: BreatheSymbolEffect.self)
Appear and Disappear
Protocols: TransitionSymbolEffect
if showSymbol {
Image(systemName: "checkmark.circle.fill")
.transition(.symbolEffect(.appear))
}
if showSymbol {
Image(systemName: "xmark.circle.fill")
.transition(.symbolEffect(.disappear))
}
.transition(.symbolEffect(.appear.up))
.transition(.symbolEffect(.appear.down))
.transition(.symbolEffect(.disappear.up))
.transition(.symbolEffect(.disappear.down))
.transition(.symbolEffect(.appear.byLayer))
.transition(.symbolEffect(.appear.wholeSymbol))
UIKit (as effect, not transition):
imageView.addSymbolEffect(.appear)
imageView.addSymbolEffect(.disappear)
imageView.addSymbolEffect(.appear)
Replace
Protocols: ContentTransitionSymbolEffect
Image(systemName: isFavorite ? "star.fill" : "star")
.contentTransition(.symbolEffect(.replace))
.contentTransition(.symbolEffect(.replace.downUp))
.contentTransition(.symbolEffect(.replace.upUp))
.contentTransition(.symbolEffect(.replace.offUp))
.contentTransition(.symbolEffect(.replace.byLayer))
.contentTransition(.symbolEffect(.replace.wholeSymbol))
.contentTransition(.symbolEffect(.replace))
.contentTransition(.symbolEffect(.replace.magic(fallback: .replace.downUp)))
UIKit:
let newImage = UIImage(systemName: "star.fill")
imageView.setSymbolImage(newImage!, contentTransition: .replace)
imageView.setSymbolImage(newImage!, contentTransition: .replace.downUp)
Part 4: Draw Effects (iOS 26+)
Draw On
Image(systemName: "checkmark.circle")
.symbolEffect(.drawOn, isActive: isComplete)
.symbolEffect(.drawOn.byLayer, isActive: isActive)
.symbolEffect(.drawOn.wholeSymbol, isActive: isActive)
.symbolEffect(.drawOn.individually, isActive: isActive)
.symbolEffect(.drawOn, options: .speed(2.0), isActive: isActive)
.symbolEffect(.drawOn, options: .nonRepeating, isActive: isActive)
Draw Off
Image(systemName: "star.fill")
.symbolEffect(.drawOff, isActive: isHidden)
.symbolEffect(.drawOff.byLayer, isActive: isActive)
.symbolEffect(.drawOff.wholeSymbol, isActive: isActive)
.symbolEffect(.drawOff.individually, isActive: isActive)
.symbolEffect(.drawOff.nonReversed, isActive: isActive)
.symbolEffect(.drawOff.reversed, isActive: isActive)
UIKit Draw Effects
imageView.addSymbolEffect(.drawOn)
imageView.addSymbolEffect(.drawOff)
imageView.removeSymbolEffect(ofType: DrawOnSymbolEffect.self)
Variable Draw
Uses SymbolVariableValueMode to control how variable values are rendered.
Image(systemName: "thermometer.high", variableValue: temperature)
.symbolVariableValueMode(.draw)
Image(systemName: "wifi", variableValue: signalStrength)
.symbolVariableValueMode(.color)
SymbolVariableValueMode Enum (iOS 26+)
| Case | Description |
|---|
.color | Sets opacity of each variable layer on/off based on threshold (existing behavior) |
.draw | Changes drawn length of each variable layer based on range |
Constraint: Some symbols support only one mode. Setting an unsupported mode has no visible effect. A symbol cannot use both Variable Color and Variable Draw simultaneously.
Gradient Rendering (iOS 26+)
Uses SymbolColorRenderingMode for automatic gradient generation from a single color.
Image(systemName: "heart.fill")
.symbolColorRenderingMode(.gradient)
.foregroundStyle(.red)
Image(systemName: "cloud.rain.fill")
.symbolRenderingMode(.hierarchical)
.symbolColorRenderingMode(.gradient)
.foregroundStyle(.blue)
SymbolColorRenderingMode Enum (iOS 26+)
| Case | Description |
|---|
.flat | Solid color fill (default) |
.gradient | Axial gradient generated from source color |
Gradients are most effective at larger symbol sizes and work across all rendering modes.
Part 5: Content Transition Patterns
Symbol Swap with Replace
struct PlayPauseButton: View {
@State private var isPlaying = false
var body: some View {
Button {
isPlaying.toggle()
} label: {
Image(systemName: isPlaying ? "pause.fill" : "play.fill")
.contentTransition(.symbolEffect(.replace))
}
.accessibilityLabel(isPlaying ? "Pause" : "Play")
}
}
Download Progress Pattern
struct DownloadButton: View {
@State private var state: DownloadState = .idle
var symbolName: String {
switch state {
case .idle: "arrow.down.circle"
case .downloading: "stop.circle"
case .complete: "checkmark.circle.fill"
}
}
var body: some View {
Button {
advanceState()
} label: {
Image(systemName: symbolName)
.contentTransition(.symbolEffect(.replace))
.symbolEffect(.pulse, isActive: state == .downloading)
}
}
}
Toggle with Effect Feedback
struct FavoriteButton: View {
@Binding var isFavorite: Bool
@State private var bounceValue = 0
var body: some View {
Button {
isFavorite.toggle()
bounceValue += 1
} label: {
Image(systemName: isFavorite ? "star.fill" : "star")
.contentTransition(.symbolEffect(.replace))
.symbolEffect(.bounce, value: bounceValue)
.foregroundStyle(isFavorite ? .yellow : .gray)
}
}
}
Part 6: Custom Symbols
Template Structure
Custom symbols are SVG files with specific layer annotations:
- Export from design tool as SVG
- Import into SF Symbols app (File > Import)
- Set template type: Monochrome, Hierarchical, Multicolor, or Variable Color
- Annotate layers for rendering modes:
- Primary layer: Full opacity in Hierarchical
- Secondary layer: Reduced opacity in Hierarchical
- Tertiary layer: Most reduced opacity in Hierarchical
- Set Palette colors per layer if supporting Palette mode
- Export as
.svg template for Xcode
Draw Annotation (SF Symbols 7)
To enable Draw animations on custom symbols:
- Select a path in SF Symbols 7 app
- Open the Draw annotation panel
- Place guide points on the path:
| Point Type | Visual | Purpose |
|---|
| Start | Open circle | Where drawing begins |
| End | Closed circle | Where drawing ends |
| Corner | Diamond | Sharp direction change |
| Bidirectional | Double arrow | Center-outward drawing |
| Attachment | Link icon | Non-drawing decorative connection |
- Minimum: 2 guide points per path (start + end)
- Option-drag for precise placement
- Test in Preview panel across all weights
Weight Interpolation
Custom symbols should include designs for at least 3 weight variants:
- Ultralight (thinnest)
- Regular (middle)
- Black (thickest)
The system interpolates between these for intermediate weights (Thin, Light, Medium, Semibold, Bold, Heavy).
Importing to Xcode
- In Xcode, open Asset Catalog
- Click + > Symbol Image Set
- Drag exported
.svg from SF Symbols app
- Asset catalog symbols:
Image("custom.symbol.name"). For symbols loaded from a bundle: Image(systemName: "custom.symbol.name", bundle: .module)
Part 7: Platform Availability Matrix
Rendering Modes
| Feature | iOS | macOS | watchOS | tvOS | visionOS |
|---|
| Monochrome | 13+ | 11+ | 6+ | 13+ | 1+ |
| Hierarchical | 15+ | 12+ | 8+ | 15+ | 1+ |
| Palette | 15+ | 12+ | 8+ | 15+ | 1+ |
| Multicolor | 15+ | 12+ | 8+ | 15+ | 1+ |
| Variable Value | 16+ | 13+ | 9+ | 16+ | 1+ |
Symbol Effects
| Effect | Category | iOS | macOS | watchOS | tvOS | visionOS |
|---|
| Bounce | Discrete | 17+ | 14+ | 10+ | 17+ | 1+ |
| Pulse | Discrete/Indefinite | 17+ | 14+ | 10+ | 17+ | 1+ |
| Variable Color | Discrete/Indefinite | 17+ | 14+ | 10+ | 17+ | 1+ |
| Scale | Indefinite | 17+ | 14+ | 10+ | 17+ | 1+ |
| Appear | Transition | 17+ | 14+ | 10+ | 17+ | 1+ |
| Disappear | Transition | 17+ | 14+ | 10+ | 17+ | 1+ |
| Replace | Content Transition | 17+ | 14+ | 10+ | 17+ | 1+ |
| Wiggle | Discrete/Indefinite | 18+ | 15+ | 11+ | 18+ | 2+ |
| Rotate | Discrete/Indefinite | 18+ | 15+ | 11+ | 18+ | 2+ |
| Breathe | Discrete/Indefinite | 18+ | 15+ | 11+ | 18+ | 2+ |
| Draw On | Indefinite | 26+ | Tahoe+ | 26+ | 26+ | 26+ |
| Draw Off | Indefinite | 26+ | Tahoe+ | 26+ | 26+ | 26+ |
| Variable Draw | Value-based | 26+ | Tahoe+ | 26+ | 26+ | 26+ |
| Gradient Fill | Rendering | 26+ | Tahoe+ | 26+ | 26+ | 26+ |
Effect Behavior Categories
| Category | What It Does | How to Trigger |
|---|
| Discrete | One-shot animation, returns to rest | .symbolEffect(_:value:) — fires when value changes |
| Indefinite | Loops while active | .symbolEffect(_:isActive:) — loops while true |
| Transition | Plays on view insert/remove | .transition(.symbolEffect(_:)) |
| Content Transition | Plays when symbol changes | .contentTransition(.symbolEffect(_:)) |
Part 8: UIKit Complete Reference
Adding Effects
imageView.addSymbolEffect(.pulse)
imageView.addSymbolEffect(.breathe)
imageView.addSymbolEffect(.rotate)
imageView.addSymbolEffect(.variableColor.iterative)
imageView.addSymbolEffect(.scale.up)
imageView.addSymbolEffect(.bounce, options: .repeat(3))
imageView.addSymbolEffect(.pulse, options: .speed(2.0))
imageView.addSymbolEffect(.bounce, options: .default) { context in
print("Bounce complete")
}
Removing Effects
imageView.removeSymbolEffect(ofType: PulseSymbolEffect.self)
imageView.removeSymbolEffect(ofType: ScaleSymbolEffect.self)
imageView.removeSymbolEffect(ofType: RotateSymbolEffect.self)
imageView.removeAllSymbolEffects()
imageView.removeSymbolEffect(ofType: PulseSymbolEffect.self, options: .default)
imageView.removeSymbolEffect(ofType: PulseSymbolEffect.self) { context in
print("Pulse removed")
}
Setting Symbol Images with Transitions
let newImage = UIImage(systemName: "pause.fill")!
imageView.setSymbolImage(newImage, contentTransition: .replace)
imageView.setSymbolImage(newImage, contentTransition: .replace.downUp)
imageView.setSymbolImage(newImage, contentTransition: .replace.upUp)
imageView.setSymbolImage(newImage, contentTransition: .replace.offUp)
imageView.setSymbolImage(newImage, contentTransition: .replace, options: .speed(2.0))
UIBarButtonItem Effects
barButtonItem.addSymbolEffect(.bounce)
barButtonItem.addSymbolEffect(.pulse, isActive: isLoading)
barButtonItem.removeSymbolEffect(ofType: PulseSymbolEffect.self)
Part 9: Accessibility
Labels
Image(systemName: "star.fill")
.accessibilityLabel("Favorite")
let image = UIImage(systemName: "star.fill")
imageView.accessibilityLabel = "Favorite"
imageView.isAccessibilityElement = true
Label("Settings", systemImage: "gear")
Reduce Motion
Symbol effects automatically respect UIAccessibility.isReduceMotionEnabled. When Reduce Motion is on:
- Most effects are simplified or suppressed
- Replace transitions use crossfade instead of directional movement
- Indefinite effects may be simplified to static appearance changes
Do not attempt to override or check this yourself for effects. The system handles it. Only intervene if effects carry semantic meaning:
Image(systemName: "wifi")
.symbolEffect(.pulse, isActive: isConnecting)
.accessibilityLabel(isConnecting ? "Connecting to WiFi" : "WiFi connected")
Bold Text
SF Symbols automatically adapt when Bold Text is enabled in Accessibility settings. Custom symbols need weight variants to support this properly.
Dynamic Type
Symbols sized with .font() scale automatically with Dynamic Type. Symbols sized with explicit point sizes (.font(.system(size: 24))) do not scale.
Image(systemName: "star.fill")
.font(.title)
Image(systemName: "star.fill")
.font(.system(size: 24))
Part 10: Common Patterns
Notification Badge with Effect
struct NotificationBell: View {
let count: Int
var body: some View {
Image(systemName: count > 0 ? "bell.badge.fill" : "bell.fill")
.contentTransition(.symbolEffect(.replace))
.symbolEffect(.wiggle, value: count)
.symbolRenderingMode(.palette)
.foregroundStyle(count > 0 ? .red : .primary, .primary)
}
}
WiFi Strength Indicator
struct WiFiIndicator: View {
let strength: Double
let isSearching: Bool
var body: some View {
Image(systemName: "wifi", variableValue: strength)
.symbolEffect(.variableColor.iterative, isActive: isSearching)
.symbolRenderingMode(.hierarchical)
.accessibilityLabel(
isSearching ? "Searching for WiFi" :
"WiFi strength: \(Int(strength * 100))%"
)
}
}
Animated Toggle
struct RecordButton: View {
@State private var isRecording = false
var body: some View {
Button {
isRecording.toggle()
} label: {
Image(systemName: isRecording ? "stop.circle.fill" : "record.circle")
.contentTransition(.symbolEffect(.replace))
.symbolEffect(.breathe.pulse, isActive: isRecording)
.font(.largeTitle)
.foregroundStyle(isRecording ? .red : .primary)
}
.accessibilityLabel(isRecording ? "Stop recording" : "Start recording")
}
}
Multi-State Symbol with Draw (iOS 26+)
struct TaskCheckbox: View {
@State private var isComplete = false
var body: some View {
Button {
isComplete.toggle()
} label: {
Image(systemName: isComplete ? "checkmark.circle.fill" : "circle")
.contentTransition(.symbolEffect(.replace))
.symbolEffect(.drawOn, isActive: isComplete)
.font(.title2)
.foregroundStyle(isComplete ? .green : .secondary)
}
.accessibilityLabel(isComplete ? "Completed" : "Not completed")
}
}
Resources
WWDC: 2023-10257, 2023-10258, 2024-10188, 2025-337
Docs: /symbols, /symbols/symboleffect, /symbols/bouncesymboleffect, /symbols/pulsesymboleffect, /symbols/variablecolorsymboleffect, /symbols/scalesymboleffect, /symbols/wigglesymboleffect, /symbols/rotatesymboleffect, /symbols/breathesymboleffect, /symbols/appearsymboleffect, /symbols/disappearsymboleffect, /symbols/replacesymboleffect, /symbols/drawonsymboleffect, /symbols/drawoffsymboleffect, /swiftui/image/symbolrenderingmode(_:), /uikit/uiimage/symbolconfiguration
Skills: axiom-sf-symbols, axiom-hig-ref, axiom-swiftui-animation-ref
Last Updated Based on WWDC 2023/10257-10258, WWDC 2024/10188, WWDC 2025/337
Version iOS 13+ (display), iOS 15+ (rendering modes), iOS 17+ (effects), iOS 18+ (Wiggle/Rotate/Breathe), iOS 26+ (Draw, Gradients)