browser/components/urlbar/docs/index.rst

   1 Address Bar
   2 ===========
   3
   4 This document describes the implementation of Firefox's address bar, also known
   5 as the quantumbar or urlbar. The address bar was also called the awesomebar
   6 until Firefox 68, when it was substantially rewritten.
   7
   8 The address bar is a specialized search access point that aggregates data from
   9 several different sources, including:
  10
  11   * Places (Firefox's history and bookmarks system)
  12   * Search engines (including search suggestions)
  13   * WebExtensions
  14   * Open tabs
  15
  16 Where to Start
  17 --------------
  18
  19 If you want a high level, nontechnical summary of how the address bar works,
  20 read :doc:`nontechnical-overview`.
  21
  22 If you are interested in the technical details, you might want to skip ahead to
  23 :doc:`overview`.
  24
  25 Codebase
  26 --------
  27
  28 The address bar code lives in `browser/components/urlbar <https://searchfox.org/mozilla-central/source/browser/components/urlbar/>`_.
  29
  30 Table of Contents
  31 -----------------
  32
  33 .. toctree::
  34
  35    nontechnical-overview
  36    overview
  37    lifetime
  38    utilities
  39    telemetry
  40    firefox-suggest-telemetry
  41    debugging
  42    ranking
  43    dynamic-result-types
  44    preferences
  45    testing
  46    contact
  47
  48 API Reference
  49 -------------
  50
  51 .. toctree::
  52
  53    UrlbarController
  54    UrlbarInput
  55    UrlbarView