This repository has been archived by the owner on Jul 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Button.kt
985 lines (932 loc) · 44.2 KB
/
Button.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
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
/*
* Copyright 2021 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
*
* http://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 androidx.compose.material3
import androidx.compose.animation.core.Animatable
import androidx.compose.animation.core.VectorConverter
import androidx.compose.foundation.BorderStroke
import androidx.compose.foundation.interaction.FocusInteraction
import androidx.compose.foundation.interaction.HoverInteraction
import androidx.compose.foundation.interaction.Interaction
import androidx.compose.foundation.interaction.InteractionSource
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.interaction.PressInteraction
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.RowScope
import androidx.compose.foundation.layout.defaultMinSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.tokens.ElevatedButtonTokens
import androidx.compose.material3.tokens.FilledButtonTokens
import androidx.compose.material3.tokens.FilledTonalButtonTokens
import androidx.compose.material3.tokens.OutlinedButtonTokens
import androidx.compose.material3.tokens.TextButtonTokens
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.Immutable
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.Stable
import androidx.compose.runtime.State
import androidx.compose.runtime.mutableStateListOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberUpdatedState
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.Shape
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
/**
* <a href="https://m3.material.io/components/buttons/overview" class="external" target="_blank">Material Design button</a>.
*
* Buttons help people initiate actions, from sending an email, to sharing a document, to liking a
* post.
*
* ![Filled button image](https://developer.android.com/images/reference/androidx/compose/material3/filled-button.png)
*
* Filled buttons are high-emphasis buttons. Filled buttons have the most visual impact after the
* [FloatingActionButton], and should be used for important, final actions that complete a flow,
* like "Save", "Join now", or "Confirm".
*
* @sample androidx.compose.material3.samples.ButtonSample
* @sample androidx.compose.material3.samples.ButtonWithIconSample
*
* Choose the best button for an action based on the amount of emphasis it needs. The more important
* an action is, the higher emphasis its button should be.
*
* - See [OutlinedButton] for a medium-emphasis button with a border.
* - See [ElevatedButton] for an [OutlinedButton] with a shadow.
* - See [TextButton] for a low-emphasis button with no border.
* - See [FilledTonalButton] for a middle ground between [OutlinedButton] and [Button].
*
* The default text style for internal [Text] components will be set to [Typography.labelLarge].
*
* @param onClick called when this button is clicked
* @param modifier the [Modifier] to be applied to this button
* @param enabled controls the enabled state of this button. When `false`, this component will not
* respond to user input, and it will appear visually disabled and disabled to accessibility
* services.
* @param interactionSource the [MutableInteractionSource] representing the stream of [Interaction]s
* for this button. You can create and pass in your own `remember`ed instance to observe
* [Interaction]s and customize the appearance / behavior of this button in different states.
* @param elevation [ButtonElevation] used to resolve the elevation for this button in different
* states. This controls the size of the shadow below the button. Additionally, when the container
* color is [ColorScheme.surface], this controls the amount of primary color applied as an overlay.
* See [ButtonElevation.shadowElevation] and [ButtonElevation.tonalElevation].
* @param shape defines the shape of this button's container, border (when [border] is not null),
* and shadow (when using [elevation])
* @param border the border to draw around the container of this button
* @param colors [ButtonColors] that will be used to resolve the colors for this button in different
* states. See [ButtonDefaults.buttonColors].
* @param contentPadding the spacing values to apply internally between the container and the
* content
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun Button(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
elevation: ButtonElevation? = ButtonDefaults.buttonElevation(),
shape: Shape = ButtonDefaults.Shape,
border: BorderStroke? = null,
colors: ButtonColors = ButtonDefaults.buttonColors(),
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
content: @Composable RowScope.() -> Unit
) {
val containerColor = colors.containerColor(enabled).value
val contentColor = colors.contentColor(enabled).value
val shadowElevation = elevation?.shadowElevation(enabled, interactionSource)?.value ?: 0.dp
val tonalElevation = elevation?.tonalElevation(enabled, interactionSource)?.value ?: 0.dp
// TODO(b/202880001): Apply shadow color from token (will not be possibly any time soon, if ever).
Surface(
onClick = onClick,
modifier = modifier,
shape = shape,
color = containerColor,
contentColor = contentColor,
tonalElevation = tonalElevation,
shadowElevation = shadowElevation,
border = border,
interactionSource = interactionSource,
enabled = enabled,
) {
CompositionLocalProvider(LocalContentColor provides contentColor) {
ProvideTextStyle(value = MaterialTheme.typography.labelLarge) {
Row(
Modifier
.defaultMinSize(
minWidth = ButtonDefaults.MinWidth,
minHeight = ButtonDefaults.MinHeight
)
.padding(contentPadding),
horizontalArrangement = Arrangement.Center,
verticalAlignment = Alignment.CenterVertically,
content = content
)
}
}
}
}
/**
* <a href="https://m3.material.io/components/buttons/overview" class="external" target="_blank">Material Design elevated button</a>.
*
* Buttons help people initiate actions, from sending an email, to sharing a document, to liking a
* post.
*
* ![Elevated button image](https://developer.android.com/images/reference/androidx/compose/material3/elevated-button.png)
*
* Elevated buttons are high-emphasis buttons that are essentially [FilledTonalButton]s with a
* shadow. To prevent shadow creep, only use them when absolutely necessary, such as when the button
* requires visual separation from patterned container.
*
* @sample androidx.compose.material3.samples.ElevatedButtonSample
*
* Choose the best button for an action based on the amount of emphasis it needs. The more important
* an action is, the higher emphasis its button should be.
*
* - See [Button] for a high-emphasis button without a shadow, also known as a filled button.
* - See [FilledTonalButton] for a middle ground between [OutlinedButton] and [Button].
* - See [OutlinedButton] for a medium-emphasis button with a border.
* - See [TextButton] for a low-emphasis button with no border.
*
* The default text style for internal [Text] components will be set to [Typography.labelLarge].
*
* @param onClick called when this button is clicked
* @param modifier the [Modifier] to be applied to this button
* @param enabled controls the enabled state of this button. When `false`, this component will not
* respond to user input, and it will appear visually disabled and disabled to accessibility
* services.
* @param interactionSource the [MutableInteractionSource] representing the stream of [Interaction]s
* for this button. You can create and pass in your own `remember`ed instance to observe
* [Interaction]s and customize the appearance / behavior of this button in different states.
* @param elevation [ButtonElevation] used to resolve the elevation for this button in different
* states. This controls the size of the shadow below the button. Additionally, when the container
* color is [ColorScheme.surface], this controls the amount of primary color applied as an overlay.
* See [ButtonDefaults.elevatedButtonElevation].
* @param shape defines the shape of this button's container, border (when [border] is not null),
* and shadow (when using [elevation])
* @param border the border to draw around the container of this button
* @param colors [ButtonColors] that will be used to resolve the colors for this button in different
* states. See [ButtonDefaults.elevatedButtonColors].
* @param contentPadding the spacing values to apply internally between the container and the
* content
*/
@Composable
fun ElevatedButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
elevation: ButtonElevation? = ButtonDefaults.elevatedButtonElevation(),
shape: Shape = ButtonDefaults.ElevatedShape,
border: BorderStroke? = null,
colors: ButtonColors = ButtonDefaults.elevatedButtonColors(),
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
content: @Composable RowScope.() -> Unit
) =
Button(
onClick = onClick,
modifier = modifier,
enabled = enabled,
interactionSource = interactionSource,
elevation = elevation,
shape = shape,
border = border,
colors = colors,
contentPadding = contentPadding,
content = content
)
/**
* <a href="https://m3.material.io/components/buttons/overview" class="external" target="_blank">Material Design filled tonal button</a>.
*
* Buttons help people initiate actions, from sending an email, to sharing a document, to liking a
* post.
*
* ![Filled tonal button image](https://developer.android.com/images/reference/androidx/compose/material3/filled-tonal-button.png)
*
* Filled tonal buttons are medium-emphasis buttons that is an alternative middle ground between
* default [Button]s (filled) and [OutlinedButton]s. They can be used in contexts where
* lower-priority button requires slightly more emphasis than an outline would give, such as "Next"
* in an onboarding flow. Tonal buttons use the secondary color mapping.
*
* @sample androidx.compose.material3.samples.FilledTonalButtonSample
*
* Choose the best button for an action based on the amount of emphasis it needs. The more important
* an action is, the higher emphasis its button should be.
*
* - See [Button] for a high-emphasis button without a shadow, also known as a filled button.
* - See [ElevatedButton] for a [FilledTonalButton] with a shadow.
* - See [OutlinedButton] for a medium-emphasis button with a border.
* - See [TextButton] for a low-emphasis button with no border.
*
* The default text style for internal [Text] components will be set to [Typography.labelLarge].
*
* @param onClick called when this button is clicked
* @param modifier the [Modifier] to be applied to this button
* @param enabled controls the enabled state of this button. When `false`, this component will not
* respond to user input, and it will appear visually disabled and disabled to accessibility
* services.
* @param interactionSource the [MutableInteractionSource] representing the stream of [Interaction]s
* for this button. You can create and pass in your own `remember`ed instance to observe
* [Interaction]s and customize the appearance / behavior of this button in different states.
* @param elevation [ButtonElevation] used to resolve the elevation for this button in different
* states. This controls the size of the shadow below the button. Additionally, when the container
* color is [ColorScheme.surface], this controls the amount of primary color applied as an overlay.
* @param shape defines the shape of this button's container, border (when [border] is not null),
* and shadow (when using [elevation])
* @param border the border to draw around the container of this button
* @param colors [ButtonColors] that will be used to resolve the colors for this button in different
* states. See [ButtonDefaults.filledTonalButtonColors].
* @param contentPadding the spacing values to apply internally between the container and the
* content
*/
@Composable
fun FilledTonalButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
elevation: ButtonElevation? = ButtonDefaults.filledTonalButtonElevation(),
shape: Shape = ButtonDefaults.FilledTonalShape,
border: BorderStroke? = null,
colors: ButtonColors = ButtonDefaults.filledTonalButtonColors(),
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
content: @Composable RowScope.() -> Unit
) =
Button(
onClick = onClick,
modifier = modifier,
enabled = enabled,
interactionSource = interactionSource,
elevation = elevation,
shape = shape,
border = border,
colors = colors,
contentPadding = contentPadding,
content = content
)
/**
* <a href="https://m3.material.io/components/buttons/overview" class="external" target="_blank">Material Design outlined button</a>.
*
* Buttons help people initiate actions, from sending an email, to sharing a document, to liking a
* post.
*
* ![Outlined button image](https://developer.android.com/images/reference/androidx/compose/material3/outlined-button.png)
*
* Outlined buttons are medium-emphasis buttons. They contain actions that are important, but are
* not the primary action in an app. Outlined buttons pair well with [Button]s to indicate an
* alternative, secondary action.
*
* @sample androidx.compose.material3.samples.OutlinedButtonSample
*
* Choose the best button for an action based on the amount of emphasis it needs. The more important
* an action is, the higher emphasis its button should be.
*
* - See [Button] for a high-emphasis button without a shadow, also known as a filled button.
* - See [FilledTonalButton] for a middle ground between [OutlinedButton] and [Button].
* - See [OutlinedButton] for a medium-emphasis button with a border.
* - See [TextButton] for a low-emphasis button with no border.
*
* The default text style for internal [Text] components will be set to [Typography.labelLarge].
*
* @param onClick called when this button is clicked
* @param modifier the [Modifier] to be applied to this button
* @param enabled controls the enabled state of this button. When `false`, this component will not
* respond to user input, and it will appear visually disabled and disabled to accessibility
* services.
* @param interactionSource the [MutableInteractionSource] representing the stream of [Interaction]s
* for this button. You can create and pass in your own `remember`ed instance to observe
* [Interaction]s and customize the appearance / behavior of this button in different states.
* @param elevation [ButtonElevation] used to resolve the elevation for this button in different
* states. This controls the size of the shadow below the button. Additionally, when the container
* color is [ColorScheme.surface], this controls the amount of primary color applied as an overlay.
* @param shape defines the shape of this button's container, border (when [border] is not null),
* and shadow (when using [elevation]).
* @param border the border to draw around the container of this button. Pass `null` for no border.
* @param colors [ButtonColors] that will be used to resolve the colors for this button in different
* states. See [ButtonDefaults.outlinedButtonColors].
* @param contentPadding the spacing values to apply internally between the container and the
* content
*/
@Composable
fun OutlinedButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
elevation: ButtonElevation? = null,
shape: Shape = ButtonDefaults.OutlinedShape,
border: BorderStroke? = ButtonDefaults.outlinedButtonBorder,
colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
content: @Composable RowScope.() -> Unit
) =
Button(
onClick = onClick,
modifier = modifier,
enabled = enabled,
interactionSource = interactionSource,
elevation = elevation,
shape = shape,
border = border,
colors = colors,
contentPadding = contentPadding,
content = content
)
/**
* <a href="https://m3.material.io/components/buttons/overview" class="external" target="_blank">Material Design text button</a>.
*
* Buttons help people initiate actions, from sending an email, to sharing a document, to liking a
* post.
*
* ![Text button image](https://developer.android.com/images/reference/androidx/compose/material3/text-button.png)
*
* Text buttons are typically used for less-pronounced actions, including those located in dialogs
* and cards. In cards, text buttons help maintain an emphasis on card content. Text buttons are
* used for the lowest priority actions, especially when presenting multiple options.
*
* @sample androidx.compose.material3.samples.TextButtonSample
*
* Choose the best button for an action based on the amount of emphasis it needs. The more important
* an action is, the higher emphasis its button should be.
*
* - See [Button] for a high-emphasis button without a shadow, also known as a filled button.
* - See [ElevatedButton] for a [FilledTonalButton] with a shadow.
* - See [FilledTonalButton] for a middle ground between [OutlinedButton] and [Button].
* - See [OutlinedButton] for a medium-emphasis button with a border.
*
* The default text style for internal [Text] components will be set to [Typography.labelLarge].
*
* @param onClick called when this button is clicked
* @param modifier the [Modifier] to be applied to this button
* @param enabled controls the enabled state of this button. When `false`, this component will not
* respond to user input, and it will appear visually disabled and disabled to accessibility
* services.
* @param interactionSource the [MutableInteractionSource] representing the stream of [Interaction]s
* for this button. You can create and pass in your own `remember`ed instance to observe
* [Interaction]s and customize the appearance / behavior of this button in different states.
* @param elevation [ButtonElevation] used to resolve the elevation for this button in different
* states. This controls the size of the shadow below the button. Additionally, when the container
* color is [ColorScheme.surface], this controls the amount of primary color applied as an overlay.
* A TextButton typically has no elevation, and the default value is `null`. See [ElevatedButton]
* for a button with elevation.
* @param shape defines the shape of this button's container, border (when [border] is not null),
* and shadow (when using [elevation])
* @param border the border to draw around the container of this button
* @param colors [ButtonColors] that will be used to resolve the colors for this button in different
* states. See [ButtonDefaults.textButtonColors].
* @param contentPadding the spacing values to apply internally between the container and the
* content
*/
@Composable
fun TextButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
elevation: ButtonElevation? = null,
shape: Shape = ButtonDefaults.TextShape,
border: BorderStroke? = null,
colors: ButtonColors = ButtonDefaults.textButtonColors(),
contentPadding: PaddingValues = ButtonDefaults.TextButtonContentPadding,
content: @Composable RowScope.() -> Unit
) =
Button(
onClick = onClick,
modifier = modifier,
enabled = enabled,
interactionSource = interactionSource,
elevation = elevation,
shape = shape,
border = border,
colors = colors,
contentPadding = contentPadding,
content = content
)
// TODO(b/201341237): Use token values for 0 elevation?
// TODO(b/201341237): Use token values for null border?
// TODO(b/201341237): Use token values for no color (transparent)?
/**
* Contains the default values used by all 5 button types.
*
* Default values that apply to all buttons types are [MinWidth], [MinHeight], [IconSize], and
* [IconSpacing].
*
* A default value that applies only to [Button], [ElevatedButton], [FilledTonalButton], and
* [OutlinedButton] is [ContentPadding].
*
* Default values that apply only to [Button] are [buttonColors] and [buttonElevation].
* Default values that apply only to [ElevatedButton] are [elevatedButtonColors] and [elevatedButtonElevation].
* Default values that apply only to [FilledTonalButton] are [filledTonalButtonColors] and [filledTonalButtonElevation].
* A default value that applies only to [OutlinedButton] is [outlinedButtonColors].
* Default values that apply only to [TextButton] are [TextButtonContentPadding] and [textButtonColors].
*/
object ButtonDefaults {
// TODO(b/201344013): Make sure these values stay up to date until replaced with tokens.
private val ButtonHorizontalPadding = 24.dp
// TODO(b/202453316): There is no current vertical padding in the spec.
// Instead, the height is const 40dp, and the content is vertically center-aligned.
private val ButtonVerticalPadding = 8.dp
/**
* The default content padding used by [Button], [ElevatedButton], [FilledTonalButton], and
* [OutlinedButton] buttons.
*
* - See [TextButtonContentPadding] for content padding used by [TextButton].
* - See [ButtonWithIconContentPadding] for content padding used by [Button] that contains [Icon].
*/
// TODO(b/201343537): Use tokens.
val ContentPadding =
PaddingValues(
start = ButtonHorizontalPadding,
top = ButtonVerticalPadding,
end = ButtonHorizontalPadding,
bottom = ButtonVerticalPadding
)
private val ButtonWithIconHorizontalStartPadding = 16.dp
/** The default content padding used by [Button] that contains an [Icon]. */
val ButtonWithIconContentPadding =
PaddingValues(
start = ButtonWithIconHorizontalStartPadding,
top = ButtonVerticalPadding,
end = ButtonHorizontalPadding,
bottom = ButtonVerticalPadding
)
// TODO(b/201344013): Make sure these values stay up to date until replaced with tokens.
private val TextButtonHorizontalPadding = 12.dp
/** The default content padding used by [TextButton] */
val TextButtonContentPadding =
PaddingValues(
start = TextButtonHorizontalPadding,
top = ContentPadding.calculateTopPadding(),
end = TextButtonHorizontalPadding,
bottom = ContentPadding.calculateBottomPadding()
)
/**
* The default min width applied for all buttons. Note that you can override it by applying
* Modifier.widthIn directly on the button composable.
*/
// TODO(b/202453316): Make sure this value stays up to date until replaced with a token.
val MinWidth = 58.dp
/**
* The default min height applied for all buttons. Note that you can override it by applying
* Modifier.heightIn directly on the button composable.
*/
// TODO(b/202453316): Make sure this value stays up to date until replaced with a token.
val MinHeight = 40.dp
/** The default size of the icon when used inside any button. */
// TODO(b/201344013): Make sure this value stays up to date until replaced with a token.
val IconSize = 18.dp
/**
* The default size of the spacing between an icon and a text when they used inside any button.
*/
// TODO(b/201344013): Make sure this value stays up to date until replaced with a token.
val IconSpacing = 8.dp
// Shape Defaults
/** Default shape for a button. */
val Shape: Shape @Composable get() = FilledButtonTokens.ContainerShape.toShape()
/** Default shape for an elevated button. */
val ElevatedShape: Shape @Composable get() = ElevatedButtonTokens.ContainerShape.toShape()
/** Default shape for a filled tonal button. */
val FilledTonalShape: Shape @Composable get() = FilledTonalButtonTokens.ContainerShape.toShape()
/** Default shape for an outlined button. */
val OutlinedShape: Shape @Composable get() = OutlinedButtonTokens.ContainerShape.toShape()
/** Default shape for a text button. */
val TextShape: Shape @Composable get() = TextButtonTokens.ContainerShape.toShape()
/**
* Creates a [ButtonColors] that represents the default container and content colors used in a
* [Button].
*
* @param containerColor the container color of this [Button] when enabled.
* @param contentColor the content color of this [Button] when enabled.
* @param disabledContainerColor the container color of this [Button] when not enabled.
* @param disabledContentColor the content color of this [Button] when not enabled.
*/
@Composable
fun buttonColors(
containerColor: Color = FilledButtonTokens.ContainerColor.toColor(),
contentColor: Color = FilledButtonTokens.LabelTextColor.toColor(),
disabledContainerColor: Color =
FilledButtonTokens.DisabledContainerColor.toColor()
.copy(alpha = FilledButtonTokens.DisabledContainerOpacity),
disabledContentColor: Color = FilledButtonTokens.DisabledLabelTextColor.toColor()
.copy(alpha = FilledButtonTokens.DisabledLabelTextOpacity),
): ButtonColors =
DefaultButtonColors(
containerColor = containerColor,
contentColor = contentColor,
disabledContainerColor = disabledContainerColor,
disabledContentColor = disabledContentColor
)
/**
* Creates a [ButtonColors] that represents the default container and content colors used in an
* [ElevatedButton].
*
* @param containerColor the container color of this [ElevatedButton] when enabled
* @param contentColor the content color of this [ElevatedButton] when enabled
* @param disabledContainerColor the container color of this [ElevatedButton] when not enabled
* @param disabledContentColor the content color of this [ElevatedButton] when not enabled
*/
@Composable
fun elevatedButtonColors(
containerColor: Color = ElevatedButtonTokens.ContainerColor.toColor(),
contentColor: Color = ElevatedButtonTokens.LabelTextColor.toColor(),
disabledContainerColor: Color = ElevatedButtonTokens.DisabledContainerColor
.toColor()
.copy(alpha = ElevatedButtonTokens.DisabledContainerOpacity),
disabledContentColor: Color = ElevatedButtonTokens.DisabledLabelTextColor
.toColor()
.copy(alpha = ElevatedButtonTokens.DisabledLabelTextOpacity),
): ButtonColors =
DefaultButtonColors(
containerColor = containerColor,
contentColor = contentColor,
disabledContainerColor = disabledContainerColor,
disabledContentColor = disabledContentColor
)
/**
* Creates a [ButtonColors] that represents the default container and content colors used in an
* [FilledTonalButton].
*
* @param containerColor the container color of this [FilledTonalButton] when enabled
* @param contentColor the content color of this [FilledTonalButton] when enabled
* @param disabledContainerColor the container color of this [FilledTonalButton] when not enabled
* @param disabledContentColor the content color of this [FilledTonalButton] when not enabled
*/
@Composable
fun filledTonalButtonColors(
containerColor: Color = FilledTonalButtonTokens.ContainerColor.toColor(),
contentColor: Color = FilledTonalButtonTokens.LabelTextColor.toColor(),
disabledContainerColor: Color = FilledTonalButtonTokens.DisabledContainerColor
.toColor()
.copy(alpha = FilledTonalButtonTokens.DisabledContainerOpacity),
disabledContentColor: Color = FilledTonalButtonTokens.DisabledLabelTextColor
.toColor()
.copy(alpha = FilledTonalButtonTokens.DisabledLabelTextOpacity),
): ButtonColors =
DefaultButtonColors(
containerColor = containerColor,
contentColor = contentColor,
disabledContainerColor = disabledContainerColor,
disabledContentColor = disabledContentColor
)
/**
* Creates a [ButtonColors] that represents the default container and content colors used in an
* [OutlinedButton].
*
* @param containerColor the container color of this [OutlinedButton] when enabled
* @param contentColor the content color of this [OutlinedButton] when enabled
* @param disabledContainerColor the container color of this [OutlinedButton] when not enabled
* @param disabledContentColor the content color of this [OutlinedButton] when not enabled
*/
@Composable
fun outlinedButtonColors(
containerColor: Color = Color.Transparent,
contentColor: Color = OutlinedButtonTokens.LabelTextColor.toColor(),
disabledContainerColor: Color = Color.Transparent,
disabledContentColor: Color = OutlinedButtonTokens.DisabledLabelTextColor
.toColor()
.copy(alpha = OutlinedButtonTokens.DisabledLabelTextOpacity),
): ButtonColors =
DefaultButtonColors(
containerColor = containerColor,
contentColor = contentColor,
disabledContainerColor = disabledContainerColor,
disabledContentColor = disabledContentColor
)
/**
* Creates a [ButtonColors] that represents the default container and content colors used in a
* [TextButton].
*
* @param containerColor the container color of this [TextButton] when enabled
* @param contentColor the content color of this [TextButton] when enabled
* @param disabledContainerColor the container color of this [TextButton] when not enabled
* @param disabledContentColor the content color of this [TextButton] when not enabled
*/
@Composable
fun textButtonColors(
containerColor: Color = Color.Transparent,
contentColor: Color = TextButtonTokens.LabelTextColor.toColor(),
disabledContainerColor: Color = Color.Transparent,
disabledContentColor: Color = TextButtonTokens.DisabledLabelTextColor
.toColor()
.copy(alpha = TextButtonTokens.DisabledLabelTextOpacity),
): ButtonColors =
DefaultButtonColors(
containerColor = containerColor,
contentColor = contentColor,
disabledContainerColor = disabledContainerColor,
disabledContentColor = disabledContentColor
)
/**
* Creates a [ButtonElevation] that will animate between the provided values according to the
* Material specification for a [Button].
*
* @param defaultElevation the elevation used when the [Button] is enabled, and has no other
* [Interaction]s.
* @param pressedElevation the elevation used when this [Button] is enabled and pressed.
* @param focusedElevation the elevation used when the [Button] is enabled and focused.
* @param hoveredElevation the elevation used when the [Button] is enabled and hovered.
* @param disabledElevation the elevation used when the [Button] is not enabled.
*/
@Composable
fun buttonElevation(
defaultElevation: Dp = FilledButtonTokens.ContainerElevation,
pressedElevation: Dp = FilledButtonTokens.PressedContainerElevation,
focusedElevation: Dp = FilledButtonTokens.FocusContainerElevation,
hoveredElevation: Dp = FilledButtonTokens.HoverContainerElevation,
disabledElevation: Dp = FilledButtonTokens.DisabledContainerElevation,
): ButtonElevation {
return remember(
defaultElevation,
pressedElevation,
focusedElevation,
hoveredElevation,
disabledElevation
) {
DefaultButtonElevation(
defaultElevation = defaultElevation,
pressedElevation = pressedElevation,
focusedElevation = focusedElevation,
hoveredElevation = hoveredElevation,
disabledElevation = disabledElevation,
)
}
}
/**
* Creates a [ButtonElevation] that will animate between the provided values according to the
* Material specification for a [ElevatedButton].
*
* @param defaultElevation the elevation used when the [ElevatedButton] is enabled, and has no
* other [Interaction]s.
* @param pressedElevation the elevation used when this [ElevatedButton] is enabled and pressed.
* @param focusedElevation the elevation used when the [ElevatedButton] is enabled and focused.
* @param hoveredElevation the elevation used when the [ElevatedButton] is enabled and hovered.
* @param disabledElevation the elevation used when the [ElevatedButton] is not enabled.
*/
@Composable
fun elevatedButtonElevation(
defaultElevation: Dp = ElevatedButtonTokens.ContainerElevation,
pressedElevation: Dp = ElevatedButtonTokens.PressedContainerElevation,
focusedElevation: Dp = ElevatedButtonTokens.FocusContainerElevation,
hoveredElevation: Dp = ElevatedButtonTokens.HoverContainerElevation,
disabledElevation: Dp = ElevatedButtonTokens.DisabledContainerElevation
): ButtonElevation {
return remember(
defaultElevation,
pressedElevation,
focusedElevation,
hoveredElevation,
disabledElevation
) {
DefaultButtonElevation(
defaultElevation = defaultElevation,
pressedElevation = pressedElevation,
focusedElevation = focusedElevation,
hoveredElevation = hoveredElevation,
disabledElevation = disabledElevation
)
}
}
/**
* Creates a [ButtonElevation] that will animate between the provided values according to the
* Material specification for a [FilledTonalButton].
*
* @param defaultElevation the elevation used when the [FilledTonalButton] is enabled, and has no
* other [Interaction]s.
* @param pressedElevation the elevation used when this [FilledTonalButton] is enabled and
* pressed.
* @param focusedElevation the elevation used when the [FilledTonalButton] is enabled and focused.
* @param hoveredElevation the elevation used when the [FilledTonalButton] is enabled and hovered.
* @param disabledElevation the elevation used when the [FilledTonalButton] is not enabled.
*/
@Composable
fun filledTonalButtonElevation(
defaultElevation: Dp = FilledTonalButtonTokens.ContainerElevation,
pressedElevation: Dp = FilledTonalButtonTokens.PressedContainerElevation,
focusedElevation: Dp = FilledTonalButtonTokens.FocusContainerElevation,
hoveredElevation: Dp = FilledTonalButtonTokens.HoverContainerElevation,
disabledElevation: Dp = 0.dp
): ButtonElevation {
return remember(
defaultElevation,
pressedElevation,
focusedElevation,
hoveredElevation,
disabledElevation
) {
DefaultButtonElevation(
defaultElevation = defaultElevation,
pressedElevation = pressedElevation,
focusedElevation = focusedElevation,
hoveredElevation = hoveredElevation,
disabledElevation = disabledElevation
)
}
}
/** The default [BorderStroke] used by [OutlinedButton]. */
val outlinedButtonBorder: BorderStroke
@Composable
get() = BorderStroke(
width = OutlinedButtonTokens.OutlineWidth,
color = OutlinedButtonTokens.OutlineColor.toColor(),
)
}
/**
* Represents the elevation for a button in different states.
*
* - See [ButtonDefaults.buttonElevation] for the default elevation used in a [Button].
* - See [ButtonDefaults.elevatedButtonElevation] for the default elevation used in a
* [ElevatedButton].
*/
@Stable
interface ButtonElevation {
/**
* Represents the tonal elevation used in a button, depending on its [enabled] state and
* [interactionSource]. This should typically be the same value as the [shadowElevation].
*
* Tonal elevation is used to apply a color shift to the surface to give the it higher emphasis.
* When surface's color is [ColorScheme.surface], a higher elevation will result in a darker
* color in light theme and lighter color in dark theme.
*
* See [shadowElevation] which controls the elevation of the shadow drawn around the button.
*
* @param enabled whether the button is enabled
* @param interactionSource the [InteractionSource] for this button
*/
@Composable
fun tonalElevation(enabled: Boolean, interactionSource: InteractionSource): State<Dp>
/**
* Represents the shadow elevation used in a button, depending on its [enabled] state and
* [interactionSource]. This should typically be the same value as the [tonalElevation].
*
* Shadow elevation is used to apply a shadow around the button to give it higher emphasis.
*
* See [tonalElevation] which controls the elevation with a color shift to the surface.
*
* @param enabled whether the button is enabled
* @param interactionSource the [InteractionSource] for this button
*/
@Composable
fun shadowElevation(enabled: Boolean, interactionSource: InteractionSource): State<Dp>
}
/**
* Represents the container and content colors used in a button in different states.
*
* - See [ButtonDefaults.buttonColors] for the default colors used in a [Button].
* - See [ButtonDefaults.elevatedButtonColors] for the default colors used in a [ElevatedButton].
* - See [ButtonDefaults.textButtonColors] for the default colors used in a [TextButton].
*/
@Stable
interface ButtonColors {
/**
* Represents the container color for this button, depending on [enabled].
*
* @param enabled whether the button is enabled
*/
@Composable
fun containerColor(enabled: Boolean): State<Color>
/**
* Represents the content color for this button, depending on [enabled].
*
* @param enabled whether the button is enabled
*/
@Composable
fun contentColor(enabled: Boolean): State<Color>
}
/** Default [ButtonElevation] implementation. */
@Stable
private class DefaultButtonElevation(
private val defaultElevation: Dp,
private val pressedElevation: Dp,
private val focusedElevation: Dp,
private val hoveredElevation: Dp,
private val disabledElevation: Dp,
) : ButtonElevation {
@Composable
override fun tonalElevation(enabled: Boolean, interactionSource: InteractionSource): State<Dp> {
return animateElevation(enabled = enabled, interactionSource = interactionSource)
}
@Composable
override fun shadowElevation(
enabled: Boolean,
interactionSource: InteractionSource
): State<Dp> {
return animateElevation(enabled = enabled, interactionSource = interactionSource)
}
@Composable
private fun animateElevation(
enabled: Boolean,
interactionSource: InteractionSource
): State<Dp> {
val interactions = remember { mutableStateListOf<Interaction>() }
LaunchedEffect(interactionSource) {
interactionSource.interactions.collect { interaction ->
when (interaction) {
is HoverInteraction.Enter -> {
interactions.add(interaction)
}
is HoverInteraction.Exit -> {
interactions.remove(interaction.enter)
}
is FocusInteraction.Focus -> {
interactions.add(interaction)
}
is FocusInteraction.Unfocus -> {
interactions.remove(interaction.focus)
}
is PressInteraction.Press -> {
interactions.add(interaction)
}
is PressInteraction.Release -> {
interactions.remove(interaction.press)
}
is PressInteraction.Cancel -> {
interactions.remove(interaction.press)
}
}
}
}
val interaction = interactions.lastOrNull()
val target =
if (!enabled) {
disabledElevation
} else {
when (interaction) {
is PressInteraction.Press -> pressedElevation
is HoverInteraction.Enter -> hoveredElevation
is FocusInteraction.Focus -> focusedElevation
else -> defaultElevation
}
}
val animatable = remember { Animatable(target, Dp.VectorConverter) }
if (!enabled) {
// No transition when moving to a disabled state
LaunchedEffect(target) { animatable.snapTo(target) }
} else {
LaunchedEffect(target) {
val lastInteraction = when (animatable.targetValue) {
pressedElevation -> PressInteraction.Press(Offset.Zero)
hoveredElevation -> HoverInteraction.Enter()
focusedElevation -> FocusInteraction.Focus()
else -> null
}
animatable.animateElevation(
from = lastInteraction,
to = interaction,
target = target
)
}
}
return animatable.asState()
}
}
/** Default [ButtonColors] implementation. */
@Immutable
private class DefaultButtonColors(
private val containerColor: Color,
private val contentColor: Color,
private val disabledContainerColor: Color,
private val disabledContentColor: Color,
) : ButtonColors {
@Composable
override fun containerColor(enabled: Boolean): State<Color> {
return rememberUpdatedState(if (enabled) containerColor else disabledContainerColor)
}
@Composable
override fun contentColor(enabled: Boolean): State<Color> {
return rememberUpdatedState(if (enabled) contentColor else disabledContentColor)
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as DefaultButtonColors
if (containerColor != other.containerColor) return false
if (contentColor != other.contentColor) return false
if (disabledContainerColor != other.disabledContainerColor) return false
if (disabledContentColor != other.disabledContentColor) return false
return true
}
override fun hashCode(): Int {
var result = containerColor.hashCode()
result = 31 * result + contentColor.hashCode()
result = 31 * result + disabledContainerColor.hashCode()
result = 31 * result + disabledContentColor.hashCode()
return result
}
}