Bug 1571913 - Quantumbar: Allow keyword offers to specify whether to show the keyword, and fix secondary text color when there's no title. r=dao

Replace the "is heuristic?" logic for hiding keywords in keyword offers with something more flexible. Here's how the top sites extension uses this new `keywordOffer` payload property: 8408d13d2f

When a result's title is hidden, use the title color for the secondary color.

Differential Revision: https://phabricator.services.mozilla.com/D40898

--HG--
extra : moz-landing-system : lando

browser/components/urlbar/UrlbarInput.jsm

@@ -487,7 +487,7 @@ class UrlbarInput {
     };
 
     let selIndex = this.view.selectedIndex;
-    if (!result.payload.isKeywordOffer) {
+    if (!result.payload.keywordOffer) {
       this.view.close();
     }
 
@@ -544,7 +544,7 @@ class UrlbarInput {
         return;
       }
       case UrlbarUtils.RESULT_TYPE.SEARCH: {
-        if (result.payload.isKeywordOffer) {
+        if (result.payload.keywordOffer) {
           // The user confirmed a token alias, so just move the caret
           // to the end of it. Because there's a trailing space in the value,
           // the user can directly start typing a query string at that point.

browser/components/urlbar/UrlbarProviderUnifiedComplete.jsm

@@ -208,19 +208,21 @@ function convertResultToMatches(context, result, urls) {
     }
     urls.add(url);
     let style = result.getStyleAt(i);
+    let isHeuristic = i == 0 && style.includes("heuristic");
     let match = makeUrlbarResult(context.tokens, {
       url,
       icon: result.getImageAt(i),
       style,
       comment: result.getCommentAt(i),
       firstToken: context.tokens[0],
+      isHeuristic,
     });
     // Should not happen, but better safe than sorry.
     if (!match) {
       continue;
     }
     // Manage autofill and preselected properties for the first match.
-    if (i == 0 && style.includes("heuristic")) {
+    if (isHeuristic) {
       if (style.includes("autofill") && result.defaultIndex == 0) {
         let autofillValue = result.getValueAt(i);
         if (
@@ -256,7 +258,17 @@ function makeUrlbarResult(tokens, info) {
   let action = PlacesUtils.parseActionUrl(info.url);
   if (action) {
     switch (action.type) {
-      case "searchengine":
+      case "searchengine": {
+        let keywordOffer = UrlbarUtils.KEYWORD_OFFER.NONE;
+        if (
+          action.params.alias &&
+          !action.params.searchQuery.trim() &&
+          action.params.alias.startsWith("@")
+        ) {
+          keywordOffer = info.isHeuristic
+            ? UrlbarUtils.KEYWORD_OFFER.HIDE
+            : UrlbarUtils.KEYWORD_OFFER.SHOW;
+        }
         return new UrlbarResult(
           UrlbarUtils.RESULT_TYPE.SEARCH,
           UrlbarUtils.RESULT_SOURCE.SEARCH,
@@ -272,13 +284,10 @@ function makeUrlbarResult(tokens, info) {
               UrlbarUtils.HIGHLIGHT.TYPED,
             ],
             icon: [info.icon],
-            isKeywordOffer: [
-              action.params.alias &&
-                !action.params.searchQuery.trim() &&
-                action.params.alias.startsWith("@"),
-            ],
+            keywordOffer,
           })
         );
+      }
       case "keyword": {
         let title = info.comment;
         if (!title) {

browser/components/urlbar/UrlbarResult.jsm

@@ -116,10 +116,11 @@ class UrlbarResult {
           ? [this.payload.title, this.payloadHighlights.title]
           : [this.payload.url || "", this.payloadHighlights.url || []];
       case UrlbarUtils.RESULT_TYPE.SEARCH:
-        if (this.payload.isKeywordOffer) {
-          return this.heuristic
-            ? ["", []]
-            : [this.payload.keyword, this.payloadHighlights.keyword];
+        switch (this.payload.keywordOffer) {
+          case UrlbarUtils.KEYWORD_OFFER.SHOW:
+            return [this.payload.keyword, this.payloadHighlights.keyword];
+          case UrlbarUtils.KEYWORD_OFFER.HIDE:
+            return ["", []];
         }
         return this.payload.suggestion
           ? [this.payload.suggestion, this.payloadHighlights.suggestion]

browser/components/urlbar/UrlbarUtils.jsm

@@ -135,6 +135,17 @@ var UrlbarUtils = {
     SUGGESTED: 2,
   },
 
+  // Search results with keywords and empty queries are called "keyword offers".
+  // When the user selects a keyword offer, the keyword followed by a space is
+  // put in the input as a hint that the user can search using the keyword.
+  // Depending on the use case, keyword-offer results can show or not show the
+  // keyword itself.
+  KEYWORD_OFFER: {
+    NONE: 0,
+    SHOW: 1,
+    HIDE: 2,
+  },
+
   // UnifiedComplete's autocomplete results store their titles and tags together
   // in their comments.  This separator is used to separate them.  When we
   // rewrite UnifiedComplete for quantumbar, we should stop using this old hack

browser/components/urlbar/UrlbarView.jsm

@@ -586,7 +586,7 @@ class UrlbarView {
 
     if (
       result.type == UrlbarUtils.RESULT_TYPE.SEARCH &&
-      !result.payload.isKeywordOffer
+      !result.payload.keywordOffer
     ) {
       item.setAttribute("type", "search");
     } else if (result.type == UrlbarUtils.RESULT_TYPE.REMOTE_TAB) {

browser/components/urlbar/docs/overview.rst

@@ -374,7 +374,7 @@ The following RESULT_TYPEs are supported:
 
     // Payload: { icon, url, userContextId }
     TAB_SWITCH: 1,
-    // Payload: { icon, suggestion, keyword, query, isKeywordOffer }
+    // Payload: { icon, suggestion, keyword, query, keywordOffer }
     SEARCH: 2,
     // Payload: { icon, url, title, tags }
     URL: 3,

browser/themes/shared/urlbar-autocomplete.inc.css

@@ -149,12 +149,15 @@
   font-weight: 600;
 }
 
-.urlbarView-secondary {
+.urlbarView-title:not(:empty) ~ .urlbarView-secondary {
   color: var(--urlbar-popup-action-color);
 }
 
 .urlbarView-url {
   overflow: hidden;
+}
+
+.urlbarView-title:not(:empty) ~ .urlbarView-url {
   color: var(--urlbar-popup-url-color);
 }