diff options
Diffstat (limited to 'mobile/android/android-components/components/browser/state/README.md')
| -rw-r--r-- | mobile/android/android-components/components/browser/state/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/browser/state/README.md b/mobile/android/android-components/components/browser/state/README.md new file mode 100644 index 0000000000..c4ecdf39b4 --- /dev/null +++ b/mobile/android/android-components/components/browser/state/README.md @@ -0,0 +1,23 @@ +# [Android Components](../../../README.md) > Browser > State + +The `browser-state` component is responsible for maintaining the centralized state of a [browser engine](../../concept/engine/README.md). + +The immutable `BrowserState` can be accessed and observed via the `BrowserStore`. Apps and other components can dispatch `Action`s 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](https://redux.js.org/introduction/getting-started) 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](https://maven.mozilla.org/) ([Setup repository](../../../README.md#maven-repository)): + +```Groovy +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/ |