@ably/ui 7.9.4 → 7.10.0-dev.e980a00

package/src/core/MeganavContentWhyAbly/component.jsx

@@ -42,7 +42,7 @@ const MeganavContentWhyAbly = ({ absUrl }) => {
           </li>
 
           <li>
-            <a href={absUrl("/resources/datasheets")} className="group ui-meganav-media py-12">
+            <a href={absUrl("/resources")} className="group ui-meganav-media py-12">
               <p className="ui-meganav-media-heading">Resources</p>
             </a>
           </li>

package/src/core/MeganavControl/component.html.erb

@@ -1,6 +1,6 @@
 <%= button_tag(type: "button",
-               class: ["ui-meganav-link", "h-64", "flex", "items-center", "group", theme(:text_color)],
+               class: ["ui-meganav-link", "h-64", "flex", "items-center", "group", theme(:text_color), additional_css],
                data: { id: "meganav-control" },
-               aria: { expanded: false, controls: @aria_controls, label: "Show #{content}" }) do -%>
+               aria: { expanded: false, controls: aria_controls, label: "Show #{content}" }) do -%>
   <%= content -%><%= render(AblyUi::Core::Icon.new(name: "icon-gui-disclosure-arrow", size: "1.5rem", color: "text-cool-black", additional_css: "transform rotate-90 group-hover:text-gui-hover group-focus:text-gui-focus")) %>
 <% end %>

package/src/core/MeganavControl/component.js

@@ -1,4 +1,4 @@
-import { queryIdAll } from "../dom-query";
+import { queryId, queryIdAll } from "../dom-query";
 
 const MeganavControl = () => {
   const controls = Array.from(queryIdAll("meganav-control"));
@@ -12,11 +12,21 @@ const MeganavControl = () => {
       `(hover: hover) and (pointer: fine) and (min-width: ${mdBreakpoint})`
     ).matches;
 
+  const isSearchControl = (node) => node.dataset.control === "search";
+
+  const isSearchPanelOpen = () => {
+    const searchPanel = document.querySelector(
+      '[data-id="meganav-panel"]#panel-search'
+    );
+    if (!searchPanel) return;
+    return !searchPanel.classList.contains("invisible");
+  };
+
   const controlsHaveFocus = () =>
     controls.some((control) => control === document.activeElement);
 
   const hover = (control, panel, open) => {
-    if (hoverEnabled() && !controlsHaveFocus()) {
+    if (hoverEnabled() && !controlsHaveFocus() && !isSearchPanelOpen()) {
       const classes = ["invisible", "visible"];
       panel.classList.replace(...(open ? classes : classes.reverse()));
       control.setAttribute("aria-expanded", open);
@@ -40,12 +50,20 @@ const MeganavControl = () => {
 
     const ariaExpanded = control.getAttribute("aria-expanded");
 
-    if (ariaExpanded) {
+    if (ariaExpanded === "true") {
+      control.setAttribute("aria-expanded", false);
+      panel.classList.replace("visible", "invisible");
+    } else {
       control.setAttribute("aria-expanded", true);
       panel.classList.replace("invisible", "visible");
+    }
+
+    if (isSearchControl(control)) {
+      const searchInput = queryId("meganav-search-input", panel);
+      if (!searchInput) return;
+      searchInput.focus();
     } else {
-      control.setAttribute("aria-expanded", false);
-      panel.classList.replace("visible", "invisible");
+      control.focus();
     }
   };
 
@@ -56,18 +74,25 @@ const MeganavControl = () => {
         `#${control.getAttribute("aria-controls")}`
       );
       const click = clickHandler(control, panel);
-      const mouseenter = mouseenterHandler(control, panel);
-      const mouseleave = mouseleaveHandler(control, panel);
-
-      item.addEventListener("mouseenter", mouseenter);
-      item.addEventListener("mouseleave", mouseleave);
       control.addEventListener("click", click);
+      let mouseenter, mouseleave;
+
+      if (!isSearchControl(control)) {
+        mouseenter = mouseenterHandler(control, panel);
+        mouseleave = mouseleaveHandler(control, panel);
+
+        item.addEventListener("mouseenter", mouseenter);
+        item.addEventListener("mouseleave", mouseleave);
+      }
 
       return [
         {
           teardown: () => {
-            item.removeEventListener("mouseenter", mouseenter);
-            item.removeEventListener("mouseleave", mouseleave);
+            if (mouseenter && mouseleave) {
+              item.removeEventListener("mouseenter", mouseenter);
+              item.removeEventListener("mouseleave", mouseleave);
+            }
+
             control.removeEventListener("click", click);
           },
           clear: () => {

package/src/core/MeganavControl/component.jsx

@@ -3,11 +3,11 @@ import T from "prop-types";
 
 import Icon from "../Icon/component.jsx";
 
-const MeganavControl = ({ ariaControls, children, theme }) => (
+const MeganavControl = ({ ariaControls, children, theme, additionalCSS }) => (
   <button
     type="button"
     data-id="meganav-control"
-    className={`ui-meganav-link h-64 flex items-center group ${theme.textColor}`}
+    className={`ui-meganav-link h-64 flex items-center group ${additionalCSS} ${theme.textColor}`}
     aria-expanded="false"
     aria-controls={ariaControls}
     aria-label={`Show ${children}`}
@@ -26,6 +26,7 @@ MeganavControl.propTypes = {
   ariaControls: T.string,
   children: T.node,
   theme: T.object,
+  additionalCSS: T.string,
 };
 
 export default MeganavControl;

package/src/core/MeganavControl/component.rb

@@ -2,9 +2,11 @@ module AblyUi
   module Core
     class MeganavControl < ViewComponent::Base
       include AblyUi::Core::MeganavConfig
+      attr_reader :aria_controls, :additional_css
 
-      def initialize(aria_controls:, theme_name:)
+      def initialize(aria_controls:, theme_name:, additional_css: '')
         @aria_controls = aria_controls
+        @additional_css = additional_css
         theme_setup(theme_name)
       end
     end

package/src/core/MeganavControlMobileDropdown/component.js

@@ -7,6 +7,8 @@ const MeganavControlMobileDropdown = ({ clearPanels }) => {
   const dropdown = queryId("meganav-mobile-dropdown");
   const menuIcon = queryId("meganav-control-mobile-dropdown-menu");
   const closeIcon = queryId("meganav-control-mobile-dropdown-close");
+  const meganavSearchSuggestionsToggle = queryId("meganav-mobile-search-input");
+  const meganavSearchSuggestions = queryId("meganav-mobile-search-suggestions");
 
   const clickHandler = () => {
     const ariaExpanded = control.getAttribute("aria-expanded");
@@ -26,12 +28,40 @@ const MeganavControlMobileDropdown = ({ clearPanels }) => {
     closeIcon.classList.toggle("hidden");
   };
 
+  const focusSuggestionsHandler = () => {
+    meganavSearchSuggestions.classList.add("max-h-96");
+  };
+  const blurSuggestionsHandler = (event) => {
+    if (
+      event.relatedTarget === meganavSearchSuggestions.querySelectorAll("a")[0]
+    ) {
+      return;
+    }
+    meganavSearchSuggestions.classList.remove("max-h-96");
+  };
+
   control.addEventListener("click", clickHandler);
+  meganavSearchSuggestionsToggle.addEventListener(
+    "focus",
+    focusSuggestionsHandler
+  );
+  meganavSearchSuggestionsToggle.addEventListener(
+    "blur",
+    blurSuggestionsHandler
+  );
 
   return {
     teardown: () => {
       control.removeEventListener("click", clickHandler);
       scrollLock.enablePageScroll();
+      meganavSearchSuggestionsToggle.removeEventListener(
+        "focus",
+        focusSuggestionsHandler
+      );
+      meganavSearchSuggestionsToggle.removeEventListener(
+        "blur",
+        blurSuggestionsHandler
+      );
     },
     clear: () => {
       dropdown.classList.replace("visible", "invisible");
@@ -39,6 +69,7 @@ const MeganavControlMobileDropdown = ({ clearPanels }) => {
       menuIcon.classList.remove("hidden");
       closeIcon.classList.add("hidden");
       scrollLock.enablePageScroll();
+      meganavSearchSuggestions.classList.remove("max-h-96");
     },
   };
 };

package/src/core/MeganavItemsMobile/component.html.erb

@@ -11,8 +11,35 @@
     <%= render(AblyUi::Core::MeganavControlMobileDropdown.new(theme_name: @theme_name)) %>
 
     <div class="ui-meganav-mobile-dropdown invisible" id="meganav-mobile-dropdown" data-id="meganav-mobile-dropdown">
-      <div class="py-16 ui-grid-px bg-white">
-        <ul class="mb-16">
+      <div class="pt-24 pb-16 ui-grid-px bg-white">
+        <%= tag.form class: "mb-16", action: abs_url("/search"), method: "get" do %>
+          <div class="relative w-full">
+            <%= render(AblyUi::Core::Icon.new(name: "icon-gui-search", size: "1.5rem", color: "text-cool-black", additional_css: "absolute top-12 left-16 hover:text-gui-hover")) %>
+            <button
+              type="button"
+              class="absolute top-12 right-16 p-0 focus:outline-gui-focus m-0 md:hidden invisible"
+              data-id="meganav-search-input-clear"
+            >
+              <%= render(AblyUi::Core::Icon.new(name: "icon-gui-cross-circled-fill", size: "1.5rem", color: "text-dark-grey")) %>
+            </button>
+            <input
+              type="search"
+              name="q"
+              class="ui-input px-48 h-48"
+              style={{ maxWidth: "none" }}
+              placeholder="Search"
+              data-id="meganav-mobile-search-input"
+            />
+
+            <%= render(AblyUi::Core::MeganavSearchAutocomplete.new) %>
+          </div>
+        <% end %>
+
+        <div class="max-h-0 overflow-hidden transition-all" data-id="meganav-mobile-search-suggestions">
+           <%= render(AblyUi::Core::MeganavSearchSuggestions.new(url_base: url_base, display_support_link: false)) %>
+        </div>
+
+        <ul class="mb-16" data-id="meganav-mobile-panel-controls">
           <% panels.each do |panel| %>
             <li class="ui-meganav-mobile-item">
               <%= render(AblyUi::Core::MeganavControlMobilePanelOpen.new(aria_controls: "#{panel[:id]}-mobile")) do %>

package/src/core/MeganavItemsMobile/component.jsx

@@ -2,11 +2,14 @@ import React from "react";
 import T from "prop-types";
 
 import SignOutLink from "../SignOutLink/component.jsx";
+import MeganavSearchSuggestions from "../MeganavSearchSuggestions/component.jsx";
+import Icon from "../Icon/component.jsx";
 
 import MeganavData from "../Meganav/component.json";
 import MeganavControlMobileDropdown from "../MeganavControlMobileDropdown/component.jsx";
 import MeganavControlMobilePanelClose from "../MeganavControlMobilePanelClose/component.jsx";
 import MeganavControlMobilePanelOpen from "../MeganavControlMobilePanelOpen/component.jsx";
+import MeganavSearchAutocomplete from "../MeganavSearchAutocomplete/component.jsx";
 
 const MeganavItemsMobile = ({ panels, paths, sessionState, theme, loginLink, absUrl }) => {
   const classNames = `ui-meganav-link ${theme.textColor}`;
@@ -33,8 +36,35 @@ const MeganavItemsMobile = ({ panels, paths, sessionState, theme, loginLink, abs
         <MeganavControlMobileDropdown theme={theme} />
 
         <div className="ui-meganav-mobile-dropdown invisible" id="meganav-mobile-dropdown" data-id="meganav-mobile-dropdown">
-          <div className="py-16 ui-grid-px bg-white">
-            <ul className="mb-16">
+          <div className="pt-24 pb-16 ui-grid-px bg-white">
+            <form className="mb-16" action={absUrl("/search")} method="get">
+              <div className="relative w-full">
+                <Icon name="icon-gui-search" color="text-cool-black" size="1.5rem" additionalCSS="absolute top-12 left-16 hover:text-gui-hover" />
+                <button
+                  type="button"
+                  className="absolute top-12 right-16 p-0 focus:outline-gui-focus m-0 md:hidden invisible"
+                  data-id="meganav-search-input-clear"
+                >
+                  <Icon name="icon-gui-cross-circled-fill" color="text-dark-grey" size="1.5rem" additionalCSS="" />
+                </button>
+                <input
+                  type="search"
+                  name="q"
+                  className="ui-input px-48 h-48"
+                  style={{ maxWidth: "none" }}
+                  placeholder="Search"
+                  data-id="meganav-mobile-search-input"
+                />
+
+                <MeganavSearchAutocomplete />
+              </div>
+            </form>
+
+            <div className="max-h-0 overflow-hidden transition-all" data-id="meganav-mobile-search-suggestions">
+              <MeganavSearchSuggestions absUrl={absUrl} displaySupportLink={false} />
+            </div>
+
+            <ul className="mb-16" data-id="meganav-mobile-panel-controls">
               {MeganavData.panels.map((panel) => {
                 const PanelComponent = panels[panel.component];
 

package/src/core/MeganavItemsSignedIn/component.html.erb

@@ -1,6 +1,6 @@
 <ul class="hidden md:flex items-center">
   <li class="ui-meganav-item relative">
-    <%= render(AblyUi::Core::MeganavControl.new(aria_controls: "account-panel", theme_name: @theme_name)) do %>
+    <%= render(AblyUi::Core::MeganavControl.new(aria_controls: "account-panel", theme_name: @theme_name, additional_css: "mr-0")) do %>
       <%= account_name %>
     <% end %>
 
@@ -41,6 +41,10 @@
     </div>
   </li>
 
+  <li>
+    <%= render(AblyUi::Core::MeganavSearch.new(url_base: url_base)) %>
+  <li>
+
   <% if account? %>
     <li class="ml-16">
       <%= link_to "Dashboard", @session_data[:account][:links][:dashboard][:href], class: "ui-btn-secondary p-btn-small" %>

package/src/core/MeganavItemsSignedIn/component.jsx

@@ -3,6 +3,7 @@ import T from "prop-types";
 
 import MeganavControl from "../MeganavControl/component.jsx";
 import SignOutLink from "../SignOutLink/component.jsx";
+import MeganavSearch from "../MeganavSearch/component.jsx";
 
 const truncate = (string, length) => {
   return string?.length && string.length > length ? `${string.slice(0, length - 1)}…` : string;
@@ -16,7 +17,7 @@ const MeganavItemsSignedIn = ({ sessionState, theme, absUrl }) => {
   return (
     <ul className="hidden md:flex items-center">
       <li className="ui-meganav-item relative">
-        <MeganavControl ariaControls="account-panel" theme={theme}>
+        <MeganavControl ariaControls="account-panel" theme={theme} additionalCSS="mr-0">
           {accountName}
         </MeganavControl>
 
@@ -70,8 +71,12 @@ const MeganavItemsSignedIn = ({ sessionState, theme, absUrl }) => {
         </div>
       </li>
 
+      <li>
+        <MeganavSearch absUrl={absUrl} />
+      </li>
+
       {sessionState.account && (
-        <li className="ml-16">
+        <li>
           <a href={absUrl(sessionState.account.links.dashboard.href)} className="ui-btn-secondary p-btn-small">
             Dashboard
           </a>

package/src/core/MeganavSearch/component.html.erb

@@ -0,0 +1,15 @@
+<button
+  type="button"
+  data-id="meganav-control"
+  data-control="search"
+  class="h-64 w-24 px-24 pr-48 py-20"
+  aria-expanded="false"
+  aria-controls="panel-search"
+  aria-label="Show Search Panel"
+>
+  <%= render(AblyUi::Core::Icon.new(name: "icon-gui-search", size: "1.5rem", color: "text-cool-black", additional_css: "hover:text-gui-hover")) %>
+</button>
+
+<div class="ui-meganav-panel invisible" id="panel-search" data-id="meganav-panel">
+  <%= render(AblyUi::Core::MeganavSearchPanel.new(url_base: url_base)) %>
+</div>

package/src/core/MeganavSearch/component.jsx

@@ -0,0 +1,33 @@
+import React from "react";
+import T from "prop-types";
+
+import Icon from "../Icon/component.jsx";
+import MeganavSearchPanel from "../MeganavSearchPanel/component.jsx";
+
+const MeganavSearch = ({ absUrl }) => {
+  return (
+    <>
+      <button
+        type="button"
+        data-id="meganav-control"
+        data-control="search"
+        className="h-64 w-24 px-24 pr-48 py-20"
+        aria-expanded="false"
+        aria-controls="panel-search"
+        aria-label={`Show Search Panel`}
+      >
+        <Icon name="icon-gui-search" color="text-cool-black" size="1.5rem" additionalCSS="hover:text-gui-hover" />
+      </button>
+
+      <div className="ui-meganav-panel invisible" id="panel-search" data-id="meganav-panel">
+        <MeganavSearchPanel absUrl={absUrl} />
+      </div>
+    </>
+  );
+};
+
+MeganavSearch.propTypes = {
+  absUrl: T.func,
+};
+
+export default MeganavSearch;

package/src/core/MeganavSearch/component.rb

@@ -0,0 +1,13 @@
+module AblyUi
+  module Core
+    class MeganavSearch < ViewComponent::Base
+      include Util
+
+      attr_reader :url_base
+
+      def initialize(url_base:)
+        @url_base = url_base
+      end
+    end
+  end
+end

package/src/core/MeganavSearchAutocomplete/component.html.erb

@@ -0,0 +1,6 @@
+<div
+  class="absolute w-full mt-8 z-10 hidden shadow-container rounded-lg bg-white border border-mid-grey"
+  data-id="meganav-search-autocomplete-container"
+>
+  <ol class="m-16" data-id="meganav-search-autocomplete-list"></ol>
+</div>

package/src/core/MeganavSearchAutocomplete/component.js

@@ -0,0 +1,169 @@
+import { queryId } from "../dom-query";
+import AddSearchClient from "addsearch-js-client";
+
+const init = ({ input, container, listContainer, clear, client }) => {
+  client.setAnalyticsTag("Meganav autocomplete");
+  client.setThrottleTime(400);
+
+  const clearResults = () => {
+    container.classList.add("hidden");
+    listContainer.innerHTML = "";
+  };
+
+  const toggleClearBtn = (query) => {
+    if ((query || "").length > 0 && clear) {
+      clear.classList.remove("invisible");
+    } else if (clear) {
+      clear.classList.add("invisible");
+    }
+  };
+
+  const markQueryInSuggestion = (suggestion, query) => {
+    return suggestion.value.replace(
+      query.toLowerCase(),
+      `<span class="font-light">${query}</span>`
+    );
+  };
+
+  const navigateToUrl = (q) => (window.location = `/search?q=${q}`);
+
+  const focusNext = (index) => {
+    const nextSuggestion = listContainer.querySelector(
+      `[data-suggestion-index="${index + 1}"]`
+    );
+    if (!nextSuggestion) return;
+    nextSuggestion.focus();
+  };
+
+  const focusPrevious = (index) => {
+    const previousIndex = index - 1;
+
+    const previousSuggestion = listContainer.querySelector(
+      `[data-suggestion-index="${previousIndex}"]`
+    );
+    if (!previousSuggestion) return;
+    previousSuggestion.focus();
+  };
+
+  const renderResults =
+    (query) =>
+    (results = { suggestions: [] }) => {
+      toggleClearBtn(query);
+
+      if (results.suggestions.length === 0) {
+        clearResults();
+        return;
+      }
+
+      const items = results.suggestions.map((suggestion, index) => {
+        const li = document.createElement("li");
+        const button = document.createElement("button");
+
+        button.classList.add(
+          "ui-text-menu2",
+          "font-medium",
+          "p-8",
+          "w-full",
+          "text-left",
+          "rounded",
+          "hover:text-gui-hover",
+          "focus:outline-gui-focus",
+          "hover:bg-light-grey"
+        );
+
+        button.innerHTML = markQueryInSuggestion(suggestion, query);
+
+        button.dataset.suggestionIndex = index;
+
+        button.addEventListener("click", () => {
+          navigateToUrl(suggestion);
+        });
+
+        button.addEventListener("keydown", (e) => {
+          const key = e.key;
+
+          if (key === "ArrowDown") {
+            focusNext();
+          } else if (key === "ArrowUp" && index - 1 < 0) {
+            input.focus();
+          } else if (key === "ArrowUp" && index - 1 >= 0) {
+            focusPrevious();
+          } else if (key === "Enter" || key === "Space") {
+            navigateToUrl(suggestion);
+          }
+        });
+
+        li.appendChild(button);
+        return li;
+      });
+
+      listContainer.innerHTML = "";
+      items.forEach((item) => listContainer.appendChild(item));
+      container.classList.remove("hidden");
+    };
+
+  const keyupHandler = (e) => {
+    const query = e.target.value;
+    const key = e.key;
+
+    if (key === "ArrowDown") {
+      focusNext(0);
+      return;
+    }
+
+    if (!query) {
+      clearResults();
+    } else {
+      client.suggestions(query, renderResults(query));
+    }
+  };
+
+  let clearHandler;
+  if (clear) {
+    clearHandler = () => {
+      input.value = "";
+      clear.classList.add("invisible");
+      clearResults();
+    };
+    clear.addEventListener("click", clearHandler);
+  }
+
+  input.addEventListener("keyup", keyupHandler);
+
+  return {
+    teardown: () => {
+      input.removeEventListener("keyup", keyupHandler);
+      if (clear) clear.removeEventListener("click", clearHandler);
+    },
+    clear: () => {
+      input.value = "";
+      clearResults();
+    },
+  };
+};
+
+export default () => {
+  const apiKey = document.body.dataset.addSearchApiKey;
+  if (!apiKey) {
+    console.log(`No AddSearch API key provided, skipping search suggestions.`);
+    return [];
+  }
+  const client = new AddSearchClient(apiKey);
+
+  return [
+    queryId("meganav-search-input"),
+    queryId("meganav-mobile-search-input"),
+  ]
+    .filter((i) => i)
+    .map((input) => {
+      const parent = input.parentNode;
+      const container = queryId(
+        "meganav-search-autocomplete-container",
+        parent
+      );
+      const listContainer = queryId("meganav-search-autocomplete-list", parent);
+      const clear = queryId("meganav-search-input-clear", parent);
+
+      return init({ input, container, listContainer, client, clear });
+    });
+};

package/src/core/MeganavSearchAutocomplete/component.jsx

@@ -0,0 +1,14 @@
+import React from "react";
+
+const MeganavSearchAutocomplete = () => {
+  return (
+    <div
+      className="absolute w-full mt-8 z-10 hidden shadow-container rounded-lg bg-white border border-mid-grey"
+      data-id="meganav-search-autocomplete-container"
+    >
+      <ol className="m-16" data-id="meganav-search-autocomplete-list"></ol>
+    </div>
+  );
+};
+
+export default MeganavSearchAutocomplete;

package/src/core/MeganavSearchAutocomplete/component.rb

@@ -0,0 +1,6 @@
+module AblyUi
+  module Core
+    class MeganavSearchAutocomplete < ViewComponent::Base
+    end
+  end
+end

package/src/core/MeganavSearchPanel/component.html.erb

@@ -0,0 +1,22 @@
+<section class="ui-meganav-content grid-cols-12">
+  <div class="col-span-8">
+    <div class="mb-32">
+      <form class="flex items-start" action={absUrl("/search")} method="get">
+        <div class="relative w-full">
+          <%= render(AblyUi::Core::Icon.new(name: "icon-gui-search", size: "1.5rem", color: "text-cool-black", additional_css:"absolute top-12 left-16")) %>
+          <input type="search" name="q" class="ui-input pl-48 h-48" placeholder="Search" data-id="meganav-search-input" />
+
+          <%= render(AblyUi::Core::MeganavSearchAutocomplete.new) %>
+        </div>
+
+        <button type="submit" class="ui-btn-secondary ml-8 sm:ml-16 md:ml-24 xl:ml-32">
+          Search
+        </button>
+      </form>
+    </div>
+  </div>
+
+  <div class="col-span-12">
+    <%= render(AblyUi::Core::MeganavSearchSuggestions.new(url_base: url_base)) %>
+  </div>
+</section>