summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/compose/cfr/README.md
blob: 843ac13f7fd2cca2e9fe8c06794813bd2da1c19c (plain)
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
# [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/