Repository navigation
Expand file tree
/
Copy pathModifierSnippets.kt
More file actions
434 lines (390 loc) · 11.8 KB
/
Copy pathModifierSnippets.kt
File metadata and controls
434 lines (390 loc) · 11.8 KB
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
/*
* Copyright 2023 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.example.compose.snippets.modifiers
import androidx.compose.animation.core.AnimationState
import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxHeight
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.offset
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.paddingFromBaseline
import androidx.compose.foundation.layout.requiredSize
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.State
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
private object Padding {
// [START android_compose_modifiers_padding]
@Composable
private fun Greeting(name: String) {
Column(modifier = Modifier.padding(24.dp)) {
Text(text = "Hello,")
Text(text = name)
}
}
// [END android_compose_modifiers_padding]
}
private object PaddingAndFill {
// [START android_compose_modifiers_paddingandfill]
@Composable
private fun Greeting(name: String) {
Column(
modifier = Modifier
.padding(24.dp)
.fillMaxWidth()
) {
Text(text = "Hello,")
Text(text = name)
}
}
// [END android_compose_modifiers_paddingandfill]
}
private object Order1 {
val onClick = {}
// [START android_compose_modifiers_order1]
@Composable
fun ArtistCard(/*...*/) {
val padding = 16.dp
Column(
Modifier
.clickable(onClick = onClick)
.padding(padding)
.fillMaxWidth()
) {
// rest of the implementation
}
}
// [END android_compose_modifiers_order1]
}
private object Order2 {
val onClick = {}
// [START android_compose_modifiers_order2]
@Composable
fun ArtistCard(/*...*/) {
val padding = 16.dp
Column(
Modifier
.padding(padding)
.clickable(onClick = onClick)
.fillMaxWidth()
) {
// rest of the implementation
}
}
// [END android_compose_modifiers_order2]
}
private object Size {
// [START android_compose_modifiers_size]
@Composable
fun ArtistCard(/*...*/) {
Row(
modifier = Modifier.size(width = 400.dp, height = 100.dp)
) {
Image(/*...*/)
Column { /*...*/ }
}
}
// [END android_compose_modifiers_size]
}
private object RequiredSize {
// [START android_compose_modifiers_requiredsize]
@Composable
fun ArtistCard(/*...*/) {
Row(
modifier = Modifier.size(width = 400.dp, height = 100.dp)
) {
Image(
/*...*/
modifier = Modifier.requiredSize(150.dp)
)
Column { /*...*/ }
}
}
// [END android_compose_modifiers_requiredsize]
}
private object FillMaxHeight {
// [START android_compose_modifiers_fillmaxheight]
@Composable
fun ArtistCard(/*...*/) {
Row(
modifier = Modifier.size(width = 400.dp, height = 100.dp)
) {
Image(
/*...*/
modifier = Modifier.fillMaxHeight()
)
Column { /*...*/ }
}
}
// [END android_compose_modifiers_fillmaxheight]
}
private object PaddingFromBaseline {
// [START android_compose_modifiers_paddingfrombaseline]
@Composable
fun ArtistCard(artist: Artist) {
Row(/*...*/) {
Column {
Text(
text = artist.name,
modifier = Modifier.paddingFromBaseline(top = 50.dp)
)
Text(artist.lastSeenOnline)
}
}
}
// [END android_compose_modifiers_paddingfrombaseline]
}
private object Offset {
// [START android_compose_modifiers_offset]
@Composable
fun ArtistCard(artist: Artist) {
Row(/*...*/) {
Column {
Text(artist.name)
Text(
text = artist.lastSeenOnline,
modifier = Modifier.offset(x = 4.dp)
)
}
}
}
// [END android_compose_modifiers_offset]
}
private object MatchParentSize {
// [START android_compose_modifiers_matchparentsize]
@Composable
fun MatchParentSizeComposable() {
Box {
Spacer(
Modifier
.matchParentSize()
.background(Color.LightGray)
)
ArtistCard()
}
}
// [END android_compose_modifiers_matchparentsize]
}
private object Weight {
// [START android_compose_modifiers_weight]
@Composable
fun ArtistCard(/*...*/) {
Row(
modifier = Modifier.fillMaxWidth()
) {
Image(
/*...*/
modifier = Modifier.weight(2f)
)
Column(
modifier = Modifier.weight(1f)
) {
/*...*/
}
}
}
// [END android_compose_modifiers_weight]
}
private object ReusingModifiers {
// [START android_compose_modifiers_reusingmodifiers]
val reusableModifier = Modifier
.fillMaxWidth()
.background(Color.Red)
.padding(12.dp)
// [END android_compose_modifiers_reusingmodifiers]
}
private object AnimationInline {
// [START android_compose_modifiers_animationinline]
@Composable
fun LoadingWheelAnimation() {
val animatedState = animateFloatAsState(/*...*/)
LoadingWheel(
// Creation and allocation of this modifier will happen on every frame of the animation!
modifier = Modifier
.padding(12.dp)
.background(Color.Gray),
animatedState = animatedState
)
}
// [END android_compose_modifiers_animationinline]
}
private object AnimationExtracted {
// [START android_compose_modifiers_animationextracted]
// Now, the allocation of the modifier happens here:
val reusableModifier = Modifier
.padding(12.dp)
.background(Color.Gray)
@Composable
fun LoadingWheelAnimation() {
val animatedState = animateFloatAsState(/*...*/)
LoadingWheel(
// No allocation, as we're just reusing the same instance
modifier = reusableModifier,
animatedState = animatedState
)
}
// [END android_compose_modifiers_animationextracted]
}
private object UnscopedModifiers1 {
// [START android_compose_modifiers_unscopedmodifiers1]
val reusableModifier = Modifier
.fillMaxWidth()
.background(Color.Red)
.padding(12.dp)
@Composable
fun AuthorField() {
HeaderText(
// ...
modifier = reusableModifier
)
SubtitleText(
// ...
modifier = reusableModifier
)
}
// [END android_compose_modifiers_unscopedmodifiers1]
}
private object UnscopedModifiers2 {
// [START android_compose_modifiers_unscopedmodifiers2]
val reusableItemModifier = Modifier
.padding(bottom = 12.dp)
.size(216.dp)
.clip(CircleShape)
@Composable
private fun AuthorList(authors: List<Author>) {
LazyColumn {
items(authors) {
AsyncImage(
// ...
modifier = reusableItemModifier,
)
}
}
}
// [END android_compose_modifiers_unscopedmodifiers2]
}
@Composable
private fun ScopedModifiers1() {
// [START android_compose_modifiers_scopedmodifiers1]
Column(/*...*/) {
val reusableItemModifier = Modifier
.padding(bottom = 12.dp)
// Align Modifier.Element requires a ColumnScope
.align(Alignment.CenterHorizontally)
.weight(1f)
Text1(
modifier = reusableItemModifier,
// ...
)
Text2(
modifier = reusableItemModifier
// ...
)
// ...
}
// [END android_compose_modifiers_scopedmodifiers1]
}
@Composable
private fun ScopedModifiers2() {
// [START android_compose_modifiers_scopedmodifiers2]
Column(modifier = Modifier.fillMaxWidth()) {
// Weight modifier is scoped to the Column composable
val reusableItemModifier = Modifier.weight(1f)
// Weight will be properly assigned here since this Text is a direct child of Column
Text1(
modifier = reusableItemModifier
// ...
)
Box {
Text2(
// Weight won't do anything here since the Text composable is not a direct child of Column
modifier = reusableItemModifier
// ...
)
}
}
// [END android_compose_modifiers_scopedmodifiers2]
}
private object ChainingExtractedModifiers {
val otherModifier = Modifier
@Composable
private fun Snippet() {
// Note: In a real app, you would define the modifier outside of the composable where it is
// needed. For the snippet in the documentation, putting it in one place is clearer.
// [START android_compose_modifiers_chainingextractedmodifiers]
val reusableModifier = Modifier
.fillMaxWidth()
.background(Color.Red)
.padding(12.dp)
// Append to your reusableModifier
reusableModifier.clickable { /*...*/ }
// Append your reusableModifier
otherModifier.then(reusableModifier)
// [END android_compose_modifiers_chainingextractedmodifiers]
}
}
// ----- Classes and functions below are to simplify snippets above ----- //
private data class Artist(val name: String, val lastSeenOnline: String)
private data class Author(val name: String)
@Composable
private fun Image(modifier: Modifier = Modifier) {
// Empty to allow Image(/*...*/) in snippets
}
@Composable
private fun ArtistCard() {
// Empty for snippets
}
@Composable
private fun LoadingWheel(modifier: Modifier, animatedState: State<Float>) {
// Empty for snippets
}
@Composable
private fun animateFloatAsState(): State<Float> {
return AnimationState(initialValue = 0f)
}
@Composable
private fun HeaderText(modifier: Modifier = Modifier) {
// Empty for snippets
}
@Composable
private fun SubtitleText(modifier: Modifier = Modifier) {
// Empty for snippets
}
@Composable
private fun AsyncImage(modifier: Modifier = Modifier) {
// Empty for snippets
}
@Composable
private fun Text1(modifier: Modifier = Modifier) {
// Empty for snippets
}
@Composable
private fun Text2(modifier: Modifier = Modifier) {
// Empty for snippets
}