Skip to content

Commit d7bd586

Browse files
BarkingBadBarkingBad
committed
Add browsable versions extension for scaladoc
1 parent d7d4a9f commit d7bd586

File tree

8 files changed

+173
-6
lines changed

8 files changed

+173
-6
lines changed

‎scaladoc-js/src/Globals.scala‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ import scala.scalajs.js.annotation.JSGlobalScope
77
@JSGlobalScope
88
object Globals extends js.Object {
99
val pathToRoot: String = js.native
10+
val versionsDictionaryUrl: String = js.native
1011
}
1112

1213
object StringUtils {
1314
def createCamelCaseTokens(s: String): List[String] =
1415
if s.isEmpty then List.empty
1516
else if s.tail.indexWhere(_.isUpper) == -1 then List(s)
1617
else List(s.take(s.tail.indexWhere(_.isUpper) + 1)) ++ createCamelCaseTokens(s.drop(s.tail.indexWhere(_.isUpper) + 1))
17-
}
18+
}

‎scaladoc-js/src/Main.scala‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ object Main extends App {
44
Searchbar()
55
SocialLinks()
66
CodeSnippets()
7+
DropdownHandler()
78
}

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

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
package dotty.tools.scaladoc
2+
3+
import scala.concurrent.ExecutionContext.Implicits.global
4+
import scala.concurrent.Future
5+
import scala.util.{Success,Failure}
6+
7+
import org.scalajs.dom._
8+
import org.scalajs.dom.ext._
9+
import scala.scalajs.js.annotation.JSExportTopLevel
10+
import org.scalajs.dom.ext.Ajax
11+
import scala.scalajs.js
12+
import scala.scalajs.js.JSON
13+
14+
trait Versions extends js.Object:
15+
def versions: js.Dictionary[String]
16+
17+
class DropdownHandler:
18+
19+
val KEY = "versions-json"
20+
val UNDEFINED_VERSIONS = "undefined_versions"
21+
22+
private def addVersionsList(json: String) =
23+
val ver = JSON.parse(json).asInstanceOf[Versions]
24+
val ddc = document.getElementById("dropdown-content")
25+
for (k, v) <- ver.versions do
26+
var child = document.createElement("a").asInstanceOf[html.Anchor]
27+
child.href = v
28+
child.text = k
29+
ddc.appendChild(child)
30+
31+
private def disableButton() =
32+
val btn = document.getElementById("dropdown-button").asInstanceOf[html.Button]
33+
btn.disabled = true
34+
btn.classList.remove("dropdownbtnactive")
35+
36+
private def getURLContent(url: String): Future[String] = Ajax.get(url).map(_.responseText)
37+
38+
window.localStorage.getItem(KEY) match
39+
case null => // If no key, returns null
40+
Globals.versionsDictionaryUrl match
41+
case null => // global property not defined
42+
// do nothing
43+
case url: String =>
44+
getURLContent(url).onComplete {
45+
case Success(json: String) =>
46+
window.localStorage.setItem(KEY, json)
47+
addVersionsList(json)
48+
case Failure(_) =>
49+
window.localStorage.setItem(KEY, UNDEFINED_VERSIONS)
50+
disableButton()
51+
}
52+
case value => value match
53+
case UNDEFINED_VERSIONS =>
54+
disableButton()
55+
case json =>
56+
addVersionsList(json)
57+
58+
59+
document.onclick = (e: Event) => {
60+
if e.target.asInstanceOf[html.Element].id != "dropdown-button" then
61+
document.getElementById("dropdown-content").classList.remove("show")
62+
}
63+
64+
document.getElementById("version").asInstanceOf[html.Span].onclick = (e: Event) => {
65+
e.stopPropagation
66+
}
67+
68+
69+
@JSExportTopLevel("dropdownHandler")
70+
def dropdownHandler() =
71+
if document.getElementById("dropdown-content").getElementsByTagName("a").size > 0 &&
72+
window.getSelection.toString.length == 0 then
73+
document.getElementById("dropdown-content").classList.toggle("show")
74+
75+
@JSExportTopLevel("filterFunction")
76+
def filterFunction() =
77+
val input = document.getElementById("dropdown-input").asInstanceOf[html.Input]
78+
val filter = input.value.toUpperCase
79+
val div = document.getElementById("dropdown-content")
80+
val a = div.getElementsByTagName("a")
81+
for i <- 0 until a.length do
82+
val txtValue = a(i).innerText
83+
val disp = if txtValue.toUpperCase.indexOf(filter) > -1 then
84+
""
85+
else
86+
"none"
87+
a(i).asInstanceOf[html.Anchor].style.display = disp

‎scaladoc/resources/dotty_res/styles/scalastyle.css‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -861,3 +861,63 @@ footer .socials {
861861
footer {
862862
background-color: white;
863863
}
864+
865+
/* The container <div> - needed to position the dropdown content */
866+
.versions-dropdown {
867+
position: relative;
868+
display: inline-block;
869+
}
870+
871+
/* Dropdown Button */
872+
.dropdownbtn {
873+
background-color: var(--leftbar-bg);
874+
color: white;
875+
padding: 4px 12px;
876+
border: none;
877+
}
878+
879+
/* Dropdown button on hover & focus */
880+
.dropdownbtnactive:hover, .dropdownbtnactive:focus {
881+
background-color: var(--leftbar-hover-bg);
882+
cursor: pointer;
883+
}
884+
885+
/* The search field */
886+
#dropdown-input {
887+
box-sizing: border-box;
888+
background-image: url('searchicon.png');
889+
background-position: 14px 12px;
890+
background-repeat: no-repeat;
891+
font-size: 16px;
892+
padding: 14px 20px 12px 45px;
893+
border: none;
894+
border-bottom: 1px solid #ddd;
895+
}
896+
897+
/* The search field when it gets focus/clicked on */
898+
#dropdown-input:focus {outline: 3px solid #ddd;}
899+
900+
901+
/* Dropdown Content (Hidden by Default) */
902+
.dropdown-content {
903+
display: none;
904+
position: absolute;
905+
background-color: #f6f6f6;
906+
min-width: 230px;
907+
border: 1px solid #ddd;
908+
z-index: 1;
909+
}
910+
911+
/* Links inside the dropdown */
912+
.dropdown-content a {
913+
color: black;
914+
padding: 12px 16px;
915+
text-decoration: none;
916+
display: block;
917+
}
918+
919+
/* Change color of dropdown links on hover */
920+
.dropdown-content a:hover {background-color: #f1f1f1}
921+
922+
/* Show the dropdown menu (use JS to add this class to the .dropdown-content container when the user clicks on the dropdown button) */
923+
.show {display:block;}

‎scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ object Scaladoc:
5151
docCanonicalBaseUrl: String = "",
5252
documentSyntheticTypes: Boolean = false,
5353
snippetCompiler: List[String] = Nil,
54-
snippetCompilerDebug: Boolean = false
54+
snippetCompilerDebug: Boolean = false,
55+
versionsDictionaryUrl: Option[String] = None
5556
)
5657

5758
def run(args: Array[String], rootContext: CompilerContext): Reporter =
@@ -195,7 +196,8 @@ object Scaladoc:
195196
docCanonicalBaseUrl.get,
196197
YdocumentSyntheticTypes.get,
197198
snippetCompiler.get,
198-
snippetCompilerDebug.get
199+
snippetCompilerDebug.get,
200+
versionsDictionaryUrl.nonDefault
199201
)
200202
(Some(docArgs), newContext)
201203
}

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,13 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
9393
"./docs"
9494
)
9595

96+
val versionsDictionaryUrl: Setting[String] = StringSetting(
97+
"-versions-dictionary-url",
98+
"versions dictionary url",
99+
"A URL pointing to json with dictionary version -> documentation location. Useful for libraries that maintain different releases docs",
100+
""
101+
)
102+
96103
val YdocumentSyntheticTypes: Setting[Boolean] =
97104
BooleanSetting("-Ydocument-synthetic-types", "Documents intrinsic types e. g. Any, Nothing. Setting is useful only for stdlib", false)
98105

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,10 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
141141
href := resolveLink(page.link.dri, "favicon.ico")
142142
),
143143
linkResources(page.link.dri, resources).toList,
144-
script(raw(s"""var pathToRoot = "${pathToRoot(page.link.dri)}";"""))
144+
script(raw(s"""var pathToRoot = "${pathToRoot(page.link.dri)}";""")),
145+
ctx.args.versionsDictionaryUrl match
146+
case Some(url) => script(raw(s"""var versionsDictionaryUrl = "$url";"""))
147+
case None => ""
145148
)
146149

147150
private def buildNavigation(pageLink: Link): AppliedTag =
@@ -220,8 +223,13 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
220223
span(
221224
div(cls:="projectName")(args.name)
222225
),
223-
span(
224-
args.projectVersion.map(v => div(cls:="projectVersion")(v)).toList
226+
span(id := "version")(
227+
div(cls := "versions-dropdown")(
228+
div(onclick := "dropdownHandler()", id := "dropdown-button", cls := "dropdownbtn dropdownbtnactive")(args.projectVersion.map(v => div(cls:="projectVersion")(v)).toList),
229+
div(id := "dropdown-content", cls := "dropdown-content")(
230+
input(`type` := "text", placeholder := "Search...", id := "dropdown-input", onkeyup := "filterFunction()"),
231+
),
232+
)
225233
),
226234
div(cls := "socials")(
227235
socialLinks()

‎scaladoc/src/dotty/tools/scaladoc/util/html.scala‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ object HTML:
9999
val value = Attr("value")
100100
val onclick=Attr("onclick")
101101
val titleAttr =Attr("title")
102+
val onkeyup = Attr("onkeyup")
102103

103104
def raw(content: String): AppliedTag = new AppliedTag(content)
104105
def raw(content: StringBuilder): AppliedTag = content

0 commit comments

Comments
 (0)