Symbols · IOS API REFERENCE

ReplaceSymbolEffect

struct · iOS 17.0+ · SDK 27.1

struct ReplaceSymbolEffect

A symbol effect that animates the replacement of one symbol image with another.

Members (10)

get · iOS 17.0+

wholeSymbol

TypeScript

get wholeSymbol(): ReplaceSymbolEffect

Swift declaration

var wholeSymbol: ReplaceSymbolEffect { get }

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

get · iOS 17.0+

configuration

TypeScript

get configuration(): SymbolEffectConfiguration

Swift declaration

var configuration: SymbolEffectConfiguration { get }

The configuration for the effect.

get · iOS 17.0+

upUp

TypeScript

get upUp(): ReplaceSymbolEffect

Swift declaration

var upUp: ReplaceSymbolEffect { get }

Returns a copy of the effect requesting the Up-Up variant of the Replace animation. The initial symbol scales up as it is removed, and the new symbol scales up as it is added.

get · iOS 18.0+

upUp

TypeScript

static get upUp31977(): ReplaceSymbolEffect

Swift declaration

static var upUp: ReplaceSymbolEffect { get }

Returns an effect requesting the Up-Up variant of the Replace animation. The initial symbol scales up as it is removed, and the new symbol scales up as it is added.

method · iOS 18.0+

magic

TypeScript

magic(fallback: ReplaceSymbolEffect): ReplaceSymbolEffect_MagicReplace

Swift declaration

func magic(fallback: ReplaceSymbolEffect) -> ReplaceSymbolEffect.MagicReplace

Returns an effect preferring MagicReplace and a configured ReplaceEffect if MagicReplace is not possible.

get · iOS 17.0+

offUp

TypeScript

get offUp(): ReplaceSymbolEffect

Swift declaration

var offUp: ReplaceSymbolEffect { get }

Returns a copy of the effect requesting the Off-Up variant of the Replace animation. The initial symbol is removed with no animation, and the new symbol scales up as it is added.

get · iOS 18.0+

offUp

TypeScript

static get offUp97284(): ReplaceSymbolEffect

Swift declaration

static var offUp: ReplaceSymbolEffect { get }

Returns an effect requesting the Off-Up variant of the Replace animation. The initial symbol is removed with no animation, and the new symbol scales up as it is added.

get · iOS 17.0+

downUp

TypeScript

get downUp(): ReplaceSymbolEffect

Swift declaration

var downUp: ReplaceSymbolEffect { get }

Returns a copy of the effect requesting the Down-Up variant of the Replace animation. The initial symbol scales down as it is removed, and the new symbol scales up as it is added.

get · iOS 18.0+

downUp

TypeScript

static get downUp4288(): ReplaceSymbolEffect

Swift declaration

static var downUp: ReplaceSymbolEffect { get }

Returns an effect requesting the Down-Up variant of the Replace animation. The initial symbol scales down as it is removed, and the new symbol scales up as it is added.

get · iOS 17.0+

byLayer

TypeScript

get byLayer(): ReplaceSymbolEffect

Swift declaration

var byLayer: ReplaceSymbolEffect { get }

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

Skipped declarations

No declarations were skipped in this snapshot.

All Symbols types →