Skip to content

SF Symbols Reference

Complete API reference for SF Symbols rendering modes, animation effects, configuration options, and UIKit/AppKit equivalents. Covers iOS 13 symbol display through iOS 26 Draw animations and gradient rendering.

When to Use This Reference

Use this reference when:

  • You need exact API signatures for rendering modes or symbol effects
  • You need UIKit/AppKit equivalents for SwiftUI symbol APIs
  • You need platform availability for a specific feature
  • You need configuration options (weight, scale, variable values)
  • You need custom symbol template structure and Draw annotation details

Example Prompts

Questions you can ask Claude that will draw from this reference:

  • "What's the exact SwiftUI modifier for Hierarchical rendering?"
  • "How do I add a Bounce effect in UIKit?"
  • "Which symbol effects are available on iOS 17 vs iOS 18?"
  • "How do I combine rendering mode with symbol effects?"
  • "What's the UIKit equivalent of .contentTransition(.symbolEffect(.replace))?"
  • "How do I create a custom symbol with Draw animation support?"

What's Covered

  • Symbol display — SwiftUI, UIKit, and AppKit configuration APIs
  • Rendering modes — All 4 modes with complete SwiftUI and UIKit signatures
  • Symbol effects — 12+ effects (Bounce through Draw On/Off) with options and protocols
  • UIKit referenceaddSymbolEffect(), removeSymbolEffect(), setSymbolImage(), completion handlers
  • Custom symbols — Template structure, Draw annotation, weight interpolation
  • Platform availability matrix — iOS 13+ through iOS 26+, cross-platform
  • Accessibility — Labels, Reduce Motion, Bold Text, Dynamic Type
  • Common patterns — Notification badge, WiFi strength, play/pause, download progress

Documentation Scope

This page documents the axiom-sf-symbols-ref skill — the comprehensive API reference Claude uses for SF Symbols implementation details.

For decision guidance: See SF Symbols for rendering mode decision trees, effect selection guidance, anti-patterns, and troubleshooting.

  • SF Symbols — Decision trees, anti-patterns, troubleshooting, pressure scenarios
  • SwiftUI Animation — General animation reference (VectorArithmetic, @Animatable, springs)
  • HIG Reference — Icon and symbol design guidelines
  • Typography — SF Pro font that symbols are designed to match

Resources

WWDC: 2023-10257, 2023-10258, 2024-10188, 2025-337

Docs: /symbols, /symbols/symboleffect, /symbols/symbolrenderingmode, /uikit/uiimage/symbolconfiguration

Released under the MIT License