@qld-gov-au/qgds-bootstrap5 2.0.11 → 2.0.12

package/src/components/bs5/searchInput/__snapshots__/searchInput.test.js.snap

@@ -1,4 +1,4 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html  
 
 exports[`SearchInput > Renders as expected 1`] = `
 "<!-- 
@@ -11,35 +11,31 @@ exports[`SearchInput > Renders as expected 1`] = `
         <span class="btn-icon"></span>
         <span class="btn-label">Search</span>
     </button>
-    <div class="suggestions suggestions__group d-none">
-        <div class="default-suggestions">
-            <div class="suggestions-category mt-16">
-                <strong class="suggestions-category-label d-block">Popular services</strong>
-                <ul class="mt-2">
-                    <li><a href="https://www.forgov.qld.gov.au/pay-benefits-and-policy/leave/submit-a-leave-application">Apply for leave</a></li>
-                    <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/starting-a-new-job/apply-for-higher-duties-or-relieving-at-level">Apply for higher duties or relieving at level</a></li>
-                    <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/recruitment/extending-my-job/extend-a-temporary-or-casual-employee">Extend a temporary or casual employee</a></li>
-                    <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/recruitment">Hire a staff member (recruitment)</a></li>
-                </ul>
-            </div>
-
-            <div class="suggestions-category mt-16">
-                <strong class="suggestions-category-label d-block">Browse by category</strong>
-                <ul class="mt-12 mb-0">
-                    <li><a href="https://www.forgov.qld.gov.au/pay-benefits-and-policy/directives-policies-circulars-and-guidelines">Search for directives, policies, circulars, and guidelines</a></li>
-                    <li><a href="https://www.forgov.qld.gov.au/pay-benefits-and-policy/benefits/employee-pay-and-benefits">Employee pay and benefits</a></li>
-                    <li><a href="https://www.forgov.qld.gov.au/sandbox/archive/queensland-shared-services">Queensland Shared Services</a></li>
-                    <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/career-development">Career development</a></li>
-                </ul>
-            </div>
+    <div class="suggestions suggestions__group d-none default">
+            <div class="default-suggestions">
+                <div class="suggestions-category">
+                    <strong class="suggestions-category-label d-block">Popular</strong>
+                    <ul>
+                        <li><a href="https://www.forgov.qld.gov.au/pay-benefits-and-policy/leave/submit-a-leave-application">Apply for leave now</a></li>
+                        <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/starting-a-new-job/apply-for-higher-duties-or-relieving-at-level">Apply for higher duties or relieving at level</a></li>
+                        <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/recruitment/extending-my-job/extend-a-temporary-or-casual-employee">Extend a temporary or casual employee</a></li>
+                        <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/recruitment">Hire a staff member (recruitment)</a></li>
+                            <li><a href="/queenslanders" class="view-more">View more</a></li>
+                    </ul>
+                </div>
 
-            <div class="suggestions-category">
-                <a class="px-16 pt-12 pb-16 d-block suggestions-category-view-more"
-                    href="/queenslanders">Browse all categories</a>
+                <div class="suggestions-category">
+                    <strong class="suggestions-category-label d-block">Collection</strong>
+                    <ul>
+                        <li><a href="https://www.forgov.qld.gov.au/pay-benefits-and-policy/directives-policies-circulars-and-guidelines">Search for directives, policies, circulars, and guidelines</a></li>
+                        <li><a href="https://www.forgov.qld.gov.au/pay-benefits-and-policy/benefits/employee-pay-and-benefits">Employee pay and benefits</a></li>
+                        <li><a href="https://www.forgov.qld.gov.au/sandbox/archive/queensland-shared-services">Queensland Shared Services</a></li>
+                        <li><a href="https://www.forgov.qld.gov.au/recruitment-performance-and-career/career-development">Career development</a></li>
+                            <li><a href="/queenslanders" class="view-more">View all</a></li>
+                    </ul>
+                </div>
             </div>
-        </div>
-        <div class="dynamic-suggestions"></div>
+            <div class="dynamic-suggestions" data-view-more="/queenslanders"></div>
     </div>
-    
 </div>"
 `;

package/src/components/bs5/searchInput/search.functions.js

@@ -34,7 +34,7 @@ export function selectSuggestion(value, form) {
 
   if (searchInput && suggestions) {
     searchInput.value = value.trim();
-    suggestions.classList.add("d-none");
+    // suggestions.classList.add("d-none");
 
     // Retrieve additional params
     const collection =
@@ -87,9 +87,13 @@ export async function showSuggestions(value = "", isDefault = false, form) {
 
   // Hide/show default suggestions
   if (isDefault) {
-    defaultSuggestionsContainer.classList.remove("d-none");
-    dynamicSuggestionsContainer.innerHTML = "";
-    dynamicSuggestionsContainer.classList.add("d-none");
+    if (defaultSuggestionsContainer) {
+      defaultSuggestionsContainer.classList.remove("d-none");
+    }
+    if (dynamicSuggestionsContainer) {
+      dynamicSuggestionsContainer.innerHTML = "";
+      dynamicSuggestionsContainer.classList.add("d-none");
+    }
     createPopper(searchInput, suggestions, {
       placement: "bottom-start",
     });
@@ -97,30 +101,34 @@ export async function showSuggestions(value = "", isDefault = false, form) {
     return;
   }
 
-  if (value.length === 0) {
-    dynamicSuggestionsContainer.innerHTML = "";
-    dynamicSuggestionsContainer.classList.add("d-none");
-    return;
+  if (dynamicSuggestionsContainer) {
+    if (value.length === 0) {
+      dynamicSuggestionsContainer.innerHTML = "";
+      dynamicSuggestionsContainer.classList.add("d-none");
+      return;
+    }
   }
 
-  defaultSuggestionsContainer.classList.add("d-none");
+  if (defaultSuggestionsContainer) {
+    defaultSuggestionsContainer.classList.add("d-none");
+  }
 
   // Fetch dynamic suggestions if available
-  const suggestUrl = searchInput.getAttribute("data-suggestions");
-  if (suggestUrl) {
-    const collection =
-      searchInput.getAttribute("data-collection") || "qgov~sp-search";
-    const profile = searchInput.getAttribute("data-profile") || "qld";
-    const fetchedSuggestions = await fetchData(
-      `${suggestUrl}?collection=${collection}&profile=${profile}&fmt=json&alpha=0.5&partial_query=${encodeURIComponent(value)}`,
-      "suggestions",
-    );
-
-    if (fetchedSuggestions.length > 0) {
-      dynamicSuggestionsContainer.innerHTML = `
-        <div class="suggestions-category mt-16">
-          <strong class="suggestions-category-label d-block">Suggestions</strong>
-          <ul class="mt-2">${fetchedSuggestions
+  if (dynamicSuggestionsContainer) {
+    const suggestUrl = searchInput.getAttribute("data-suggestions");
+    if (suggestUrl) {
+      const collection =
+        searchInput.getAttribute("data-collection") || "qgov~sp-search";
+      const profile = searchInput.getAttribute("data-profile") || "qld";
+      const fetchedSuggestions = await fetchData(
+        `${suggestUrl}?collection=${collection}&profile=${profile}&fmt=json&alpha=0.5&partial_query=${encodeURIComponent(value)}`,
+        "suggestions",
+      );
+
+      if (fetchedSuggestions.length > 0) {
+        dynamicSuggestionsContainer.innerHTML = `
+        <div class="suggestions-category">
+          <ul>${fetchedSuggestions
             .slice(0, 4)
             .map((item) => {
               const highlightedText = item.replace(
@@ -131,61 +139,70 @@ export async function showSuggestions(value = "", isDefault = false, form) {
             })
             .join("")}</ul>
         </div>`;
-      dynamicSuggestionsContainer.classList.remove("d-none");
-      createPopper(searchInput, suggestions, {
-        placement: "bottom-start",
-      });
-      suggestions.classList.remove("d-none");
-
-      // Attach click event listeners to each suggestion item
-      form.querySelectorAll(".suggestions li").forEach((item) => {
-        item.addEventListener("click", () =>
-          selectSuggestion(item.innerText, form),
-        );
-      });
-    } else {
-      dynamicSuggestionsContainer.innerHTML = "";
-      dynamicSuggestionsContainer.classList.add("d-none");
-      suggestions.classList.add("d-none");
+        dynamicSuggestionsContainer.classList.remove("d-none");
+        createPopper(searchInput, suggestions, {
+          placement: "bottom-start",
+        });
+        suggestions.classList.remove("d-none");
+
+        // Attach click event listeners to each suggestion item
+        form.querySelectorAll(".suggestions li").forEach((item) => {
+          item.addEventListener("click", () =>
+            selectSuggestion(item.innerText, form),
+          );
+        });
+      } else {
+        dynamicSuggestionsContainer.innerHTML = "";
+        dynamicSuggestionsContainer.classList.add("d-none");
+        suggestions.classList.add("d-none");
+      }
     }
-  }
 
-  const resultsUrl = searchInput.getAttribute("data-results-url");
-  if (resultsUrl) {
-    const collection =
-      searchInput.getAttribute("data-collection") || "qgov~sp-search";
-    const profile = searchInput.getAttribute("data-profile") || "qld";
-    const fetchedServices = await fetchData(
-      `${resultsUrl}?collection=${collection}&profile=${profile}&smeta_sfinder_sand=yes&query=${encodeURIComponent(value)}`,
-      "services",
-    );
-
-    if (
-      fetchedServices.response.resultPacket &&
-      fetchedServices.response.resultPacket.results.length > 0
-    ) {
-      dynamicSuggestionsContainer.innerHTML += `
-        <div class="suggestions-category feature pt-16">
-          <strong class="suggestions-category-label d-block">Services</strong>
-          <ul class="mt-2">${fetchedServices.response.resultPacket.results
-            .slice(0, 4)
-            .map(
-              (item) => `<li><a href="${item.liveUrl}">${item.title}</a></li>`,
-            )
-            .join("")}</ul>
+    const resultsUrl = searchInput.getAttribute("data-results-url");
+    if (resultsUrl) {
+      const collection =
+        searchInput.getAttribute("data-collection") || "qgov~sp-search";
+      const profile = searchInput.getAttribute("data-profile") || "qld";
+      const fetchedServices = await fetchData(
+        `${resultsUrl}?collection=${collection}&profile=${profile}&smeta_sfinder_sand=yes&query=${encodeURIComponent(value)}`,
+        "services",
+      );
+
+      if (
+        fetchedServices.response.resultPacket &&
+        fetchedServices.response.resultPacket.results.length > 0
+      ) {
+        const viewMoreUrl =
+          dynamicSuggestionsContainer.getAttribute("data-view-more");
+
+        // Build the services HTML safely
+        const servicesItems = fetchedServices.response.resultPacket.results
+          .slice(0, 4)
+          .map((item) => `<li><a href="${item.liveUrl}">${item.title}</a></li>`)
+          .join("");
+
+        const viewMoreItem = viewMoreUrl
+          ? `<li><a href="${viewMoreUrl}" class="view-more">View more</a></li>`
+          : "";
+
+        dynamicSuggestionsContainer.innerHTML += `
+        <div class="suggestions-category feature">
+          <strong class="suggestions-category-label d-block">Related services</strong>
+          <ul>${servicesItems}${viewMoreItem}</ul>
         </div>`;
-      dynamicSuggestionsContainer.classList.remove("d-none");
-      createPopper(searchInput, suggestions, {
-        placement: "bottom-start",
-      });
-      suggestions.classList.remove("d-none");
-
-      // Attach click event listeners to each suggestion item
-      form.querySelectorAll(".suggestions li").forEach((item) => {
-        item.addEventListener("click", () =>
-          selectSuggestion(item.innerText, form),
-        );
-      });
+        dynamicSuggestionsContainer.classList.remove("d-none");
+        createPopper(searchInput, suggestions, {
+          placement: "bottom-start",
+        });
+        suggestions.classList.remove("d-none");
+
+        // Attach click event listeners to each suggestion item
+        form.querySelectorAll(".suggestions li").forEach((item) => {
+          item.addEventListener("click", () =>
+            selectSuggestion(item.innerText, form),
+          );
+        });
+      }
     }
   }
 }

package/src/components/bs5/searchInput/searchInput.data.json

@@ -6,7 +6,6 @@
   "buttonType": "submit",
   "buttonLabel": "Search",
   "ariaLabel": "Search website",
-  "suggestions": true,
   "tags": {
     "collection": "qgov~sp-search",
     "profile": "qld",
@@ -15,10 +14,20 @@
     "suggestions": "https://discover.search.qld.gov.au/s/suggest.json",
     "results-url": "https://discover.search.qld.gov.au/s/search.json"
   },
-  "default_suggestions": {
-    "popular_services": [
+  "hasDynamicSuggestions": true,
+  "hasDefaultSuggestions": true,
+  "dynamicSuggestionsServiceLink": {
+    "href": "/queenslanders"
+  },
+  "defaultSuggestions": {
+    "popularServicesTitle": "Popular",
+    "popularServicesLink": {
+      "label": "View more",
+      "href": "/queenslanders"
+    },
+    "popularServices": [
       {
-        "title": "Apply for leave",
+        "title": "Apply for leave now",
         "link": "https://www.forgov.qld.gov.au/pay-benefits-and-policy/leave/submit-a-leave-application"
       },
       {
@@ -34,6 +43,11 @@
         "link": "https://www.forgov.qld.gov.au/recruitment-performance-and-career/recruitment"
       }
     ],
+    "categoriesTitle": "Collection",
+    "categoriesLink": {
+      "label": "View all",
+      "href": "/queenslanders"
+    },
     "categories": [
       {
         "title": "Search for directives, policies, circulars, and guidelines",
@@ -51,11 +65,6 @@
         "title": "Career development",
         "link": "https://www.forgov.qld.gov.au/recruitment-performance-and-career/career-development"
       }
-    ],
-    "options": {
-      "label": "Browse all categories",
-      "view_more": true,
-      "href": "/queenslanders"
-    }
+    ]
   }
 }

package/src/components/bs5/searchInput/searchInput.hbs

@@ -8,36 +8,38 @@
         <span class="btn-icon"></span>
         <span class="btn-label">{{ buttonLabel }}</span>
     </button>
-    {{#if suggestions}}
-    <div class="suggestions suggestions__group d-none">
-        <div class="default-suggestions">
-            <div class="suggestions-category mt-16">
-                <strong class="suggestions-category-label d-block">Popular services</strong>
-                <ul class="mt-2">
-                    {{#each default_suggestions.popular_services}}
-                    <li><a href="{{link}}">{{title}}</a></li>
-                    {{/each}}
-                </ul>
-            </div>
-
-            <div class="suggestions-category mt-16">
-                <strong class="suggestions-category-label d-block">Browse by category</strong>
-                <ul class="mt-12 mb-0">
-                    {{#each default_suggestions.categories}}
-                    <li><a href="{{link}}">{{title}}</a></li>
-                    {{/each}}
-                </ul>
-            </div>
+    {{#ifCond hasDynamicSuggestions '||' hasDefaultSuggestions}}
+    <div class="suggestions suggestions__group d-none default">
+        {{#if hasDefaultSuggestions}}
+            <div class="default-suggestions">
+                <div class="suggestions-category">
+                    <strong class="suggestions-category-label d-block">{{defaultSuggestions.popularServicesTitle}}</strong>
+                    <ul>
+                        {{#each defaultSuggestions.popularServices}}
+                        <li><a href="{{link}}">{{title}}</a></li>
+                        {{/each}}
+                        {{#if defaultSuggestions.popularServicesLink}}
+                            <li><a href="{{defaultSuggestions.popularServicesLink.href}}" class="view-more">{{#if defaultSuggestions.popularServicesLink.label}}{{defaultSuggestions.popularServicesLink.label}}{{else}}View More{{/if}}</a></li>
+                        {{/if}}
+                    </ul>
+                </div>
 
-            {{#if default_suggestions.options.view_more}}
-            <div class="suggestions-category">
-                <a class="px-16 pt-12 pb-16 d-block suggestions-category-view-more"
-                    href="{{default_suggestions.options.href}}">{{default_suggestions.options.label}}</a>
+                <div class="suggestions-category">
+                    <strong class="suggestions-category-label d-block">{{defaultSuggestions.categoriesTitle}}</strong>
+                    <ul>
+                        {{#each defaultSuggestions.categories}}
+                        <li><a href="{{link}}">{{title}}</a></li>
+                        {{/each}}
+                        {{#if defaultSuggestions.categoriesLink}}
+                            <li><a href="{{defaultSuggestions.categoriesLink.href}}" class="view-more">{{#if defaultSuggestions.categoriesLink.label}}{{defaultSuggestions.categoriesLink.label}}{{else}}View More{{/if}}</a></li>
+                        {{/if}}
+                    </ul>
+                </div>
             </div>
-            {{/if}}
-        </div>
-        <div class="dynamic-suggestions"></div>
+        {{/if}}
+        {{#if hasDynamicSuggestions}}
+            <div class="dynamic-suggestions" {{#if dynamicSuggestionsServiceLink.href}}data-view-more="{{dynamicSuggestionsServiceLink.href}}"{{/if}}></div>
+        {{/if}}
     </div>
-    {{/if}}
-    
+    {{/ifCond}}    
 </div>