A library that enables reuse of Material Components for Android XML themes for theming in Jetpack Compose.
There are two artifacts available:
com.google.android.material:compose-theme-adapter
- Compatible with Compose Material
- Includes
MdcTheme
com.google.android.material:compose-theme-adapter-3
- Compatible with Compose Material 3
- Includes
Mdc3Theme
repositories {
google()
}
dependencies {
// Compatible with Compose Material, includes MdcTheme
implementation "com.google.android.material:compose-theme-adapter:<version>"
// Compatible with Compose Material 3, includes Mdc3Theme
implementation "com.google.android.material:compose-theme-adapter-3:<version>"
}
See the releases page for the latest versions.
The basis of Material Design 2 theming in Jetpack Compose is the MaterialTheme
composable, where you provide Colors
, Typography
and Shapes
instances containing your styling parameters:
MaterialTheme(
colors = colors,
typography = type,
shapes = shapes
) {
// M2 Surface, Scaffold, etc.
}
Material Components for Android themes allow for similar theming for views via XML theme attributes, like so:
<style name="Theme.MyApp" parent="Theme.MaterialComponents.DayNight">
<!-- Material 2 color attributes -->
<item name="colorPrimary">@color/purple_500</item>
<item name="colorSecondary">@color/green_200</item>
<!-- Material 2 type attributes-->
<item name="textAppearanceBody1">@style/TextAppearance.MyApp.Body1</item>
<item name="textAppearanceBody2">@style/TextAppearance.MyApp.Body2</item>
<!-- Material 2 shape attributes-->
<item name="shapeAppearanceSmallComponent">@style/ShapeAppearance.MyApp.SmallComponent</item>
</style>
This library attempts to bridge the gap between Material Components for Android M2 XML themes, and themes in Jetpack Compose, allowing your composable MaterialTheme
to be based on the Activity
's XML theme:
MdcTheme {
// MaterialTheme.colors, MaterialTheme.typography, MaterialTheme.shapes
// will now contain copies of the Context's theme
}
This is especially handy when you're migrating an existing app, a Fragment
(or other UI container) at a time.
!!! caution If you are using an AppCompat (i.e. non-MDC) theme in your app, you should use AppCompat Compose Theme Adapter instead, as it attempts to bridge the gap between AppCompat XML themes, and M2 themes in Jetpack Compose.
The MdcTheme()
function will automatically read the host Context
's MDC theme and pass them to MaterialTheme
on your behalf, but if you want to customize the generated values, you can do so via the createMdcTheme()
function:
val context = LocalContext.current
val layoutDirection = LocalLayoutDirection.current
var (colors, typography, shapes) = createMdcTheme(
context = context,
layoutDirection = layoutDirection
)
// Modify colors, typography or shapes as required.
// Then pass them through to MaterialTheme...
MaterialTheme(
colors = colors,
typography = type,
shapes = shapes
) {
// Rest of M2 layout
}
There are some known limitations with the implementation at the moment:
- This relies on your
Activity
/Context
theme extending one of theTheme.MaterialComponents
themes. - Text colors are not read from the text appearances by default. You can enable it via the
setTextColors
function parameter. - Variable fonts are not supported in Compose yet, meaning that the value of
android:fontVariationSettings
are currently ignored. - MDC
ShapeAppearances
allow setting of different corner families (cut, rounded) on each corner, whereas Compose's Shapes allows only a single corner family for the entire shape. Therefore only theapp:cornerFamily
attribute is read, others (app:cornerFamilyTopLeft
, etc) are ignored. - You can modify the resulting
MaterialTheme
in Compose as required, but this only works in Compose. Any changes you make will not be reflected in theActivity
theme.
The basis of Material Design 3 theming in Jetpack Compose is the MaterialTheme
composable, where you provide ColorScheme
, Typography
and Shapes
instances containing your styling parameters:
MaterialTheme(
colorScheme = colorScheme,
typography = typography,
shapes = shapes
) {
// M3 Surface, Scaffold, etc.
}
Material Components for Android themes allow for similar theming for views via XML theme attributes, like so:
<style name="Theme.MyApp" parent="Theme.Material3.DayNight">
<!-- Material 3 color attributes -->
<item name="colorPrimary">@color/purple_500</item>
<item name="colorSecondary">@color/purple_700</item>
<item name="colorTertiary">@color/green_200</item>
<!-- Material 3 type attributes-->
<item name="textAppearanceBodyLarge">@style/TextAppearance.MyApp.BodyLarge</item>
<item name="textAppearanceBodyMedium">@style/TextAppearance.MyApp.BodyMedium</item>
<!-- Material 3 shape attributes-->
<item name="shapeAppearanceCornerSmall">@style/ShapeAppearance.MyApp.CornerSmall</item>
</style>
This library attempts to bridge the gap between Material Components for Android M3 XML themes, and themes in Jetpack Compose, allowing your composable MaterialTheme
to be based on the Activity
's XML theme:
Mdc3Theme {
// MaterialTheme.colorScheme, MaterialTheme.typography, MaterialTheme.shapes
// will now contain copies of the Context's theme
}
This is especially handy when you're migrating an existing app, a Fragment
(or other UI container) at a time.
The Mdc3Theme()
function will automatically read the host Context
's MDC theme and pass them to MaterialTheme
on your behalf, but if you want to customize the generated values, you can do so via the createMdc3Theme()
function:
val context = LocalContext.current
var (colorScheme, typography, shapes) = createMdc3Theme(
context = context
)
// Modify colorScheme, typography or shapes as required.
// Then pass them through to MaterialTheme...
MaterialTheme(
colorScheme = colorScheme,
typography = typography,
shapes = shapes
) {
// Rest of M3 layout
}
There are some known limitations with the implementation at the moment:
- This relies on your
Activity
/Context
theme extending one of theTheme.Material3
themes. - Text colors are not read from the text appearances by default. You can enable it via the
setTextColors
function parameter. - Variable fonts are not supported in Compose yet, meaning that the value of
android:fontVariationSettings
are currently ignored. - MDC
ShapeAppearances
allow setting of different corner families (cut, rounded) on each corner, whereas Compose's Shapes allows only a single corner family for the entire shape. Therefore only theapp:cornerFamily
attribute is read, others (app:cornerFamilyTopLeft
, etc) are ignored. - You can modify the resulting
MaterialTheme
in Compose as required, but this only works in Compose. Any changes you make will not be reflected in theActivity
theme.
Snapshots of the current development version of this library are available, which track the latest commit. See here for more information on how to use them.
Please contribute! We will gladly review any pull requests. Make sure to read the Contributing page first though.
Copyright 2020 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.