blob: dc1b129b6581c049a3f3d6bb3e7b61336782b42c (
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
43
44
45
46
47
48
49
50
51
|
# [Android Components](../../../README.md) > Browser > Menu 2
A generic menu with customizable items primarily for browser toolbars.
This replaces the [browser-menu](../menu) component with a new API using immutable objects,
designed to work well with [lib-state](../../lib/state).
## 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-menu2:{latest-version}"
```
### MenuController
The menu controller is used to control the items in the menu as well as displaying the menu popup.
Sample code can be found in [Sample Toolbar app](https://github.com/mozilla-mobile/android-components/tree/main/samples/toolbar).
There are multiple properties that you customize of the browser menu by just adding them into your dimens.xml file.
```xml
<resources xmlns:tools="http://schemas.android.com/tools">
<!--Change how rounded the corners of the menu should be-->
<dimen name="mozac_browser_menu2_corner_radius" tools:ignore="UnusedResources">4dp</dimen>
<!--Change how much shadow the menu should have-->
<dimen name="mozac_browser_menu2_elevation" tools:ignore="UnusedResources">4dp</dimen>
<!--Change the width of the menu - can also be set in MenuController#show()-->
<dimen name="mozac_browser_menu2_width" tools:ignore="UnusedResources">250dp</dimen>
<!--Change the top and bottom padding of the menu-->
<dimen name="mozac_browser_menu2_padding_vertical" tools:ignore="UnusedResources">8dp</dimen>
</resources>
```
Options displayed in the menu are configured by using a list of `MenuCandidate` objects.
The list of options can be sent to the menu by calling `MenuController#submitList()`.
To change the displayed options, simply call `submitList` again with a new list.
## 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/
|
