A wrapper for ScrollViewProxy/scrollTo that works around a bug where withAnimation doesn't always work

ScrollViewProxy+ScrollToAnimated.swift

//
//  ScrollViewProxy+ScrollToAnimated.swift
//
//  Created by Drew Olbrich on 5/11/24.
//  Copyright © 2024 Lunar Skydiving LLC. All rights reserved.
//
//  MIT License
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in all
//  copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//  SOFTWARE.
//

import SwiftUI

extension ScrollViewProxy {
    
    /// A wrapper around `ScrollViewProxy/scrollTo(:anchor:)` that adds an `animated`
    /// parameter.
    ///
    /// This wrapper provides a workaround for a bug where `withAnimation` has no effect
    /// on `scrollTo`. This bug has reappeared in new releases of SwiftUI multiple
    /// times, so it's presumably safer to use this wrapper instead of calling
    /// `withAnimation` and `scrollTo` directly.
    ///
    /// ## Example Usage:
    /// ```
    /// scrollViewProxy.scrollTo(id, animated: true)
    /// ```
    func scrollTo<ID>(_ id: ID, anchor: UnitPoint? = nil, animated: Bool, animation: Animation? = .default) where ID: Hashable {
        if animated {
            // In visionOS 1.2, if we don't use `DispatchQueue.main.async` here,
            // `withAnimation` has no effect.
            DispatchQueue.main.async {
                withAnimation(animation) {
                    scrollTo(id, anchor: anchor)
                }
            }
        } else {
            scrollTo(id, anchor: anchor)
        }
    }
    
}