diff options
Diffstat (limited to 'mobile/android/android-components/components/browser/toolbar2/README.md')
| -rw-r--r-- | mobile/android/android-components/components/browser/toolbar2/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/browser/toolbar2/README.md b/mobile/android/android-components/components/browser/toolbar2/README.md new file mode 100644 index 0000000000..a0cfe1d6ce --- /dev/null +++ b/mobile/android/android-components/components/browser/toolbar2/README.md @@ -0,0 +1,37 @@ +# [Android Components](../../../README.md) > Browser > Toolbar2 + +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-toolbar2:{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/ |