/android-components

A collection of Android libraries to build browsers or browser-like applications.

Primary LanguageKotlinMozilla Public License 2.0MPL-2.0

Android components

Task Status codecov Bors enabled chat.mozilla.org

A collection of Android libraries to build browsers or browser-like applications.

ℹ️ For more information see the website.

A full featured reference browser implementation based on the components can be found in the reference-browser repository.

Getting Involved

We encourage you to participate in this open source project. We love pull requests, bug reports, ideas, (security) code reviews or any kind of positive contribution.

Before you attempt to make a contribution please read the Community Participation Guidelines.

Maven repository

All components are getting published on maven.mozilla.org. To use them, you need to add the following to your project's top-level build file, in the allprojects block (see e.g. the reference-browser):

repositories {
    maven {
       url "https://maven.mozilla.org/maven2"
    }
}

Each module that uses a component needs to specify it in its build file, in the dependencies block. For example, to use the Base component (in the support) collection, you need:

dependencies {
    implementation 'org.mozilla.components:support-base:+'
}

Snapshot builds

Snapshots are build daily from the master branch and published on snapshots.maven.mozilla.org.

API Reference

The API reference docs are available at mozac.org/api/.

Components

  • 🔴 In Development - Not ready to be used in shipping products.
  • ⚪ Preview - This component is almost/partially ready and can be tested in products.
  • 🔵 Production ready - Used by shipping products.

Browser

High-level components for building browser(-like) apps.

Concept

API contracts and abstraction layers for browser components.

  • ⚪ Awesomebar - An abstract definition of an awesome bar component.

  • ⚪ Engine - Abstraction layer that allows hiding the actual browser engine implementation.

  • ⚪ Fetch - An abstract definition of an HTTP client for fetching resources.

  • 🔴 Push - An abstract definition of a push service component.

  • ⚪ Storage - Abstract definition of a browser storage component.

  • 🔴 Tabstray - Abstract definition of a tabs tray component.

  • ⚪ Toolbar - Abstract definition of a browser toolbar component.

Feature

Combined components to implement feature-specific use cases.

  • 🔴 Accounts - A component that connects an FxaAccountManager from service-firefox-accounts with feature-tabs in order to facilitate authentication flows.

  • 🔴 Accounts Push - Feature of use cases for FxA Account that work with push support.

  • ⚪ Awesomebar - A component that connects a concept-awesomebar implementation to a concept-toolbar implementation and provides implementations of various suggestion providers.

  • ⚪ Context Menu - A component for displaying context menus when long-pressing web content.

  • 🔴 Custom Tabs - A component for providing Custom Tabs functionality in browsers.

  • ⚪ Downloads - A component to perform downloads using the Android downloads manager.

  • 🔴 Intent - A component that provides intent processing functionality by combining various other feature modules.

  • 🔴 Progressive Web Apps (PWA) - A component that provides functionality for supporting Progressive Web Apps (PWA).

  • 🔴 Reader View - A component that provides Reader View functionality.

  • ⚪ QR - A component that provides functionality for scanning QR codes.

  • 🔴 Search - A component that connects an (concept) engine implementation with the browser search module.

  • ⚪ Session - A component that connects an (concept) engine implementation with the browser session and storage modules.

  • 🔴 Sync -A component that provides synchronization orchestration for groups of (concept) SyncableStore objects.

  • 🔴 Tabs - A component that connects a tabs tray implementation with the session and toolbar modules.

  • 🔴 Tab Collections - Feature implementation for saving, restoring and organizing collections of tabs.

  • 🔴 Toolbar - A component that connects a (concept) toolbar implementation with the browser session module.

  • 🔴 Top Sites - Feature implementation for saving and removing top sites.

  • ⚪ Prompts - A component that will handle all the common prompt dialogs from web content.

  • ⚪ Push - A component that provides Autopush messages with help from a supported push service.

  • ⚪ Find In Page - A component that provides an UI widget for find in page functionality.

  • 🔴 Remote Tabs - Feature that provides access to other device's tabs in the same account.

  • 🔴 Site Permissions - A feature for showing site permission request prompts.

  • 🔴 Web Notifications - A component for displaying web notifications.

  • 🔵 WebCompat - A feature to enable website-hotfixing via the Web Compatibility System-Addon.

  • 🔴 Web Add-ons - A feature that provides functionality for managing add-ons.

UI

Generic low-level UI components for building apps.

  • 🔵 Autocomplete - A set of components to provide autocomplete functionality.

  • 🔵 Colors - The standard set of Photon colors.

  • 🔵 Fonts - The standard set of fonts used by Mozilla Android products.

  • 🔵 Icons - A collection of often used browser icons.

  • ⚪ Tabcounter - A button that shows the current tab count and can animate state changes.

Service

Components and libraries to interact with backend services.

  • 🔵 Firefox Accounts (FxA) - A library for integrating with Firefox Accounts.

  • 🔵 Firefox Sync - Logins - A library for integrating with Firefox Sync - Logins.

  • 🔵 Fretboard - An Android framework for segmenting users in order to run A/B tests and roll out features gradually.

  • 🔴 Glean - A client-side telemetry SDK for collecting metrics and sending them to Mozilla's telemetry service (eventually replacing service-telemetry).

  • 🔴 Experiments - An Android SDK for running experiments on user segments in multiple branches.

  • ⚪ Location - A library for accessing Mozilla's and other location services.

  • 🔴 Pocket - A library for communicating with the Pocket API.

  • 🔵 Telemetry - A generic library for sending telemetry pings from Android applications to Mozilla's telemetry service.

Support

Supporting components with generic helper code.

  • 🔵 Android Test - A collection of helpers for testing components in instrumented (on device) tests (src/androidTest).

  • 🔵 Base - Base component containing building blocks for components.

  • 🔵 Ktx - A set of Kotlin extensions on top of the Android framework and Kotlin standard library.

  • ⚪ Migration - Helper code to migrate from a Fennec-based (Firefox for Android) app to an Android Components based app.

  • 🔵 Test - A collection of helpers for testing components in local unit tests (src/test).

  • 🔵 Test Appservices - A component for synchronizing Application Services' unit testing dependencies used in Android Components.

  • 🔵 Test LibState - A collection of helpers for testing functionality that relies on the lib-state component in local unit tests (src/test).

  • 🔵 Utils - Generic utility classes to be shared between projects.

  • 🔵 Webextensions - A component containing building blocks for features implemented as web extensions.

Standalone libraries

Tooling

  • 🔵 Fetch-Tests - A generic test suite for components that implement concept-fetch.

  • 🔵 Lint - Custom Lint rules for the components repository.

Sample apps

Sample apps using various components.

  • Browser - A simple browser composed from browser components. This sample application is only a very basic browser. For a full-featured reference browser implementation see the reference-browser repository.

  • Crash - An app showing the integration of the lib-crash component.

  • Firefox Accounts (FxA) - A simple app demoing Firefox Accounts integration.

  • Firefox Sync - A simple app demoing general Firefox Sync integration, with bookmarks and history.

  • Firefox Sync - Logins - A simple app demoing Firefox Sync (Logins) integration.

  • DataProtect - An app demoing how to use the Dataprotect component to load and store encrypted data in SharedPreferences.

  • Glean - An app demoing how to use the Glean library to collect and send telemetry data.

  • Nearby Chat - An app demoing how to use the Nearby library for peer-to-peer communication between devices.

  • Toolbar - An app demoing multiple customized toolbars using the browser-toolbar component.

Building

Command line

$ git clone https://github.com/mozilla-mobile/android-components.git
$ cd android-components
$ ./gradlew assemble

Android Studio

If the environment variable JAVA_HOME is not defined, you will need to set it. If you would like to use the JDK installed by Android Studio, here's how to find it:

  1. Open Android Studio.
  2. Select "Configure".
  3. Select "Default Project Structure". You should now see the Android JDK location.
  4. Set the environment variable JAVA_HOME to the location. (How you set an environment variable depends on your OS.)
  5. Restart Android Studio.

Once the environment variable is set, you can import the project into Android Studio with the default wizard options.

If your build fails, you may find you get more instructive error messages by attempting the build at the command line.

Coding Standards

Style

We follow the style enforced by ktlint and detekt. See how to configure Android Studio appropriately.

To check your style, run:

./gradlew ktlint
./gradlew detekt

Documentation

We use README.md files and Dokka, which you can generate with:

./gradlew dokka                          # Generate dokka for the entire repo
./gradlew :browser-icons:dokka           # Generate dokka for a specified module

If you fix a bug or change an API, you should update docs/changelog.md.

Testing

You are expected to both add tests for code that you write and make sure that your changes do not cause existing tests to fail. You may find these command lines helpful:

./gradlew test                            # Run all tests
./gradlew :support-ktx:testdebugunittest  # Run unit tests for a specified module

See also how to measure code coverage.

Accessibility

If your code has user-facing changes, follow Android accessibility best practices.

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/