Symbols · IOS API REFERENCE

BreatheSymbolEffect

struct · iOS 18.0+ · SDK 27.1

struct BreatheSymbolEffect

A symbol effect that applies the Breathe animation to symbol images. The Breathe animation smoothly scales a symbol up and down.

Members (5)

get · iOS 18.0+

TypeScript

get wholeSymbol(): BreatheSymbolEffect

Swift declaration

var wholeSymbol: BreatheSymbolEffect { get }

Returns a copy of the effect requesting an animation that applies to all motion groups simultaneously.

get · iOS 18.0+

TypeScript

get configuration(): SymbolEffectConfiguration

Swift declaration

var configuration: SymbolEffectConfiguration { get }

The configuration for the effect.

get · iOS 18.0+

TypeScript

get plain(): BreatheSymbolEffect

Swift declaration

var plain: BreatheSymbolEffect { get }

Returns a copy of the effect requesting an animation that makes the symbol breathe with no additional styling.

get · iOS 18.0+

TypeScript

get pulse(): BreatheSymbolEffect

Swift declaration

var pulse: BreatheSymbolEffect { get }

Returns a copy of the effect requesting an animation that pulses layers as they breathe.

get · iOS 18.0+

TypeScript

get byLayer(): BreatheSymbolEffect

Swift declaration

var byLayer: BreatheSymbolEffect { get }

Returns a copy of the effect requesting an animation that applies separately to each motion group.

No declarations were skipped in this snapshot.