android-components/components/browser/toolbar/README.md

38 lines
1.4 KiB
Markdown
Executable File

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