Switch dropdown component to choices.js (#176)

Solves #134 <img width="1277" alt="Screenshot 2024-02-10 at 2 56 57 PM" src="https://github.com/ParkingReformNetwork/parking-lot-map/assets/101603561/1fa4c2c9-74e3-42c8-8c2f-c1610beb3946"> <img width="531" alt="Screenshot 2024-02-10 at 2 57 49 PM" src="https://github.com/ParkingReformNetwork/parking-lot-map/assets/101603561/51e4418d-3841-4eda-afe7-6ee1c47beefa"> <img width="531" alt="Screenshot 2024-02-10 at 2 57 56 PM" src="https://github.com/ParkingReformNetwork/parking-lot-map/assets/101603561/c9aef449-50d9-4ebc-b22d-9066973e282f"> <img width="531" alt="Screenshot 2024-02-10 at 2 58 04 PM" src="https://github.com/ParkingReformNetwork/parking-lot-map/assets/101603561/a4f43822-8501-4205-b7fd-010346bd1b10"> <img width="531" alt="Screenshot 2024-02-10 at 2 58 12 PM" src="https://github.com/ParkingReformNetwork/parking-lot-map/assets/101603561/889927c8-1aa0-44a5-8ad4-ad8d2bbaed88">
ParkingReformNetwork · Feb 12, 2024 · fed1448 · fed1448
1 parent f16f448
commit fed1448
Show file tree

Hide file tree

Showing 7 changed files with 131 additions and 41 deletions.
diff --git a/index.html b/index.html
@@ -76,7 +76,12 @@
         <span class="site-title">Parking Lot Map</span>
         <fieldset id="city-dropdown">
           <label for="city-choice">Select a city: </label>
-          <select name="city-choice" id="city-choice"></select>
+          <select
+            single
+            name="city-choice"
+            class="city-choice"
+            id="city-choice"
+          ></select>
         </fieldset>
       </div>
       <div class="header-icons">

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "@fortawesome/fontawesome-svg-core": "^6.4.0",
     "@fortawesome/free-solid-svg-icons": "^6.4.0",
     "@parcel/resolver-glob": "^2.10.3",
+    "choices.js": "^10.2.0",
     "leaflet": "~1.9.3"
   },
   "devDependencies": {

diff --git a/src/css/_header.scss b/src/css/_header.scss
@@ -21,6 +21,8 @@ header {
   .header-about-icon {
     margin-right: 0.75em;
   }
+
+  margin-left: auto;
 }
 
 @media only screen and (min-width: 48em) {
@@ -39,14 +41,38 @@ header {
   .site-title {
     flex: 1;
   }
+
+  #city-dropdown {
+    display: flex;
+    align-items: center;
+    gap: 0.7em;
+    height: 40px;
+    margin-bottom: 6px;
+  }
 }
 
 #city-dropdown label {
   font-weight: normal;
 }
 
-#city-choice {
+.choices__inner {
   border: 2px solid rgba(0, 0, 0, 0.2);
   border-radius: 10px;
   color: black;
+  height: 40px;
+
+  @media only screen and (min-width: 20em) {
+    min-width: 20em;
+  }
+}
+
+.choices__item--selectable {
+  font-size: 14px;
+  height: 40px;
+}
+
+.choices__list--dropdown,
+.choices__list[aria-expanded] {
+  z-index: 1001;
+  color: black;
 }
diff --git a/src/js/dropdown.js b/src/js/dropdown.js
@@ -0,0 +1,24 @@
+import Choices from "choices.js";
+import "choices.js/public/assets/styles/choices.css";
+import scoreCardsData from "../../data/score-cards.json";
+
+export const DROPDOWN = new Choices("#city-choice", {
+  allowHTML: false,
+  itemSelectText: "Select",
+  searchEnabled: true,
+});
+
+const setUpDropdown = (initialCityId, fallBackCityId) => {
+  const cities = Object.entries(scoreCardsData).map(([id, { Name }]) => ({
+    value: id,
+    label: Name,
+  }));
+  DROPDOWN.setChoices(cities);
+  if (Object.keys(scoreCardsData).includes(initialCityId)) {
+    DROPDOWN.setChoiceByValue(initialCityId);
+  } else {
+    DROPDOWN.setChoiceByValue(fallBackCityId);
+  }
+};
+
+export default setUpDropdown;
diff --git a/src/js/setUpSite.js b/src/js/setUpSite.js
@@ -7,6 +7,7 @@ import setUpIcons from "./fontAwesome";
 import scoreCardsData from "../../data/score-cards.json";
 import setUpAbout from "./about";
 import setUpShareUrlClickListener from "./share";
+import setUpDropdown, { DROPDOWN } from "./dropdown";
 
 const parkingLots = import("../../data/parking-lots/*"); // eslint-disable-line
 
@@ -48,21 +49,6 @@ const STYLES = {
   },
 };
 
-const addCitiesToToggle = (initialCityId, fallbackCityId) => {
-  const cityToggleElement = document.getElementById("city-choice");
-  let validInitialId = false;
-  Object.entries(scoreCardsData).forEach(([id, { Name }]) => {
-    if (id === initialCityId) {
-      validInitialId = true;
-    }
-    const option = document.createElement("option");
-    option.value = id;
-    option.textContent = Name;
-    cityToggleElement.appendChild(option);
-  });
-  cityToggleElement.value = validInitialId ? initialCityId : fallbackCityId;
-};
-
 /**
  * Create the initial map object.
  *
@@ -198,7 +184,7 @@ const setUpAutoScorecard = async (map, cities, parkingLayer) => {
       }
     });
     if (centralCity) {
-      document.getElementById("city-choice").value = centralCity;
+      DROPDOWN.setChoiceByValue(centralCity);
       setScorecard(centralCity, cities[centralCity]);
     }
   });
@@ -280,7 +266,7 @@ const setUpSite = async () => {
   setUpIcons();
 
   const initialCityId = extractCityIdFromUrl(window.location.href);
-  addCitiesToToggle(initialCityId, "atlanta-ga");
+  setUpDropdown(initialCityId, "atlanta-ga");
   setUpAbout();
 
   const map = createMap();

diff --git a/tests/app/setUpSite.test.js b/tests/app/setUpSite.test.js
@@ -19,18 +19,14 @@ test("every city is in the toggle", async ({ page }) => {
   const data = JSON.parse(rawData);
   const expectedCities = Object.values(data).map((scoreCard) => scoreCard.Name);
 
-  await page.goto("");
-
-  // Wait a second to make sure the site is fully loaded.
-  await page.waitForTimeout(1000);
+  await page.goto("/");
+  await page.waitForSelector(".choices");
 
-  const toggleValues = await page.evaluate(() => {
-    const select = document.querySelector("#city-choice");
-    return Array.from(select.querySelectorAll("option")).map((opt) =>
-      opt.textContent.trim()
-    );
-  });
+  const toggleValues = await page.$$eval(".choices__item--choice", (elements) =>
+    Array.from(elements.map((opt) => opt.textContent.trim()))
+  );
 
+  toggleValues.sort();
   expectedCities.sort();
   expect(toggleValues).toEqual(expectedCities);
 });
@@ -47,11 +43,12 @@ test("correctly load the city score card", async ({ page }) => {
     route.continue();
   });
 
-  await page.goto("");
+  await page.goto("/");
   expect(albanyLoaded).toBe(false);
+  await page.waitForSelector(".choices");
 
-  const selectElement = await page.$("#city-choice");
-  await selectElement.selectOption("albany-ny");
+  await page.click(".choices");
+  await page.click('.choices__item--choice >> text="Albany, NY"');
   await page.waitForFunction(() => {
     const titleElement = document.querySelector(
       ".leaflet-popup-content .title"
@@ -93,10 +90,8 @@ test.describe("the share feature", () => {
     const context = await browser.newContext();
     await context.grantPermissions(["clipboard-read", "clipboard-write"]);
     const page = await context.newPage();
-    await page.goto("");
-
-    // Wait a second to make sure the site is fully loaded.
-    await page.waitForTimeout(1000);
+    await page.goto("/");
+    await page.waitForSelector(".url-copy-button > a");
 
     await page.click(".url-copy-button > a");
     const firstCityClipboardText = await page.evaluate(() =>
@@ -106,8 +101,9 @@ test.describe("the share feature", () => {
 
     // Check that the share button works when changing the city, too.
     // This is a regression test.
-    const selectElement = await page.$("#city-choice");
-    await selectElement.selectOption("anchorage-ak");
+    await page.waitForSelector(".choices");
+    await page.click(".choices");
+    await page.click('.choices__item--choice >> text="Anchorage, AK"');
     await page.waitForFunction(() => {
       const titleElement = document.querySelector(
         ".leaflet-popup-content .title"
@@ -129,7 +125,7 @@ test.describe("the share feature", () => {
     await page.goto("#parking-reform-map=fort-worth-tx");
 
     // Wait a second to make sure the site is fully loaded.
-    await page.waitForTimeout(1000);
+    await page.waitForSelector(".leaflet-popup-content .title");
 
     const [scoreCardTitle, cityToggleValue] = await page.evaluate(() => {
       const title = document.querySelector(
@@ -234,8 +230,7 @@ test.describe("auto-focus city", () => {
 test("scorecard pulls up city closest to center", async ({ page }) => {
   await page.goto("");
 
-  // Wait a second to make sure the site is fully loaded.
-  await page.waitForTimeout(1000);
+  await page.waitForSelector(".leaflet-control-zoom-out");
 
   // Zoom out.
   await page
@@ -244,6 +239,8 @@ test("scorecard pulls up city closest to center", async ({ page }) => {
 
   // Drag map to Birmingham
   await dragMap(page, 300);
+
+  await page.waitForSelector(".choices");
   const [scoreCardTitle, cityToggleValue] = await page.evaluate(() => {
     const title = document.querySelector(
       ".leaflet-popup-content .title"