summaryrefslogtreecommitdiffstats
path: root/browser/components/urlbar/docs/utilities.rst
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/urlbar/docs/utilities.rst')
-rw-r--r--browser/components/urlbar/docs/utilities.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/browser/components/urlbar/docs/utilities.rst b/browser/components/urlbar/docs/utilities.rst
new file mode 100644
index 0000000000..9e30087872
--- /dev/null
+++ b/browser/components/urlbar/docs/utilities.rst
@@ -0,0 +1,25 @@
+Utilities
+=========
+
+Various modules provide shared utilities to the other components:
+
+`UrlbarPrefs.jsm <https://searchfox.org/mozilla-central/source/browser/components/urlbar/UrlbarPrefs.jsm>`_
+-------------------------------------------------------------------------------------------------------------
+
+Implements a Map-like storage or urlbar related preferences. The values are kept
+up-to-date.
+
+.. code:: JavaScript
+
+ // Always use browser.urlbar. relative branch, except for the preferences in
+ // PREF_OTHER_DEFAULTS.
+ UrlbarPrefs.get("delay"); // Gets value of browser.urlbar.delay.
+
+.. note::
+
+ Newly added preferences should always be properly documented in UrlbarPrefs.
+
+`UrlbarUtils.jsm <https://searchfox.org/mozilla-central/source/browser/components/urlbar/UrlbarUtils.jsm>`_
+-------------------------------------------------------------------------------------------------------------
+
+Includes shared utils and constants shared across all the components.