forked from mirrors/gecko-dev
88d0fc3d57
This does the following: * Add the urlbar root directory to the list of sphinx-js directories * Add three new rst files for the automatically generated API docs for UrlbarController, UrlbarInput, and UrlbarView * Add a new top-level section to the urlbar's index.rst for these three docs * Tweak two JSDocs in UrlbarSearchOneOffs so that sphinx-js doesn't complain This should be a good starting place for integrating automatically generated API docs into the urlbar docs, and we can iterate on it from here. Differential Revision: https://phabricator.services.mozilla.com/D139780
55 lines
1.2 KiB
ReStructuredText
55 lines
1.2 KiB
ReStructuredText
Address Bar
|
|
===========
|
|
|
|
This document describes the implementation of Firefox's address bar, also known
|
|
as the quantumbar or urlbar. The address bar was also called the awesomebar
|
|
until Firefox 68, when it was substantially rewritten.
|
|
|
|
The address bar is a specialized search access point that aggregates data from
|
|
several different sources, including:
|
|
|
|
* Places (Firefox's history and bookmarks system)
|
|
* Search engines (including search suggestions)
|
|
* WebExtensions
|
|
* Open tabs
|
|
|
|
Where to Start
|
|
--------------
|
|
|
|
If you want a high level, nontechnical summary of how the address bar works,
|
|
read :doc:`nontechnical-overview`.
|
|
|
|
If you are interested in the technical details, you might want to skip ahead to
|
|
:doc:`overview`.
|
|
|
|
Codebase
|
|
--------
|
|
|
|
The address bar code lives in `browser/components/urlbar <https://searchfox.org/mozilla-central/source/browser/components/urlbar/>`_.
|
|
|
|
Table of Contents
|
|
-----------------
|
|
|
|
.. toctree::
|
|
|
|
nontechnical-overview
|
|
overview
|
|
lifetime
|
|
utilities
|
|
telemetry
|
|
firefox-suggest-telemetry
|
|
debugging
|
|
experiments
|
|
dynamic-result-types
|
|
preferences
|
|
testing
|
|
contact
|
|
|
|
API Reference
|
|
-------------
|
|
|
|
.. toctree::
|
|
|
|
UrlbarController
|
|
UrlbarInput
|
|
UrlbarView
|