AnimateText for SwiftUI

This library for animating text. Developed with SwiftUI. This library supports iOS/macOS.

Screenshot

Example

https://fabulaapp.page.link/224

Usages

1. AnimateText

   /// A view that animates binding text. Passing the effect type as a generic.
   /// struct AnimateText<E> where E : ATTextAnimateEffect
   /// Binding the text to be expressed.
   @State var text: String = "AnimateText"
   
   /// The type used to split text.
   @State var type: ATUnitType = .letters
   
   /// Custom user info for the effect.
   @State var userInfo: Any? = nil
   
   AnimateText<CustomEffect>($text, type: type, userInfo: userInfo)
   

2. Each effect only needs to conform to the ATTextAnimateEffect protocol.

   /// Custom animation effect.
   public struct CustomEffect: ATTextAnimateEffect {
   
       public var data: ATElementData
       public var userInfo: Any?
   
       public init(_ data: ATElementData, _ userInfo: Any?) {
           self.data = data
           self.userInfo = userInfo
       }
   
       public func body(content: Content) -> some View {
           content
               .opacity(data.value)
               .animation(.easeInOut.delay(Double(data.index) * 0.06), value: data.value)
       }
   }

3. ATTextAnimateEffect protocol

   /// A protocol to implement text animation effects.
   public protocol ATTextAnimateEffect: ViewModifier {
   
       /// Informational data required for each element animation.
       var data: ATElementData { get }
       /// Custom user info for the effect.
       /// The effect maintains a strong reference to this object until it (the effect) is invalidated. This parameter may be nil.
       var userInfo: Any? { get }
   
       init(_ data: ATElementData, _ userInfo: Any?)
   }
   

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. Once you have your Swift package set up, adding AnimateText as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/jasudev/AnimateText.git", .branch("main"))
]

Contact

instagram : @dev.fabula
email : [email protected]

License

AnimateText is available under the MIT license. See the LICENSE file for more info.