<!--
{
  "availability" : [
    "iOS: 18.2.0 -",
    "iPadOS: 18.2.0 -",
    "macCatalyst: 18.2.0 -",
    "visionOS: 2.4.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "UIKit",
  "identifier" : "/documentation/UIKit/UIWritingToolsCoordinator/AnimationParameters",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "UIKit"
    ],
    "preciseIdentifier" : "c:objc(cs)UIWritingToolsCoordinatorAnimationParameters"
  },
  "title" : "UIWritingToolsCoordinator.AnimationParameters"
}
-->

# UIWritingToolsCoordinator.AnimationParameters

An object you use to configure additional tasks or animations to
run alongside the Writing Tools animations.

```
class AnimationParameters
```

## Overview

When Writing Tools replaces text in one of your context objects,
it provides a `UIWritingToolsCoordinator.AnimationParameters` object for
you to use to configure any additional animations. During a Writing
Tools session, you hide the text under evaluation and provide a
targeted preview of your content. Writing Tools animations changes
to that preview, but you might need to provide additional animations
for other parts of your view’s content. For example, you might
need to animate any layout changes caused by the insertion or
removal of text in other parts of your view. Use this object to
configure those animations.

You don’t create a `UIWritingToolsCoordinator.AnimationParameters`
object directly. Instead, the system creates one and passes it to the
`UIWritingToolsCoordinator/writingToolsCoordinator(_:replaceRange:inContext:proposedText:reason:animationParameters:completion:)`
method of your [`UIWritingToolsCoordinator.Delegate`](/documentation/UIKit/UIWritingToolsCoordinator/Delegate-swift.protocol) object. Use that
object to specify the blocks to run during and after the system animations.

## Topics

### Getting the animation values

[`var duration: CGFloat`](/documentation/UIKit/UIWritingToolsCoordinator/AnimationParameters/duration)

The number of seconds it takes the system animations to run.

[`var delay: CGFloat`](/documentation/UIKit/UIWritingToolsCoordinator/AnimationParameters/delay)

The number of seconds the system waits before starting its animations.

### Creating custom animations

[`var progressHandler: ((Float) -> Void)?`](/documentation/UIKit/UIWritingToolsCoordinator/AnimationParameters/progressHandler)

A custom block that runs at the same time as the system animations.

[`var completionHandler: (() -> Void)?`](/documentation/UIKit/UIWritingToolsCoordinator/AnimationParameters/completionHandler)

A custom block to run when the system animations finish.

## Relationships

### Conforms To

[`Hashable`](/documentation/Swift/Hashable)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`Sendable`](/documentation/Swift/Sendable)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`CVarArg`](/documentation/Swift/CVarArg)

[`Equatable`](/documentation/Swift/Equatable)

### Inherits From

[`NSObject-swift.class`](/documentation/ObjectiveC/NSObject-swift.class)

---

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)