From 9bb00d50bdfa3c3bedf2be6cfec72b5d4f06eba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20B=C3=B6hnke?= Date: Thu, 13 Oct 2022 16:07:57 +0200 Subject: [PATCH] Update Docs for Vanish --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1a6503..d03c748 100644 --- a/README.md +++ b/README.md @@ -472,7 +472,7 @@ A transition that dissolves the view into many small particles. The transition is only performed on removal. > **Note:** -> This transition will use an ease-out animation with a duration of 900ms by default. +> This transition will use an ease-out animation with a duration of 900ms if the current `Animation` is `.default`. ```swift static var vanish: AnyTransition @@ -483,7 +483,7 @@ A transition that dissolves the view into many small particles. The transition is only performed on removal. > **Note:** -> This transition will use an ease-out animation with a duration of 900ms by default. +> This transition will use an ease-out animation with a duration of 900ms if the current `Animation` is `.default`. - Parameter `style`: The style to use for the particles. @@ -491,6 +491,21 @@ The transition is only performed on removal. static func vanish(_ style: S) -> AnyTransition ``` +A transition that dissolves the view into many small particles following a given shape. + +The transition is only performed on removal. + +> **Note:** +> This transition will use an ease-out animation with a duration of 900ms if the current `Animation` is `.default`. + +- Parameter `style`: The style to use for the particles. +- Parameter `mask`: The mask that determines where particles should be placed. +- Parameter `eoFill`: A Boolean that indicates whether the shape is interpreted with the even-odd winding number rule. + +```swift +static func vanish(_ style: T, mask: S, eoFill: Bool = false) -> AnyTransition +``` + ### Wipe [Preview](https://movingparts.io/pow/#wipe)