Contents

removeSymbolEffect(ofType:options:animated:completion:)

Removes the symbol effect that matches the specified indefinite effect type, using the specified options and animation setting.

Declaration

@MainActor @preconcurrency func removeSymbolEffect(ofType effect: some IndefiniteSymbolEffect & SymbolEffect, options: SymbolEffectOptions = .default, animated: Bool = true, completion: UISymbolEffectCompletion? = nil)

Parameters

  • effect:

    The symbol effect to match for removal.

  • options:

    The options to use when removing the symbol effect.

  • animated:

    A Boolean value that indicates whether to animate the removal of a scale, appear, or disappear effect.

  • completion:

    A completion handler the system calls after the removal is complete.

See Also

Configuring symbol effects