https://github.com/jasudev/animatetext
This library for animating text. Developed with SwiftUI. This library supports iOS/macOS.
https://github.com/jasudev/animatetext
animation ios macos swift swiftui swiftui-framework swiftui-libraries swiftui-library text text-animation text-animations typography
Last synced: 3 months ago
JSON representation
This library for animating text. Developed with SwiftUI. This library supports iOS/macOS.
- Host: GitHub
- URL: https://github.com/jasudev/animatetext
- Owner: jasudev
- License: mit
- Created: 2022-02-08T14:07:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-13T20:51:24.000Z (over 1 year ago)
- Last Synced: 2025-03-30T11:07:25.659Z (4 months ago)
- Topics: animation, ios, macos, swift, swiftui, swiftui-framework, swiftui-libraries, swiftui-library, text, text-animation, text-animations, typography
- Language: Swift
- Homepage:
- Size: 35.2 KB
- Stars: 354
- Watchers: 6
- Forks: 36
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **AnimateText for SwiftUI**
This library for animating text. Developed with SwiftUI. This library supports iOS/macOS.
[](https://developer.apple.com/macOS)
[](https://developer.apple.com/iOS)
[](https://developer.apple.com/macOS)
[](https://www.instagram.com/dev.fabula)
[](https://developer.apple.com/documentation/swift_packages/package/)
[](https://opensource.org/licenses/MIT)
## Screenshot
https://user-images.githubusercontent.com/1617304/153016287-73f15db7-b642-4c4d-afc7-b3ecb2a17640.mp4
## Example
[https://fabulaapp.page.link/224](https://fabulaapp.page.link/224)
## Usages
1. AnimateText
```swift
/// A view that animates binding text. Passing the effect type as a generic.
/// struct AnimateText 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($text, type: type, userInfo: userInfo)
```
2. Each effect only needs to conform to the ATTextAnimateEffect protocol.
```swift
/// 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
```swift
/// 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.
```swift
dependencies: [
.package(url: "https://github.com/jasudev/AnimateText.git", .branch("main"))
]
```
## Contact
instagram : [@dev.fabula](https://www.instagram.com/dev.fabula)
email : [[email protected]](mailto:[email protected])
## License
AnimateText is available under the MIT license. See the [LICENSE](LICENSE) file for more info.