preferences.rst (11290B)
1 Preferences 2 =========== 3 4 This document describes Preferences affecting the Firefox's address bar. 5 Preferences that are generated and updated by code won't be described here. 6 7 User Exposed 8 ------------ 9 These preferences are exposed through the Firefox UI. 10 11 browser.urlbar.shortcuts.bookmarks (boolean, default: true) 12 Whether to show the bookmark search shortcut button in the view. 13 Can be controlled from Search Preferences. 14 15 browser.urlbar.shortcuts.tabs (boolean, default: true) 16 Whether to show the tabs search shortcut button in the view. 17 Can be controlled from Search Preferences. 18 19 browser.urlbar.shortcuts.history (boolean, default: true) 20 Whether to show the history search shortcut button in the view. 21 Can be controlled from Search Preferences. 22 23 browser.urlbar.showSearchSuggestionsFirst (boolean, default: true) 24 Whether to show search suggestions before general results. 25 Can be controlled from Search Preferences. 26 27 browser.urlbar.showSearchTerms.enabled (boolean, default: true) 28 Whether to show the search term in the urlbar 29 on a default search engine results page. 30 Can be controlled from Search Preferences. 31 32 browser.urlbar.suggest.bookmark (boolean, default: true) 33 Whether results will include the user's bookmarks. 34 Can be controlled from Privacy Preferences. 35 36 browser.urlbar.suggest.history (boolean, default: true) 37 Whether results will include the user's history. 38 Can be controlled from Privacy Preferences. 39 40 browser.urlbar.suggest.openpage (boolean, default: true) 41 Whether results will include switch-to-tab results. 42 Can be controlled from Privacy Preferences. 43 44 browser.urlbar.suggest.quicksuggest.all (boolean, default: false) 45 If ``browser.urlbar.quicksuggest.enabled`` is true, this controls whether 46 results will include suggestions that are part of the Firefox Suggest brand. 47 Otherwise they will not be included. 48 49 browser.urlbar.suggest.quicksuggest.sponsored (boolean, default: false) 50 If ``browser.urlbar.quicksuggest.enabled`` and 51 ``browser.urlbar.suggest.quicksuggest.all`` are true, this controls whether 52 results will include sponsored Firefox Suggest suggestions. Otherwise they 53 will not be included. 54 55 browser.urlbar.suggest.searches (boolean, default: true) 56 Whether results will include search suggestions. 57 Can be controlled from Search Preferences. 58 59 browser.urlbar.suggest.engines (boolean, default: true) 60 Whether results will include search engines (e.g. tab-to-search). 61 Can be controlled from Privacy Preferences. 62 63 browser.urlbar.suggest.topsites (boolean, default: true) 64 Whether results will include top sites and the view will open on focus. 65 Can be controlled from Privacy Preferences. 66 67 browser.search.suggest.enabled (boolean, default: true) 68 Whether search suggestions are enabled globally, including the separate search 69 bar. 70 Can be controlled from Search Preferences. 71 72 browser.search.suggest.enabled.private (boolean, default: false) 73 When search suggestions are enabled, controls whether they are provided in 74 Private Browsing windows. 75 Can be controlled from Search Preferences. 76 77 78 Hidden 79 ------ 80 These preferences are normally hidden, and should not be used unless you really 81 know what you are doing. 82 83 browser.urlbar.accessibility.tabToSearch.announceResults (boolean: default: true) 84 Whether we announce to screen readers when tab-to-search results are inserted. 85 86 browser.urlbar.addons.featureGate (boolean, default: false) 87 Feature gate pref for add-on suggestions in the urlbar. 88 89 browser.urlbar.autoFill (boolean, default: true) 90 Autofill is the the feature that automatically completes domains and URLs that 91 the user has visited as the user is typing them in the urlbar textbox. 92 93 browser.urlbar.autoFill.adaptiveHistory.enabled (boolean, default: false) 94 Whether adaptive history autofill feature is enabled. 95 96 browser.urlbar.autoFill.adaptiveHistory.useCountThreshold (float, default: 1.0) 97 Threshold for use count of input history that we handle as adaptive history 98 autofill. If the use count is this value or more, it will be a candidate. 99 100 browser.urlbar.autoFill.stddevMultiplier (float, default: 0.0) 101 Affects the frecency threshold of the autofill algorithm. The threshold is 102 the mean of all origin frecencies, plus one standard deviation multiplied by 103 this value. 104 105 browser.urlbar.ctrlCanonizesURLs (boolean, default: true) 106 Whether using `ctrl` when hitting return/enter in the URL bar (or clicking 107 'go') should prefix 'www.' and suffix browser.fixup.alternate.suffix to the 108 user value prior to navigating. 109 110 browser.urlbar.decodeURLsOnCopy (boolean, default: false) 111 Whether copying the entire URL from the location bar will put a human 112 readable (percent-decoded) URL on the clipboard. 113 114 browser.urlbar.delay (number, default: 50) 115 The amount of time (ms) to wait after the user has stopped typing before 116 fetching certain results. Reducing this doesn't make the Address Bar faster, 117 it will instead make it access the disk more heavily, and potentially make it 118 slower. Certain results, like the heuristic, always skip this timer anyway. 119 120 browser.urlbar.dnsResolveSingleWordsAfterSearch (number, default: 0) 121 Controls when to DNS resolve single word search strings, after they were 122 searched for. If the string is resolved as a valid host, show a 123 "Did you mean to go to 'host'" prompt. 124 Set to 0. 0: Never resolve, 1: Use heuristics, 2. Always resolve. 125 126 browser.urlbar.extension.timeout (integer, default: 400) 127 When sending events to extensions, they have this amount of time in 128 milliseconds to respond before timing out. This affects the omnibox API. 129 130 browser.urlbar.filter.javascript (boolean, default: true) 131 When true, `javascript:` URLs are not included in search results for safety 132 reasons. 133 134 browser.urlbar.focusContentDocumentOnEsc (boolean, default: true) 135 Focus the content document when pressing the Escape key, if there's no 136 remaining typed history. 137 138 browser.urlbar.formatting.enabled (boolean, default: true) 139 Applies URL highlighting and other styling to the text in the urlbar input 140 field. This should usually be enabled for security reasons. 141 142 browser.urlbar.maxCharsForSearchSuggestions (integer, default: 100) 143 As a user privacy measure, we don't fetch results from remote services for 144 searches that start by pasting a string longer than this. The pref name 145 indicates search suggestions, but this is used for all remote results. 146 147 browser.urlbar.maxHistoricalSearchSuggestions (integer, default: 2) 148 The maximum number of form history results to include as search history. 149 150 browser.urlbar.maxRichResults (integer, default: 10) 151 The maximum number of results in the urlbar popup. 152 153 browser.urlbar.merino.clientVariants (string, default: "") 154 Comma separated list of client variants to send to send to Merino. See 155 `Merino API docs <https://mozilla-services.github.io/merino/api.html#suggest>`_ 156 for more details. This is intended to be used by experiments, not directly set 157 by users. 158 159 browser.urlbar.merino.providers (string, default: "") 160 Comma-separated list of providers to request from the Merino server. Merino 161 will return suggestions only for these providers. See `Merino API docs`_ for 162 more details. 163 164 browser.urlbar.openintab (boolean, default: false) 165 Whether address bar results should be opened in new tabs by default. 166 167 browser.urlbar.quicksuggest.enabled (boolean, default: false) 168 Whether the quick suggest feature is enabled, i.e., sponsored and recommended 169 results related to the user's search string. This pref can be overridden by 170 the ``quickSuggestEnabled`` Nimbus variable. If false, neither sponsored nor 171 non-sponsored quick suggest results will be shown. If true, then we look at 172 the individual prefs ``browser.urlbar.suggest.quicksuggest.all`` and 173 ``browser.urlbar.suggest.quicksuggest.sponsored``. 174 175 browser.urlbar.quicksuggest.online.available (boolean, default: false) 176 Whether online Firefox Suggest is available to the user. This is only 177 relevant when Suggest overall is enabled. When true, a checkbox will be 178 shown in the settings UI allowing to the user to toggle online Suggest. 179 180 browser.urlbar.quicksuggest.online.enabled (boolean, default: true) 181 Whether Firefox Suggest retrieves online suggestions from Merino. This pref 182 is only relevant when Suggest overall is enabled and online Suggest is 183 available to the user; otherwise online suggestions are disabled. In 184 addition, when the relevant Oblivious HTTP (OHTTP) Merino prefs are set, 185 online suggestions will be fetched over OHTTP. 186 187 browser.urlbar.richSuggestions.tail (boolean, default: true) 188 If true, we show tail search suggestions when available. 189 190 browser.urlbar.searchTips.test.ignoreShowLimits (boolean, default: false) 191 Disables checks that prevent search tips being shown, thus showing them every 192 time the newtab page or the default search engine homepage is opened. 193 This is useful for testing purposes. 194 195 browser.urlbar.speculativeConnect.enabled (boolean, default: true) 196 Speculative connections allow to resolve domains preemptively when the user 197 is likely to pick a result from the Address Bar. This allows for faster 198 navigation. 199 200 browser.urlbar.sponsoredTopSites (boolean, default: false) 201 Whether top sites may include sponsored ones. 202 203 browser.urlbar.suggest.addons (boolean, default: true) 204 If ``browser.urlbar.addons.featureGate`` is true, this controls whether add-on 205 suggestions are turned on. Otherwise they won't be shown. 206 207 browser.urlbar.suggest.yelp (boolean, default: true) 208 If ``browser.urlbar.yelp.featureGate`` is true, this controls whether Yelp 209 suggestions are turned on. Otherwise they won't be shown. 210 211 browser.urlbar.switchTabs.adoptIntoActiveWindow (boolean, default: false) 212 When using switch to tabs, if set to true this will move the tab into the 213 active window, instead of just switching to it. 214 215 browser.urlbar.trimURLs (boolean, default: true) 216 Clean-up URLs when showing them in the Address Bar. 217 218 keyword.enabled (boolean, default: true) 219 By default, when the search string is not recognized as a potential url, 220 search for it with the default search engine. If set to false any string will 221 be handled as a potential URL, even if it's invalid. 222 223 browser.fixup.dns_first_for_single_words (boolean, default: false) 224 If true, any single word search string will be sent to the DNS server before 225 deciding whether to search or visit it. This may add a delay to the urlbar. 226 227 228 Experimental 229 ------------ 230 These preferences are experimental and not officially supported. They could be 231 removed at any time. 232 233 browser.urlbar.suggest.calculator (boolean, default: false) 234 Whether results will include a calculator. 235 236 browser.urlbar.unitConversion.enabled (boolean, default: false) 237 Whether unit conversion is enabled. 238 239 browser.urlbar.unitConversion.suggestedIndex (integer, default: 1) 240 The index where we show unit conversion results. 241 242 browser.urlbar.keepPanelOpenDuringImeComposition (boolean, default: false) 243 Whether the results panel should be kept open during IME composition. The 244 panel may overlap with the IME compositor panel. 245 246 browser.urlbar.restyleSearches (boolean, default: false) 247 When true, URLs in the user's history that look like search result pages 248 are restyled to look like search engine results instead of history results.