summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/browser/toolbar/README.md
blob: 1dcd5a115b34f6047d61f41e6a2ab6103c555815 (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) > Browser > Toolbar

A customizable toolbar for browsers.

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

## Facts

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

| Action | Item    | Extras         | Description                        |
|--------|---------|----------------|------------------------------------|
| CLICK  | menu    | `menuExtras`   | The user opened the overflow menu. |
| COMMIT | toolbar | `commitExtras` | The user has edited the URL.       |

`menuExtras` are additional extras set on the `BrowserMenuBuilder` passed to the `BrowserToolbar` (see [browser-menu](../menu/README.md)).

#### `commitExtras`

| Key          | Type    | Value                             |
|--------------|---------|-----------------------------------|
| autocomplete | Boolean | Whether the URL was autocompleted |
| source       | String? | Which autocomplete list was used  |

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