<!--
{
  "availability" : [
    "iOS: 17.0.0 -",
    "iPadOS: 17.0.0 -",
    "macCatalyst: -",
    "macOS: 14.0.0 -",
    "tvOS: 17.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 10.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Symbols",
  "identifier" : "/documentation/Symbols/ReplaceSymbolEffect",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Symbols"
    ],
    "preciseIdentifier" : "s:7Symbols19ReplaceSymbolEffectV"
  },
  "title" : "ReplaceSymbolEffect"
}
-->

# ReplaceSymbolEffect

A type that replaces the layers of one symbol-based image with those of another.

```
struct ReplaceSymbolEffect
```

## Overview

A replace transition animates the change from one symbol image to another. You choose from one of the predefined scaling animations: Down-Up, Off-Up, and Up-Up.

- Down-Up: The initial symbol scales down as it’s removed, and the new symbol scales up as it’s added.
- Off-Up: The initial symbol is removed with no animation, and the new symbol scales up as it’s added.
- Up-Up: The initial symbol scales up as it’s removed, and the new symbol scales up as it’s added.

## Topics

### Accessing symbol effects

[`downUp`](/documentation/Symbols/ReplaceSymbolEffect/downUp-swift.property)

An effect that replaces a symbol by scaling it down, and scaling a different symbol up.

[`offUp`](/documentation/Symbols/ReplaceSymbolEffect/offUp-swift.property)

An effect that replaces a symbol by removing it, and scaling a different symbol up.

[`upUp`](/documentation/Symbols/ReplaceSymbolEffect/upUp-swift.property)

An effect that replaces a symbol by scaling it up, and scaling a different symbol up.

### Determining effect scope

[`byLayer`](/documentation/Symbols/ReplaceSymbolEffect/byLayer)

An effect that replaces each layer separately.

[`wholeSymbol`](/documentation/Symbols/ReplaceSymbolEffect/wholeSymbol)

An effect that replaces all layers simultaneously.

### Accessing the configuration

[`configuration`](/documentation/Symbols/ReplaceSymbolEffect/configuration)

The configuration for the effect.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)