<!--
{
  "availability" : [
    "iOS: 13.0.0 -",
    "iPadOS: 13.0.0 -",
    "macCatalyst: 13.1.0 -",
    "tvOS: 17.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "UIKit",
  "identifier" : "/documentation/UIKit/UIPreviewParameters",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "UIKit"
    ],
    "preciseIdentifier" : "c:objc(cs)UIPreviewParameters"
  },
  "title" : "UIPreviewParameters"
}
-->

# UIPreviewParameters

Additional parameters to use when animating a preview interface.

```
@MainActor class UIPreviewParameters
```

## Topics

### Creating preview parameters

[`-  init`](/documentation/UIKit/UIPreviewParameters/init())

Creates a default set of preview parameters.

[`-  initWithTextLineRects:`](/documentation/UIKit/UIPreviewParameters/init(textLineRects:))

Creates a preview parameters object with information about the text you want to preview.

### Configuring the preview attributes

[`backgroundColor`](/documentation/UIKit/UIPreviewParameters/backgroundColor)

The background color to display behind the preview.

[`visiblePath`](/documentation/UIKit/UIPreviewParameters/visiblePath)

The portion of the view to show in the preview.

[`shadowPath`](/documentation/UIKit/UIPreviewParameters/shadowPath)

The path to use for drawing the preview’s shadow.

## Relationships

### Conforms To

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

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

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

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

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

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

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

[`NSCopying`](/documentation/Foundation/NSCopying)

### Inherits From

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

### Inherited By

[`UIDragPreviewParameters`](/documentation/UIKit/UIDragPreviewParameters)

---

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)