diff options
Diffstat (limited to 'mobile/android/android-components/components/compose/cfr/README.md')
-rw-r--r-- | mobile/android/android-components/components/compose/cfr/README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/compose/cfr/README.md b/mobile/android/android-components/components/compose/cfr/README.md new file mode 100644 index 0000000000..843ac13f7f --- /dev/null +++ b/mobile/android/android-components/components/compose/cfr/README.md @@ -0,0 +1,49 @@ +# [Android Components](../../../README.md) > Compose > Tabs tray + +A standard Contextual Feature Recommendation popup using Jetpack Compose. + +## Usage + +```kotlin +CFRPopup( + anchor = <View>, + properties = CFRPopupProperties( + popupWidth = 256.dp, + popupAlignment = INDICATOR_CENTERED_IN_ANCHOR, + popupBodyColors = listOf( + ContextCompat.getColor(context, R.color.color1), + ContextCompat.getColor(context, R.color.color2) + ), + dismissButtonColor = ContextCompat.getColor(context, R.color.color3), + ), + onDismiss = { <method call> }, + text = { + Text( + text = stringResource(R.string.string1), + style = MaterialTheme.typography.body2, + ) + }, + action = { + Button(onClick = { <method call> }) { + Text(text = stringResource(R.string.string2)) + } + }, +).apply { + show() +} +``` + + +### Setting up the dependency + +Use Gradle to download the library from [maven.mozilla.org](https://maven.mozilla.org/) ([Setup repository](../../../README.md#maven-repository)): + +```Groovy +implementation "org.mozilla.components:compose-cfr:{latest-version}" +``` + +## License + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/ |