/
BasicUsageExamplesPage.kt
173 lines (163 loc) · 5.21 KB
/
BasicUsageExamplesPage.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
package com.airbnb.lottie.sample.compose.examples
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.verticalScroll
import androidx.compose.material.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import com.airbnb.lottie.compose.LottieAnimation
import com.airbnb.lottie.compose.LottieClipSpec
import com.airbnb.lottie.compose.LottieCompositionSpec
import com.airbnb.lottie.compose.LottieConstants
import com.airbnb.lottie.compose.animateLottieCompositionAsState
import com.airbnb.lottie.compose.rememberLottieComposition
import com.airbnb.lottie.sample.compose.R
@Composable
fun BasicUsageExamplesPage() {
UsageExamplePageScaffold {
Column(
modifier = Modifier
.fillMaxWidth()
.verticalScroll(rememberScrollState())
) {
Box(modifier = Modifier.height(16.dp))
ExampleCard("Example 1", "Repeat once") {
Example1()
}
ExampleCard("Example 2", "Repeat forever") {
Example2()
}
ExampleCard("Example 3", "Repeat forever from 50% to 75%") {
Example3()
}
ExampleCard("Example 4", "Using LottieAnimationResult") {
Example4()
}
ExampleCard("Example 5", "Using LottieComposition") {
Example5()
}
ExampleCard("Example 6", "Splitting out the animation driver") {
Example6()
}
ExampleCard("Example 7", "Toggle on click - click me") {
Example7()
}
}
}
}
/**
* Nice and easy... This will play one time as soon as the composition loads
* then it will stop.
*/
@Composable
private fun Example1() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
LottieAnimation(composition)
}
/**
* This will repeat forever.
*/
@Composable
private fun Example2() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
LottieAnimation(
composition,
iterations = LottieConstants.IterateForever,
)
}
/**
* This will repeat between 50% and 75% forever.
*/
@Composable
private fun Example3() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
LottieAnimation(
composition,
iterations = LottieConstants.IterateForever,
clipSpec = LottieClipSpec.Progress(0.5f, 0.75f),
)
}
/**
* Here, you can check the result for loading/failure states.
*/
@Composable
private fun Example4() {
val compositionResult = rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
when {
compositionResult.isLoading -> {
Text("Animation is loading...")
}
compositionResult.isFailure -> {
Text("Animation failed to load")
}
compositionResult.isSuccess -> {
LottieAnimation(
compositionResult.value,
iterations = LottieConstants.IterateForever,
)
}
}
}
/**
* If you just want access to the composition itself, you can use the delegate
* version of lottieComposition like this.
*/
@Composable
private fun Example5() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
LottieAnimation(
composition,
progress = 0.65f,
)
}
/**
* Here, you have access to the composition and animation individually.
*/
@Composable
private fun Example6() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
val progress by animateLottieCompositionAsState(
composition,
iterations = LottieConstants.IterateForever,
)
LottieAnimation(
composition,
{ progress },
)
}
/**
* Here, you can toggle playback by clicking the animation.
*/
@Composable
private fun Example7() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
var isPlaying by remember { mutableStateOf(false) }
LottieAnimation(
composition,
iterations = LottieConstants.IterateForever,
// When this is true, it it will start from 0 every time it is played again.
// When this is false, it will resume from the progress it was pause at.
restartOnPlay = false,
isPlaying = isPlaying,
modifier = Modifier
.clickable { isPlaying = !isPlaying }
)
}
@Preview
@Composable
fun ExampleCardPreview() {
val composition by rememberLottieComposition(LottieCompositionSpec.RawRes(R.raw.heart))
ExampleCard("Example 1", "Heart animation") {
LottieAnimation(composition)
}
}