Change local storage to session storage, fix bugs with undefined js variable

Author: BarkingBad

scaladoc-js/src/versions-dropdown/DropdownHandler.scala

@@ -27,6 +27,9 @@ class DropdownHandler:
       child.href = v
       child.text = k
       ddc.appendChild(child)
+    val arrow = document.createElement("span").asInstanceOf[html.Span]
+    arrow.classList.add("ar")
+    document.getElementById("dropdown-button").appendChild(arrow)
 
   private def disableButton() =
     val btn = document.getElementById("dropdown-button").asInstanceOf[html.Button]
@@ -35,53 +38,57 @@ class DropdownHandler:
 
   private def getURLContent(url: String): Future[String] = Ajax.get(url).map(_.responseText)
 
-  window.localStorage.getItem(KEY) match
+  window.sessionStorage.getItem(KEY) match
     case null => // If no key, returns null
-      Globals.versionsDictionaryUrl match
-        case null => // global property not defined
-          // do nothing
-        case url: String =>
-          getURLContent(url).onComplete {
-            case Success(json: String) =>
-              window.localStorage.setItem(KEY, json)
-              addVersionsList(json)
-            case Failure(_) =>
-              window.localStorage.setItem(KEY, UNDEFINED_VERSIONS)
-              disableButton()
-          }
+      try
+        getURLContent(Globals.versionsDictionaryUrl).onComplete {
+          case Success(json: String) =>
+            window.sessionStorage.setItem(KEY, json)
+            addVersionsList(json)
+          case Failure(_) =>
+            window.sessionStorage.setItem(KEY, UNDEFINED_VERSIONS)
+            disableButton()
+        }
+      catch // Globals.versionDictionaruUrl is undefined
+        case e =>
+          window.sessionStorage.setItem(KEY, UNDEFINED_VERSIONS)
+          disableButton()
     case value => value match
       case UNDEFINED_VERSIONS =>
         disableButton()
       case json =>
         addVersionsList(json)
 
-
-  document.onclick = (e: Event) => {
+  document.addEventListener("click", (e: Event) => {
     if e.target.asInstanceOf[html.Element].id != "dropdown-button" then
       document.getElementById("dropdown-content").classList.remove("show")
-  }
+      document.getElementById("dropdown-button").classList.remove("expanded")
+  })
 
   document.getElementById("version").asInstanceOf[html.Span].onclick = (e: Event) => {
     e.stopPropagation
   }
-
+end DropdownHandler
 
 @JSExportTopLevel("dropdownHandler")
 def dropdownHandler() =
   if document.getElementById("dropdown-content").getElementsByTagName("a").size > 0 &&
      window.getSelection.toString.length == 0 then
     document.getElementById("dropdown-content").classList.toggle("show")
+    document.getElementById("dropdown-button").classList.toggle("expanded")
 
 @JSExportTopLevel("filterFunction")
 def filterFunction() =
   val input = document.getElementById("dropdown-input").asInstanceOf[html.Input]
   val filter = input.value.toUpperCase
   val div = document.getElementById("dropdown-content")
-  val a = div.getElementsByTagName("a")
-  for i <- 0 until a.length do
-    val txtValue = a(i).innerText
-    val disp = if txtValue.toUpperCase.indexOf(filter) > -1 then
-      ""
+  val as = div.getElementsByTagName("a")
+
+  as.foreach { a =>
+    val txtValue = a.innerText
+    val cl = a.asInstanceOf[html.Anchor].classList
+    if txtValue.toUpperCase.indexOf(filter) > -1 then
+      cl.remove("filtered")
     else
-      "none"
-    a(i).asInstanceOf[html.Anchor].style.display = disp
+      cl.add("filtered")
+  }

scaladoc/resources/dotty_res/styles/scalastyle.css

@@ -199,6 +199,9 @@ th {
 #logo .projectVersion {
   color: var(--leftbar-fg);
   font-size: 12px;
+  display: flex;
+  padding-left: calc(0.05 * var(--side-width));
+  padding-right: calc(0.08 * var(--side-width));
 }
 
 .scaladoc_logo {
@@ -277,7 +280,7 @@ th {
 }
 
 /* spans represent a expand button */
-#sideMenu2 span.ar {
+span.ar {
   align-items: center;
   cursor: pointer;
   position: absolute;
@@ -286,7 +289,7 @@ th {
   padding: 4px;
 }
 
-#sideMenu2 span.ar::before {
+span.ar::before {
   content: "\e903"; /* arrow down */
   font-family: "dotty-icons" !important;
   font-size: 20px;
@@ -297,11 +300,11 @@ th {
   align-items: center;
   justify-content: center;
 }
-#sideMenu2 .expanded>span.ar::before {
+.expanded>span.ar::before {
   content: "\e905"; /* arrow up */
 }
 
-#sideMenu2 .div:hover>span.ar::before {
+.div:hover>span.ar::before {
   color: var(--leftbar-current-bg);
 }
 
@@ -865,7 +868,6 @@ footer {
 /* The container <div> - needed to position the dropdown content */
 .versions-dropdown {
   position: relative;
-  display: inline-block;
 }
 
  /* Dropdown Button */
@@ -920,4 +922,11 @@ footer {
 .dropdown-content a:hover {background-color: #f1f1f1}
 
 /* Show the dropdown menu (use JS to add this class to the .dropdown-content container when the user clicks on the dropdown button) */
-.show {display:block;}
+.show {
+  display:block;
+}
+
+/* Filtered entries in dropdown menu */
+.dropdown-content a.filtered {
+  display: none;
+}

scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala

@@ -96,7 +96,7 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
   val versionsDictionaryUrl: Setting[String] = StringSetting(
     "-versions-dictionary-url",
     "versions dictionary url",
-    "A URL pointing to json with dictionary version -> documentation location. Useful for libraries that maintain different releases docs",
+    "A URL pointing to a JSON document containing a dictionary version -> documentation location. Useful for libraries that maintain different releases docs",
     ""
   )
 

scaladoc/src/dotty/tools/scaladoc/SourceLinks.scala

@@ -125,7 +125,7 @@ object SourceLinks:
       | €{FILE_PATH}, and €{FILE_LINE} patterns
       |
       |
-      |Template can defined only by subset of sources defined by path prefix represented by `<sub-path>`.
+      |Template can be defined only by subset of sources defined by path prefix represented by `<sub-path>`.
       |In such case paths used in templates will be relativized against `<sub-path>`""".stripMargin
 
   def load(config: Seq[String], revision: Option[String], projectRoot: Path = Paths.get("").toAbsolutePath)(using CompilerContext): SourceLinks =

scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala

@@ -223,9 +223,11 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
           span(
             div(cls:="projectName")(args.name)
           ),
-          span(id := "version")(
+          div(id := "version")(
             div(cls := "versions-dropdown")(
-              div(onclick := "dropdownHandler()", id := "dropdown-button", cls := "dropdownbtn dropdownbtnactive")(args.projectVersion.map(v => div(cls:="projectVersion")(v)).toList),
+              div(onclick := "dropdownHandler()", id := "dropdown-button", cls := "dropdownbtn dropdownbtnactive")(
+                args.projectVersion.map(v => div(cls:="projectVersion")(v)).getOrElse("")
+              ),
               div(id := "dropdown-content", cls := "dropdown-content")(
                 input(`type` := "text", placeholder := "Search...", id := "dropdown-input", onkeyup := "filterFunction()"),
               ),