From 2114a11378fd801b32cd7431bb8a2c94de4f462c Mon Sep 17 00:00:00 2001
From: pekingme <8545955+pekingme@users.noreply.github.com>
Date: Mon, 14 Aug 2023 20:51:57 +0000
Subject: [PATCH] [Docs] Updated dev doc for tonal surface colors in affected
components.
PiperOrigin-RevId: 556901517
---
docs/components/BottomAppBar.md | 2 +-
docs/components/BottomNavigation.md | 2 +-
docs/components/BottomSheet.md | 4 +--
docs/components/Button.md | 2 +-
docs/components/Card.md | 2 +-
docs/components/DatePicker.md | 7 ++++
docs/components/Dialog.md | 4 +--
docs/components/Menu.md | 8 ++---
docs/components/NavigationDrawer.md | 4 +--
docs/components/ProgressIndicator.md | 2 +-
docs/components/Search.md | 4 +--
docs/components/SideSheet.md | 16 ++++-----
docs/components/Slider.md | 2 +-
docs/components/Switch.md | 6 ++--
docs/components/TextField.md | 2 +-
docs/components/TimePicker.md | 2 +-
docs/components/TopAppBar.md | 2 +-
docs/theming/Color.md | 50 ++++++++++++++--------------
18 files changed, 64 insertions(+), 57 deletions(-)
diff --git a/docs/components/BottomAppBar.md b/docs/components/BottomAppBar.md
index f50ac26b126..b7ae93d2401 100644
--- a/docs/components/BottomAppBar.md
+++ b/docs/components/BottomAppBar.md
@@ -236,7 +236,7 @@ floating action button (FAB), action item(s) and an overflow menu.
Element | Attribute | Related method(s) | Default value
------------- | ------------------------ | ------------------------------------------ | -------------
-**Color** | `app:backgroundTint` | `setBackgroundTint`
`getBackgroundTint` | `?attr/colorSurface`
+**Color** | `app:backgroundTint` | `setBackgroundTint`
`getBackgroundTint` | `?attr/colorSurfaceContainer`
**Elevation** | `app:elevation` | `setElevation` | `3dp`
**Height** | `android:minHeight` | `setMinimumHeight`
`getMinimumHeight` | `80dp`
**Shadows** | `app:addElevationShadow` | N/A | `false`
diff --git a/docs/components/BottomNavigation.md b/docs/components/BottomNavigation.md
index eb9fdc926e3..27aafa99749 100644
--- a/docs/components/BottomNavigation.md
+++ b/docs/components/BottomNavigation.md
@@ -264,7 +264,7 @@ The following is an anatomy diagram for the bottom navigation bar:
**Element** | **Attribute** | **Related methods** | **Default value**
----------------- | --------------------- | ------------------- | -----------------
-**Color** | `app:backgroundTint` | N/A | `?attr/colorSurface`
+**Color** | `app:backgroundTint` | N/A | `?attr/colorSurfaceContainer`
**Elevation** | `app:elevation` | `setElevation` | `3dp`
**Compat Shadow** | `compatShadowEnabled` | N/A | `false`
diff --git a/docs/components/BottomSheet.md b/docs/components/BottomSheet.md
index 964bf5c1387..f13b2b76549 100644
--- a/docs/components/BottomSheet.md
+++ b/docs/components/BottomSheet.md
@@ -421,8 +421,8 @@ Content can also be added below the drag handle. (see [Using bottom sheets](#usi
Element | Attribute | Related method(s) | Default value
-------------- | --------------------- | --------------------------------- | -------------
-**Color** | `app:backgroundTint` | N/A | `?attr/colorSurface`
-**Shape** | `app:shapeAppearance` | N/A | `?attr/shapeAppearanceLargeComponent`
+**Color** | `app:backgroundTint` | N/A | `?attr/colorSurfaceContainerLow`
+**Shape** | `app:shapeAppearance` | N/A | `?attr/shapeAppearanceCornerExtraLarge`
**Elevation** | `android:elevation` | N/A | `1dp`
**Max width** | `android:maxWidth` | `setMaxWidth`
`getMaxWidth` | `640dp`
**Max height** | `android:maxHeight` | `setMaxHeight`
`getMaxHeight` | N/A
diff --git a/docs/components/Button.md b/docs/components/Button.md
index 3981204a631..e2a64326659 100644
--- a/docs/components/Button.md
+++ b/docs/components/Button.md
@@ -143,7 +143,7 @@ Element | Attribute | Related method(s) |
Element | Attribute | Related method(s) | Default value
---------------- | --------------------- | ---------------------------------------------------------------------------- | -------------
-**Color** | `app:backgroundTint` | `setBackgroundColor`
`setBackgroundTintList`
`getBackgroundTintList` | `?attr/colorSurface` (see all [states](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/button/res/color/m3_text_button_background_color_selector.xml))
+**Color** | `app:backgroundTint` | `setBackgroundColor`
`setBackgroundTintList`
`getBackgroundTintList` | `?attr/colorSurfaceContainerLow` (see all [states](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/button/res/color/m3_text_button_background_color_selector.xml))
**Stroke color** | `app:strokeColor` | `setStrokeColor`
`setStrokeColorResource`
`getStrokeColor` | `null`
**Stroke width** | `app:strokeWidth` | `setStrokeWidth`
`setStrokeWidthResource`
`getStrokeWidth` | `0dp`
**Shape** | `app:shapeAppearance` | `setShapeAppearanceModel`
`getShapeAppearanceModel` | `?attr/shapeAppearanceSmallComponent`
diff --git a/docs/components/Card.md b/docs/components/Card.md
index 3d58530a4f4..0e8d33ac787 100644
--- a/docs/components/Card.md
+++ b/docs/components/Card.md
@@ -367,7 +367,7 @@ shown in the [card examples](#card-examples) section.
Element | Attribute | Related method(s) | Default value
-------------------- | ------------------------- | ------------------------------------------------------------------- | -------------
-**Color** | `app:cardBackgroundColor` | `setCardBackgroundColor`
`getCardBackgroundColor` | `?attr/colorSurface` or `?attr/colorSurfaceVariant` (filled style)
+**Color** | `app:cardBackgroundColor` | `setCardBackgroundColor`
`getCardBackgroundColor` | `?attr/colorSurface` (outlined style)`?attr/colorSurfaceContainerHighest` (filled style)`?attr/colorSurfaceContainerLow` (elevated style)
**Foreground color** | `app:cardForegroundColor` | `setCardForegroundColor`
`getCardForegroundColor` | `@android:color/transparent` (see all [states](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/card/res/color/m3_card_foreground_color.xml))
**Stroke color** | `app:strokeColor` | `setStrokeColor`
`getStrokeColor`
`getStrokeColorStateList` | `?attr/colorOutline` (unchecked)
`?attr/colorSecondary` (checked)
**Stroke width** | `app:strokeWidth` | `setStrokeWidth`
`getStrokeWidth` | `1dp` (outlined style)
`0dp` (elevated or filled style)
diff --git a/docs/components/DatePicker.md b/docs/components/DatePicker.md
index e801500060c..baf40d696c1 100644
--- a/docs/components/DatePicker.md
+++ b/docs/components/DatePicker.md
@@ -294,6 +294,13 @@ The following diagram shows the elements of a date picker:
6. Current date
7. Selected date
+### Container
+
+Element | Attribute | Related method(s) | Default value
+--------- | --------------------- | ----------------- | -------------
+**Color** | `app:backgroundTint` | N/A | `?attr/colorSurfaceContainerHigh`
+**Shape** | `app:shapeAppearance` | N/A | `?attr/shapeAppearanceCornerExtraLarge`
+
### Title
Element | Attribute | Related method(s) | Default value
diff --git a/docs/components/Dialog.md b/docs/components/Dialog.md
index 67a57115197..13d674b3012 100644
--- a/docs/components/Dialog.md
+++ b/docs/components/Dialog.md
@@ -126,8 +126,8 @@ particular type), a background scrim, and, optionally, title and buttons.
Element | **Attribute** | **Related methods** | **Default value**
----------------------------------- | -------------------------------------------------------- | ------------------------------------------------------ | -----------------
-**Color** | `app:backgroundTint` | N/A | `?attr/colorSurface`
-**Shape** | `app:shapeAppearance`
`app:shapeAppearanceOverlay` | N/A | `?attr/shapeAppearanceMediumComponent` with a corner size of `28dp`
+**Color** | `app:backgroundTint` | N/A | `?attr/colorSurfaceContainerHigh`
+**Shape** | `app:shapeAppearance`
`app:shapeAppearanceOverlay` | N/A | `?attr/shapeAppearanceCornerExtraLarge`
**Background inset start and end** | `app:backgroundInsetStart`
`app:backgroundInsetEnd` | `setBackgroundInsetStart`
`setBackgroundInsetEnd` | `24dp`
**Background inset top and bottom** | `app:backgroundInsetTop`
`app:backgroundInsetBottom` | `setBackgroundInsetTop`
`setBackgroundInsetBottom` | `80dp`
diff --git a/docs/components/Menu.md b/docs/components/Menu.md
index f23a5bbfc90..721e297270d 100644
--- a/docs/components/Menu.md
+++ b/docs/components/Menu.md
@@ -426,7 +426,7 @@ The following are menu anatomy diagrams showing all possible elements:
Element | Attribute | Related method(s) | Default value
-------------- | ----------------------------- | ----------------- | -------------
**Background** | `android:popupMenuBackground` | N/A | `?attr/popupMenuBackground`
-**Color** | N/A | N/A | `?attr/colorSurface`
+**Color** | N/A | N/A | `?attr/colorSurfaceContainer`
**Elevation** | `android:popupElevation` | N/A | `3dp`
#### Text attributes
@@ -571,17 +571,17 @@ For all attributes that apply to the `TextInputLayout`, see the
#### `MaterialAutoCompleteTextView` attributes (input text, dropdown menu)
Element | Attribute | Related method(s) | Default value
------------------------------------------ | ------------------------------------------------------------------- |-----------------------------------------------------------------------------------------------------| -------------
+----------------------------------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -------------
**Input text** | `android:text` | `setText`
`getText` | `@null`
**Typography** | `android:textAppearance` | `setTextAppearance` | `?attr/textAppearanceBodyLarge`
**Input accepted** | `android:inputType` | `N/A` | framework's default
**Input text color** | `android:textColor` | `setTextColor`
`getTextColors`
`getCurrentTextColor` | `?android:textColorPrimary`
**Cursor color** | N/A (color comes from the theme attr `?attr/colorControlActivated`) | N/A | `?attr/colorPrimary`
-**Dropdown menu
container color** | `app:dropDownBackgroundTint` | `setDropDownBackgroundTint`
`setDropDownBackgroundTintList`
`getDropDownBackgroundTintList` | `@null`(which means `colorSurface` with elevation overlay will be used)
+**Dropdown menu
container color** | `app:dropDownBackgroundTint` | `setDropDownBackgroundTint`
`setDropDownBackgroundTintList`
`getDropDownBackgroundTintList` | `colorSurfaceContainer`
**Dropdown menu elevation** | `android:popupElevation` | `getPopupElevation` | `3dp`
**Simple items** | `app:simpleItems` | `setSimpleItems` | `null`
**Simple item layout** | `app:simpleItemLayout` | N/A | `@layout/m3_auto_complete_simple_item`
-**Selected simple item color** | `app:simpleItemSelectedColor` | `setSimpleItemSelectedColor`
`getSimpleItemSelectedColor` | `?attr/colorSurfaceVariant`
+**Selected simple item color** | `app:simpleItemSelectedColor` | `setSimpleItemSelectedColor`
`getSimpleItemSelectedColor` | `?attr/colorSurfaceContainerHighest`
**Selected simple item
ripple color** | `app:simpleItemSelectedRippleColor` | `setSimpleItemSelectedRippleColor`
`getSimpleItemSelectedRippleColor` | `@color/m3_simple_item_ripple_color`
#### Styles
diff --git a/docs/components/NavigationDrawer.md b/docs/components/NavigationDrawer.md
index 4b2b1be6fb3..8097ba14339 100644
--- a/docs/components/NavigationDrawer.md
+++ b/docs/components/NavigationDrawer.md
@@ -263,12 +263,12 @@ subtitles, and an optional scrim.
Element | Attribute(s) | Related method(s) | Default value
----------------------- | ------------------------------------------------------------------- | ------------------------------------------------ | -------------
-**Color** | `android:background` | `setBackground`
`getBackground` | `?attr/colorSurface`
+**Color** | `android:background` | `setBackground`
`getBackground` | `?attr/colorSurfaceContainerLow`
**Shape** | `app:shapeAppearance`
`app:shapeAppearanceOverlay` | N/A | `null`
**Elevation** | `app:elevation` (can be used on `NavigationView` or `DrawerLayout`) | `setElevation`
`getElevation` | `0dp` (`NavigationView`) or `1dp` (`DrawerLayout`)
**Max width** | `android:maxWidth` | N/A | `280dp`
**Fits system windows** | `android:fitsSystemWindows` | `setFitsSystemWindows`
`getFitsSystemWindows` | `true`
-**Drawer corner size** | `drawerLayoutCornerSize` | N/A | `16dp`
+**Drawer corner size** | `drawerLayoutCornerSize` | N/A | `16dp`
### Header attributes
diff --git a/docs/components/ProgressIndicator.md b/docs/components/ProgressIndicator.md
index e219f1d796d..9d85e746274 100644
--- a/docs/components/ProgressIndicator.md
+++ b/docs/components/ProgressIndicator.md
@@ -293,7 +293,7 @@ Element | Attribute | Related method(s)
----------------------------- | --------------------------- | --------------------------------------------------------- | -------------
**Track thickness** | `app:trackThickness` | `setTrackThickness``getTrackThickness` | `4dp`
**Indicator color** | `app:indicatorColor` | `setIndicatorColor``getIndicatorColor` | `colorPrimary`
-**Track color** | `app:trackColor` | `setTrackColor``getTrackColor` | `indicatorColor` at `disabledAlpha`
+**Track color** | `app:trackColor` | `setTrackColor``getTrackColor` | `colorSurfaceContainerHighest` (linear)`@android:color/transparent` (circular)
**Track corner radius** | `app:trackCornerRadius` | `setTrackCornerRadius``getTrackCornerRadius` | `0dp`
**Show animation behavior** | `app:showAnimationBehavior` | `setShowAnimationBehavior``getShowAnimationBehavior` | `none`
**Hide animation behavior** | `app:hideAnimationBehavior` | `setHideAnimationBehavior``getHideAnimationBehavior` | `none`
diff --git a/docs/components/Search.md b/docs/components/Search.md
index 8997ca1e71e..c56000cf353 100644
--- a/docs/components/Search.md
+++ b/docs/components/Search.md
@@ -105,7 +105,7 @@ Element | Attribute | Related method(s)
**Search text appearance** | `android:textAppearance` | `setTextAppearance`
`getTextAppearance` | `@style/TextAppearance.Material3.SearchBar`
**Search text** | `android:text` | `setText`
`getText` | `null`
**Search hint** | `android:hint` | `setHint`
`getHint` | `null`
-**Color** | `app:backgroundTint` | -- | `?attr/colorSurface`
+**Color** | `app:backgroundTint` | -- | `?attr/colorSurfaceContainerHigh`
**Flag for default margins** | `app:defaultMarginsEnabled` | -- | `true`
**Flag for navigation icon** | `app:hideNavigationIcon` | -- | `false`
@@ -218,7 +218,7 @@ Element | Attribute | Related meth
**Search text appearance** | `android:textAppearance` | `setTextAppearance`
`getTextAppearance` | `@style/TextAppearance.Material3.SearchBar`
**Search text** | `android:text` | `setText`
`getText` | `null`
**Search hint** | `android:hint` | `setHint`
`getHint` | `null`
-**Color** | `app:backgroundTint` | -- | `?attr/colorSurface`
+**Color** | `app:backgroundTint` | -- | `?attr/colorSurfaceContainerHigh`
**Flag for navigation icon** | `app:hideNavigationIcon` | -- | `true`
**Flag for `DrawerArrowDrawable`** | `app:useDrawerArrowDrawable` | -- | `false`
**Flag for soft keyboard** | `app:autoShowKeyboard` | -- | `true`
diff --git a/docs/components/SideSheet.md b/docs/components/SideSheet.md
index 69f462695e6..d2ef1edb682 100644
--- a/docs/components/SideSheet.md
+++ b/docs/components/SideSheet.md
@@ -264,15 +264,15 @@ Side sheets have a sheet, content, and, if modal, a scrim.
### Sheet attributes
-Element | Attribute | Related method(s) | Default value
--------------- |-----------------------------|---------------------------------------------------------| -------------
-**Color** | `app:backgroundTint` | N/A | `?attr/colorSurface`
+Element | Attribute | Related method(s) | Default value
+---------------------------- | --------------------------- | ------------------------------------------------------- | -------------
+**Color** | `app:backgroundTint` | N/A | `?attr/colorSurface``?attr/colorSurfaceContainerLow` (modal)
**Coplanar sibling view id** | `app:coplanarSiblingViewId` | `setCoplanarSiblingViewId`
`setCoplanarSiblingView` | N/A
-**Shape** | `app:shapeAppearance` | N/A | `?attr/shapeAppearanceLargeComponent`
-**Sheet edge** | `android:layout_gravity` | `setSheetEdge` (modal only) | end
-**Elevation** | `android:elevation` | N/A | 0dp
-**Max width** | `android:maxWidth` | `setMaxWidth`
`getMaxWidth` | N/A
-**Max height** | `android:maxHeight` | `setMaxHeight`
`getMaxHeight` | N/A
+**Shape** | `app:shapeAppearance` | N/A | `?attr/shapeAppearanceLargeComponent`
+**Sheet edge** | `android:layout_gravity` | `setSheetEdge` (modal only) | end
+**Elevation** | `android:elevation` | N/A | 0dp
+**Max width** | `android:maxWidth` | `setMaxWidth`
`getMaxWidth` | N/A
+**Max height** | `android:maxHeight` | `setMaxHeight`
`getMaxHeight` | N/A
### Behavior attributes
diff --git a/docs/components/Slider.md b/docs/components/Slider.md
index 8bc1f45b7c9..609dbf4548f 100644
--- a/docs/components/Slider.md
+++ b/docs/components/Slider.md
@@ -299,7 +299,7 @@ Element | Attribute | Related
**Height** | `app:trackHeight` | `setTrackHeight`
`getTrackHeight` | `4dp`
**Color** | `app:trackColor` | `setTrackTintList`
`getTrackTintList` | `null`
**Color for track's active part** | `app:trackColorActive` | `setTrackActiveTintList`
`getTrackActiveTintList` | `?attr/colorPrimary`
-**Color for track's inactive part** | `app:trackColorInactive` | `setTrackInactiveTintList`
`getTrackInactiveTintList` | `?attr/colorSurfaceVariant`
+**Color for track's inactive part** | `app:trackColorInactive` | `setTrackInactiveTintList`
`getTrackInactiveTintList` | `?attr/colorSurfaceContainerHighest`
**Minimum separation for adjacent thumbs** | `app:minSeparation` | `setMinSeparation`
`getMinSeparation` | `0dp`
**Note:** `app:trackColor` takes precedence over `app:trackColorActive` and
diff --git a/docs/components/Switch.md b/docs/components/Switch.md
index 36a661e38aa..5202b83329b 100644
--- a/docs/components/Switch.md
+++ b/docs/components/Switch.md
@@ -155,17 +155,17 @@ switch by assigning `app:thumbIcon`. This icon will be centered and displayed on
top of the thumb drawable.
Element | Attribute | Related method(s) | Default value
---------- |---------------------|---------------------------------------------------| -------------
+--------- | ------------------- | ------------------------------------------------- | -------------
**Icon** | `app:thumbIcon` | `setThumbIconDrawable`
`getThumbIconDrawable` | `null`
**Size** | `app:thumbIconSize` | `setThumbIconSize`
`getThumbIconSize` | `16dp`
-**Color** | `app:thumbIconTint` | `setThumbIconTintList`
`getThumbIconTintList` | `?attr/colorSurfaceVariant` (unchecked)
`?attr/colorOnPrimaryContainer` (checked)
+**Color** | `app:thumbIconTint` | `setThumbIconTintList`
`getThumbIconTintList` | `?attr/colorSurfaceContainerHighest` (unchecked)
`?attr/colorOnPrimaryContainer` (checked)
### Track attributes
Element | Attribute | Related method(s) | Default value
-------------------- | ------------------------- | ------------------------------------------------------------- | -------------
**Track** | `app:track` | `setTrackDrawable`
`getTrackDrawable` | `@drawable/mtrl_switch_track`
-**Color** | `app:trackTint` | `setTrackTintList`
`getTrackTintList` | `?attr/colorSurfaceVariant` (unchecked)
`?attr/colorPrimary` (checked)
+**Color** | `app:trackTint` | `setTrackTintList`
`getTrackTintList` | `?attr/colorSurfaceContainerHighest` (unchecked)
`?attr/colorPrimary` (checked)
**Decoration** | `app:trackDecoration` | `setTrackDecorationDrawable`
`getTrackDecorationDrawable` | `@drawable/mtrl_switch_track_decoration`
(Shows an outline of the track.)
**Decoration color** | `app:trackDecorationTint` | `setTrackDecorationTintList`
`getTrackDecorationTintList` | `?attr/colorOutline` (unchecked)
`@android:color/transparent` (checked)
diff --git a/docs/components/TextField.md b/docs/components/TextField.md
index 5d1211d15f1..2725c45b865 100644
--- a/docs/components/TextField.md
+++ b/docs/components/TextField.md
@@ -462,7 +462,7 @@ indicator, optional helper/error text and optional leading/trailing icons.
Element | Attribute | Related method(s) | Default value
---------------------- | ------------------------ | --------------------------------------------------------------------------------------- | -------------
-**Color** | `app:boxBackgroundColor` | `setBoxBackgroundColor`
`setBoxBackgroundColorResource`
`getBoxBackgroundColor` | `?attr/colorSurfaceVariant` (see all [states](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/textfield/res/color/m3_textfield_filled_background_color.xml))
+**Color** | `app:boxBackgroundColor` | `setBoxBackgroundColor`
`setBoxBackgroundColorResource`
`getBoxBackgroundColor` | `?attr/colorSurfaceContainerHighest` (see all [states](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/textfield/res/color/m3_textfield_filled_background_color.xml))
**Shape** | `app:shapeAppearance` | N/A | `?attr/shapeAppearanceSmallComponent`
**Text field enabled** | `android:enabled` | `setEnabled` | `true`
diff --git a/docs/components/TimePicker.md b/docs/components/TimePicker.md
index 7fbecfa5620..272fc7be42d 100644
--- a/docs/components/TimePicker.md
+++ b/docs/components/TimePicker.md
@@ -140,7 +140,7 @@ Element | Attribute | Related metho
**Title** | `N/A` | `Builder.setTitleText` | `Select Time`
**Keyboard Icon** | `app:keyboardIcon` | `N/A` | `@drawable/ic_keyboard_black_24dp`
**Clock Icon** | `app:clockIcon` | `N/A` | `@drawable/ic_clock_black_24dp`
-**Clock face Background Color** | `app:clockFaceBackgroundColor` | `N/A` | `?attr/colorSurfaceVariant`
+**Clock face Background Color** | `app:clockFaceBackgroundColor` | `N/A` | `?attr/colorSurfaceContainerHighest`
**Clock hand color** | `app:clockNumberTextColor` | `N/A` | `?attr/colorPrimary`
**Clock Number Text Color** | `app:clockNumberTextColor` | `N/A` | `?attr/colorOnBackground`
diff --git a/docs/components/TopAppBar.md b/docs/components/TopAppBar.md
index 546de411d77..4189a16af4f 100644
--- a/docs/components/TopAppBar.md
+++ b/docs/components/TopAppBar.md
@@ -407,7 +407,7 @@ Element | Attribute
**`CollapsingToolbarLayout` scrim animation duration** | `app:scrimAnimationDuration` | `setScrimAnimationDuration`
`getScrimAnimationDuration` | `600`
**`CollapsingToolbarLayout` collapsing animation interpolator** | `app:titlePositionInterpolator` | `setTitlePositionInterpolator` | `@null`
**`AppBarLayout` lift on scroll** | `app:liftOnScroll` | `setLiftOnScroll`
`isLiftOnScroll` | `true`
-**`AppBarLayout` lift on scroll color** | `app:liftOnScrollColor` | N/A | `@null` (defaults to elevation overlay color)
+**`AppBarLayout` lift on scroll color** | `app:liftOnScrollColor` | N/A | `?attr/colorSurfaceContainer`
**`AppBarLayout` lift on scroll target view** | `app:liftOnScrollTargetViewId` | `setLiftOnScrollTargetViewId`
`getLiftOnScrollTargetViewId` | `@null`
**`AppBarLayout` scroll effect** | `app:layout_scrollEffect` | `setScrollEffect`
`getScrollEffect` | `none`
diff --git a/docs/theming/Color.md b/docs/theming/Color.md
index 63dc7ff8297..9c410cc237a 100644
--- a/docs/theming/Color.md
+++ b/docs/theming/Color.md
@@ -70,29 +70,29 @@ combinations. These additional color attributes are as follows:
-Color Role | Android Attribute | Light Theme Baseline (Dynamic) Color | Dark Theme Baseline (Dynamic) Color
-------------------------- | ---------------------------- | ------------------------------------------------ | -----------------------------------
-Error | colorError | error40(Same) | error80(Same)
-On Error | colorOnError | white(Same) | error20(Same)
-Error Container | colorErrorContainer | error90(Same) | error30(Same)
-On Error Container | colorOnErrorContainer | error10(Same) | error90(Same)
-Outline | colorOutline | neutral_variant50(system_neutral2_500) | neutral_variant60(system_neutral2_400)
-Outline Variant | colorOutlineVariant | neutral_variant80(system_neutral2_200) | neutral_variant30(system_neutral2_700)
-Background | android:colorBackground | primary99(system_neutral1_10) | neutral10(system_neutral1_900)
-On Background | colorOnBackground | neutral10(system_neutral1_900) | neutral90(system_neutral1_100)
-Surface | colorSurface | primary99(system_neutral1_10) | neutral10(system_neutral1_900)
-On Surface | colorOnSurface | neutral10(system_neutral1_900) | neutral90(system_neutral1_100)
-Surface Variant | colorSurfaceVariant | neutral_variant90(system_neutral2_100) | neutral_variant30(system_neutral2_700)
-On Surface Variant | colorOnSurfaceVariant | neutral_variant30(system_neutral2_700) | neutral_variant80(system_neutral2_200)
-Inverse Surface | colorSurfaceInverse | neutral24(system_neutral1_800) | neutral90(system_neutral1_100)
-Inverse On Surface | colorOnSurfaceInverse | neutral95(system_neutral1_50) | neutral24(system_neutral1_800)
-Surface Bright | colorSurfaceBright | neutral98(m3_ref_palette_dynamic_neutral98) | neutral24(m3_ref_palette_dynamic_neutral24)
-Surface Dim | colorSurfaceDim | neutral87(m3_ref_palette_dynamic_neutral87) | neutral6(m3_ref_palette_dynamic_neutral6)
-Surface Container | colorSurfaceContainer | neutral94(m3_ref_palette_dynamic_neutral94) | neutral12(m3_ref_palette_dynamic_neutral12)
-Surface Container Low | colorSurfaceContainerLow | neutral96(m3_ref_palette_dynamic_neutral96) | neutral10(system_neutral1_900)
-Surface Container Lowest | colorSurfaceContainerLowest | white(system_neutral1_0) | neutral4(m3_ref_palette_dynamic_neutral4)
-Surface Container High | colorSurfaceContainerHigh | neutral92(m3_ref_palette_dynamic_neutral92) | neutral17(m3_ref_palette_dynamic_neutral17)
-Surface Container Highest | colorSurfaceContainerHighest | neutral90(system_neutral1_100) | neutral24(m3_ref_palette_dynamic_neutral22)
+Color Role | Android Attribute | Light Theme Baseline (Dynamic) Color | Dark Theme Baseline (Dynamic) Color
+------------------------- | ---------------------------- | -------------------------------------------------------- | -----------------------------------
+Error | colorError | error40(Same) | error80(Same)
+On Error | colorOnError | white(Same) | error20(Same)
+Error Container | colorErrorContainer | error90(Same) | error30(Same)
+On Error Container | colorOnErrorContainer | error10(Same) | error90(Same)
+Outline | colorOutline | neutral_variant50(system_neutral2_500) | neutral_variant60(system_neutral2_400)
+Outline Variant | colorOutlineVariant | neutral_variant80(system_neutral2_200) | neutral_variant30(system_neutral2_700)
+Background | android:colorBackground | neutral98(m3_ref_palette_dynamic_neutral_variant98) | neutral6(m3_ref_palette_dynamic_neutral_variant6)
+On Background | colorOnBackground | neutral10(system_neutral1_900) | neutral90(system_neutral1_100)
+Surface | colorSurface | neutral98(m3_ref_palette_dynamic_neutral_variant98) | neutral6(m3_ref_palette_dynamic_neutral_variant6)
+On Surface | colorOnSurface | neutral10(system_neutral1_900) | neutral90(system_neutral1_100)
+Surface Variant | colorSurfaceVariant | neutral_variant90(system_neutral2_100) | neutral_variant30(system_neutral2_700)
+On Surface Variant | colorOnSurfaceVariant | neutral_variant30(system_neutral2_700) | neutral_variant80(system_neutral2_200)
+Inverse Surface | colorSurfaceInverse | neutral20(system_neutral1_800) | neutral90(system_neutral1_100)
+Inverse On Surface | colorOnSurfaceInverse | neutral95(system_neutral1_50) | neutral20(system_neutral1_800)
+Surface Bright | colorSurfaceBright | neutral98(m3_ref_palette_dynamic_neutral_variant98) | neutral24(m3_ref_palette_dynamic_neutral_variant24)
+Surface Dim | colorSurfaceDim | neutral87(m3_ref_palette_dynamic_neutral_variant87) | neutral6(m3_ref_palette_dynamic_neutral_variant6)
+Surface Container | colorSurfaceContainer | neutral94(m3_ref_palette_dynamic_neutral_variant94) | neutral12(m3_ref_palette_dynamic_neutral_variant12)
+Surface Container Low | colorSurfaceContainerLow | neutral96(m3_ref_palette_dynamic_neutral_variant96) | neutral10(system_neutral2_900)
+Surface Container Lowest | colorSurfaceContainerLowest | white(system_neutral2_0) | neutral4(m3_ref_palette_dynamic_neutral_variant4)
+Surface Container High | colorSurfaceContainerHigh | neutral92(m3_ref_palette_dynamic_neutral_variant92) | neutral17(m3_ref_palette_dynamic_neutral_variant17)
+Surface Container Highest | colorSurfaceContainerHighest | neutral90(system_neutral2_100) | neutral22(m3_ref_palette_dynamic_neutral_variant22)
@@ -223,7 +223,7 @@ DynamicColors.applyToActivitiesIfAvailable(this, (activity, themeResId) -> {
Or provide your own customized dynamic color theme overlays, likely inheriting
from the Material3 theme overlays above, by doing:
-``` java
+```java
DynamicColors.applyToActivitiesIfAvailable(this, R.style.ThemeOverlay_MyApp_DynamicColors_DayNight);
```
@@ -637,7 +637,7 @@ produces the range of tones needed for both light and dark theme applications.
We have provided the following two APIs in the `DynamicColorsOptions` class.
API Method | Description
------------------------------- | ---------------------------------------
+------------------------------ | -----------
#setContentBasedSource(Bitmap) | Provides a Bitmap from which a single source color is extracted as input
#setContentBasedSource(int) | Provides a single source color as input