fune/mobile/android/android-components/components/browser/state
Lina Butler c4350f91fe Bug 1858542 - Introduce AwesomeBarState and Suggestion.metadata.
This commit adds:

* An `AwesomeBarState` class to hold the currently visible suggestions
  and last clicked suggestion.
* `VisibilityStateUpdated` and `SuggestionClicked` `AwesomeBarAction`s
  to update the state, and an `EngagementFinished` action to reset the
  state. Consumers will dispatch these actions on the `BrowserStore`
  in response to user interactions with the awesomebar and toolbar.
* A `metadata` map to `AwesomeBar.Suggestion`, allowing providers to
  attach opaque data to each suggestion.
2023-10-24 07:43:07 +00:00
..
src Bug 1858542 - Introduce AwesomeBarState and Suggestion.metadata. 2023-10-24 07:43:07 +00:00
build.gradle Bug 1858542 - Introduce AwesomeBarState and Suggestion.metadata. 2023-10-24 07:43:07 +00:00
proguard-rules.pro [components] Issue https://github.com/mozilla-mobile/android-components/issues/1843: Introduce experimental (unpublished) browser-state component. 2019-04-18 17:15:52 -04:00
README.md [components] Complete migration from browser-session to browser-state. 2021-06-08 14:44:09 +00:00

Android Components > Browser > State

The browser-state component is responsible for maintaining the centralized state of a browser engine.

The immutable BrowserState can be accessed and observed via the BrowserStore. Apps and other components can dispatch Actions on the store in order to trigger the creation of a new BrowserState.

Patterns and concepts this component uses are heavily inspired by Redux. Therefore the Redux documentation is an excellent resource for learning about some of those concepts.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:browser-state:{latest-version}

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/