summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/support/webextensions/README.md
blob: fdbefaae18eaf978763590c903fbf4f8a05081c1 (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
# [Android Components](../../../README.md) > Support > Webextensions

A component containing building blocks for features implemented as web extensions.

Usually this component never needs to be added to application projects manually. Other components may have a transitive dependency on some of the classes and interfaces in this component.

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

## Facts

This component emits the following [Facts](../../support/base/README.md#Facts):

| Action      | Item                       | Extras            | Description                     |
|-------------|----------------------------|-------------------|---------------------------------|
| Interaction | web_extensions_initialized | `extensionExtras` | Web extensions are initialized. |


#### `extensionExtras`

| Key         | Type         | Value                                 |
|-------------|--------------|---------------------------------------|
| "enabled"   | List<String> | List of enabled web extension ids.    |
| "installed" | List<String> | List of installed web extensions ids. |

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