PoC

Author: pikinier20

build.sbt

@@ -22,6 +22,7 @@ val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
 val `tasty-core-scala2` = Build.`tasty-core-scala2`
 val scala3doc = Build.scala3doc
 val `scala3doc-testcases` = Build.`scala3doc-testcases`
+val `scala3doc-js` = Build.`scala3doc-js`
 val `scala3-bench-run` = Build.`scala3-bench-run`
 val dist = Build.dist
 val `community-build` = Build.`community-build`

project/Build.scala

@@ -28,6 +28,8 @@ import sbtbuildinfo.BuildInfoPlugin.autoImport._
 
 import scala.util.Properties.isJavaAtLeast
 
+import org.portablescala.sbtplatformdeps.PlatformDepsPlugin.autoImport._
+
 object MyScalaJSPlugin extends AutoPlugin {
   import Build._
 
@@ -1228,6 +1230,8 @@ object Build {
   lazy val `scala3doc` = project.in(file("scala3doc")).asScala3doc
   lazy val `scala3doc-testcases` = project.in(file("scala3doc-testcases")).asScala3docTestcases
 
+  lazy val `scala3doc-js` = project.in(file("scala3doc-js")).asScala3docJs
+
   // sbt plugin to use Dotty in your own build, see
   // https://github.com/lampepfl/scala3-example-project for usage.
   lazy val `sbt-dotty` = project.in(file("sbt-dotty")).
@@ -1643,6 +1647,17 @@ object Build {
     def asScala3docTestcases: Project =
       project.dependsOn(`scala3-compiler-bootstrapped`).settings(commonBootstrappedSettings)
 
+    def asScala3docJs: Project =
+      project.
+        enablePlugins(MyScalaJSPlugin).
+        dependsOn(`scala3-library-bootstrappedJS`).
+        settings(
+          fork in Test := false,
+          scalaJSUseMainModuleInitializer := true,
+          libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").withDottyCompat(scalaVersion.value)
+        )
+
+
     def asDist(implicit mode: Mode): Project = project.
       enablePlugins(PackPlugin).
       withCommonSettings.

scala3doc-js/resources/scala3doc-searchbar.css

@@ -0,0 +1,84 @@
+:root {
+    --inkuire-logo-size: 20px;
+}
+
+#scala3doc-search {
+    margin-top: 2px;
+    cursor: pointer;
+    position: fixed;
+    top: 0;
+    right: 20px;
+    z-index: 5;
+}
+
+#scala3doc-search::before {
+    content: "";
+    display:block;
+    height: var(--inkuire-logo-size);
+    width: var(--inkuire-logo-size);
+}
+
+#scala3doc-searchbar.hidden {
+    display: none;
+}
+
+#scala3doc-searchbar {
+    position: absolute;
+    top: 50px;
+    right: 40px;
+    width: calc(100% - 360px);
+    box-shadow: 0 2px 16px 0 rgba(0, 42, 76, 0.15);
+    font-size: 13px;
+    font-family: system-ui, -apple-system, Segoe UI, Roboto, Noto Sans, Ubuntu, Cantarell, Helvetica Neue, Arial, sans-serif;
+}
+
+#scala3doc-searchbar-input {
+    width: 100%;
+    min-height: 32px;
+    border: none;
+    border-bottom: 1px solid #bbb;
+    padding: 10px;
+}
+
+#scala3doc-searchbar-input:focus {
+    outline: none;
+}
+
+#scala3doc-searchbar-results {
+    background: white;
+    display: flex;
+    flex-direction: column;
+    max-height: 500px;
+    overflow: auto;
+}
+
+.scala3doc-searchbar-result {
+    line-height: 32px;
+    padding-left: 10px;
+    padding-right: 10px;
+}
+
+.scala3doc-searchbar-result:first-of-type {
+    margin-top: 10px;
+}
+
+.scala3doc-searchbar-result:hover {
+    background-color: #d4edff;
+}
+
+.scala3doc-searchbar-result a {
+    color: #1f2326;
+}
+
+.scala3doc-searchbar-result .scala3doc-searchbar-location {
+    color: gray;
+}
+
+#searchBar {
+    display: inline-flex;
+}
+
+.pull-right {
+    float: right;
+    margin-left: auto
+}

scala3doc-js/src/Globals.scala

@@ -0,0 +1,10 @@
+package dotty.dokka
+
+import scala.scalajs.js
+import scala.scalajs.js.annotation.JSGlobalScope
+
+@js.native
+@JSGlobalScope
+object Globals extends js.Object {
+  val pathToRoot: String = js.native
+}

scala3doc-js/src/Main.scala

@@ -0,0 +1,7 @@
+package dotty.dokka
+
+object Main extends App {
+  def initializeSearchbar(): Unit = Searchbar()
+
+  initializeSearchbar()
+}

scala3doc-js/src/searchbar/PageEntry.scala

@@ -0,0 +1,27 @@
+package dotty.dokka
+
+import scala.scalajs.js
+
+@js.native
+trait PageEntryJS extends js.Object {
+  val name: String = js.native
+  val description: String = js.native
+  val location: String = js.native
+  val searchKeys: js.Array[String] = js.native
+}
+
+case class PageEntry(
+  name: String,
+  description: String,
+  location: String,
+  searchKeys: Array[String]
+)
+
+object PageEntry {
+  def apply(jsObj: PageEntryJS): PageEntry = PageEntry(
+    jsObj.name,
+    jsObj.description,
+    jsObj.location,
+    jsObj.searchKeys.toArray
+  )
+}

scala3doc-js/src/searchbar/Searchbar.scala

@@ -0,0 +1,7 @@
+package dotty.dokka
+
+class Searchbar {
+  val pages = SearchbarGlobals.pages.toList.map(PageEntry.apply)
+  val engine = SearchbarEngine(pages)
+  val component = SearchbarComponent(engine.query)
+}

scala3doc-js/src/searchbar/SearchbarComponent.scala

@@ -0,0 +1,73 @@
+package dotty.dokka
+
+import org.scalajs.dom._
+import org.scalajs.dom.html.Input
+
+class SearchbarComponent(val callback: (String) => List[PageEntry]) {
+  extension (p: PageEntry)
+    def toHTML = {
+      val wrapper = document.createElement("div")
+      wrapper.classList.add("scala3doc-searchbar-result")
+      wrapper.classList.add("monospace")
+
+      val resultA = document.createElement("a").asInstanceOf[html.Anchor]
+      resultA.href = Globals.pathToRoot + p.location
+      resultA.text = s"${p.name}"
+
+      val location = document.createElement("span")
+      location.classList.add("pull-right")
+      location.classList.add("scala3doc-searchbar-location")
+      location.textContent = p.description
+
+      wrapper.appendChild(resultA)
+      wrapper.appendChild(location)
+      wrapper
+    }
+
+  def handleNewQuery(query: String) = {
+    val result = callback(query).map(_.toHTML)
+    while (resultsDiv.hasChildNodes()) resultsDiv.removeChild(resultsDiv.lastChild)
+    result.foreach(resultsDiv.appendChild)
+  }
+
+  private val logoClick: html.Span = {
+    val element = document.createElement("span").asInstanceOf[html.Span]
+    element.id = "scala3doc-search"
+    element.onclick = (event: Event) =>
+      if (rootDiv.className.contains("hidden"))
+        rootDiv.className = rootShowClasses
+      else rootDiv.className = rootHiddenClasses
+    document.getElementById("searchBar").appendChild(element)
+    element
+  }
+
+  private val input: html.Input = {
+    val element = document.createElement("input").asInstanceOf[html.Input]
+    element.id = "scala3doc-searchbar-input"
+    element.addEventListener("keyup", (e) => handleNewQuery(e.target.asInstanceOf[html.Input].value))
+    element
+  }
+
+  private val resultsDiv: html.Div = {
+    val element = document.createElement("div").asInstanceOf[html.Div]
+    element.id = "scala3doc-searchbar-results"
+    element
+  }
+
+  private val rootHiddenClasses = "hidden"
+  private val rootShowClasses   = ""
+  private val rootDiv: html.Div = {
+    val element = document.createElement("div").asInstanceOf[html.Div]
+    element.addEventListener("click", (e: Event) => e.stopPropagation())
+    logoClick.addEventListener("click", (e: Event) => e.stopPropagation())
+    document.body.addEventListener("click", (e: Event) => element.className = rootHiddenClasses)
+    element.className = rootHiddenClasses
+    element.id = "scala3doc-searchbar"
+    element.appendChild(input)
+    element.appendChild(resultsDiv)
+    document.body.appendChild(element)
+    element
+  }
+
+  handleNewQuery("")
+}

scala3doc-js/src/searchbar/SearchbarGlobals.scala

@@ -0,0 +1,10 @@
+package dotty.dokka
+
+import scala.scalajs.js
+import scala.scalajs.js.annotation.JSGlobalScope
+
+@js.native
+@JSGlobalScope
+object SearchbarGlobals extends js.Object {
+  val pages: js.Array[PageEntryJS] = js.native
+}

scala3doc-js/src/searchbar/engine/Matchers.scala

@@ -0,0 +1,6 @@
+package dotty.dokka
+
+class SearchbarEngine(pages: List[PageEntry]) {
+  //TODO: Query should be parsed by QueryParser to list of filtering strategies called Matchers
+  def query(query: String): List[PageEntry] = pages
+}