Symbols defines the symbol effects that animate SF Symbols images across the system. You apply effects such as AppearSymbolEffect, BounceSymbolEffect, PulseSymbolEffect, ReplaceSymbolEffect, and VariableColorSymbolEffect to convey state and motion, and configure their behavior with SymbolEffectOptions and SymbolEffectConfiguration. Effects conform to protocols including SymbolEffect, DiscreteSymbolEffect, IndefiniteSymbolEffect, ContentTransitionSymbolEffect, and TransitionSymbolEffect, which describe how each animation runs and combines. The framework is available on iOS, macOS, tvOS, watchOS, and visionOS.
Effect Protocols 5
Protocols that describe how a symbol effect runs, transitions, and combines with others.
- PrSymbolEffectiOS 17.0+A presentation effect that can be applied to an SFSymbol.
- PrDiscreteSymbolEffectiOS 17.0+A symbol effect that can perform a transient animation.
- PrIndefiniteSymbolEffectiOS 17.0+A symbol effect that continually affects how a symbol is drawn
- PrContentTransitionSymbolEffectiOS 17.0+A symbol effect that animates between symbols or between different
- PrTransitionSymbolEffectiOS 17.0+A symbol effect that animates a symbol in or out.
Motion Effects 6
Effects that animate an SF Symbol in place to convey activity or draw attention.
- StBounceSymbolEffectiOS 17.0+A symbol effect that applies the Bounce animation to
- StPulseSymbolEffectiOS 17.0+A symbol effect that applies the Pulse animation to
- StBreatheSymbolEffectiOS 18.0+A symbol effect that applies the Breathe animation to
- StRotateSymbolEffectiOS 18.0+A symbol effect that applies the Rotate animation to
- StWiggleSymbolEffectiOS 18.0+A symbol effect that applies the Wiggle animation to symbol images.
- StVariableColorSymbolEffectiOS 17.0+A symbol effect that applies the Variable Color
Appearance and Transition Effects 7
Effects that show, hide, scale, draw, or swap a symbol as its content changes.
- StAppearSymbolEffectiOS 17.0+A symbol effect that applies the Appear animation to symbol images.
- StDisappearSymbolEffectiOS 17.0+A symbol effect that applies the Disappear animation to symbol
- StScaleSymbolEffectiOS 17.0+A symbol effect that scales symbol images.
- StReplaceSymbolEffectiOS 17.0+A symbol effect that animates the replacement of one symbol image
- StDrawOnSymbolEffectiOS 26.0+A symbol effect that applies the DrawOn animation to symbol images.
- StDrawOffSymbolEffectiOS 26.0+A symbol effect that applies the DrawOff animation to symbol images.
- StAutomaticSymbolEffectiOS 17.0+The default symbol effect, resolves to a particular effect in a
Configuration and Options 2
Types that configure how an effect plays, including timing, repetition, and behavior.
- StSymbolEffectOptionsiOS 17.0+Options configuring how symbol effects apply to symbol views.
- StSymbolEffectConfigurationiOS 17.0+A configuration for an SFSymbol effect.