summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/feature/qr/README.md
blob: 531cd6f8e445231645819d085fd75ede6a2a0404 (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
# [Android Components](../../../README.md) > Libraries > QR

A component that provides functionality for scanning QR coes.

## Usage

### 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:feature-qr:{latest-version}"
```

### Integration

Initializing the feature:

```kotlin
qrFeature = QrFeature(
    context,
    fragmentManager = supportFragmentManager,
    onNeedToRequestPermissions = { permissions ->
        requestPermissions(this, permissions, REQUEST_CODE_CAMERA_PERMISSIONS)
    },
    onScanResult = { result ->
        // result is a String (e.g. a URL) returned by the QR scanner.
    }
)
```

When ready to scan use the following:

```kotlin
qrFeature.scan()
```

## 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/