Merge pull request #20 from pikinier20/scaladoc/new-ui-fixes

Make SocialLinks generic. Fix navigation. Add project name

Author: fanixus96

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

@@ -56,8 +56,7 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
 
   val socialLinks: Setting[List[String]] =
     MultiStringSetting("-social-links", "social-links",
-      "Links to social sites. '[github|twitter|gitter|discord]::link' syntax is used. " +
-        "'custom::link::white_icon_name::black_icon_name' is also allowed, in this case icons must be present in 'images/'' directory.")
+      "Links to social sites. '[github|twitter|gitter|discord]::link' syntax is used.")
 
   val deprecatedSkipPackages: Setting[List[String]] =
     MultiStringSetting("-skip-packages", "packages", "Deprecated, please use `-skip-by-id` or `-skip-by-regex`")

scaladoc/src/dotty/tools/scaladoc/SocialLinks.scala

@@ -4,20 +4,17 @@ import java.nio.file.Path
 import java.nio.file.Paths
 import dotty.tools.dotc.core.Contexts.Context
 
-enum SocialLinks(val url: String, val whiteIconName: String, val blackIconName: String):
-  case Github(ghUrl: String) extends SocialLinks(ghUrl, "github-icon-white.png", "github-icon-black.png")
-  case Twitter(tUrl: String) extends SocialLinks(tUrl, "twitter-icon-white.png", "twitter-icon-black.png")
-  case Gitter(gUrl: String) extends SocialLinks(gUrl, "gitter-icon-white.png", "gitter-icon-black.png")
-  case Discord(dUrl: String) extends SocialLinks(dUrl, "discord-icon-white.png", "discord-icon-black.png")
-  case Custom(cUrl: String, cWhiteIconName: String, cBlackIconName: String) extends SocialLinks(cUrl, cWhiteIconName, cBlackIconName)
+enum SocialLinks(val url: String, val className: String):
+  case Github(ghUrl: String) extends SocialLinks(ghUrl, "gh")
+  case Twitter(tUrl: String) extends SocialLinks(tUrl, "twitter")
+  case Gitter(gUrl: String) extends SocialLinks(gUrl, "gitter")
+  case Discord(dUrl: String) extends SocialLinks(dUrl, "discord")
 
 object SocialLinks:
   def parse(s: String): Either[String, SocialLinks] =
     val errorPrefix = s"Social links arg $s is invalid: "
     val splitted = s.split("::")
     splitted.head match {
-      case "custom" if splitted.size == 4 => Right(Custom(splitted(1), splitted(2), splitted(3)))
-      case "custom" => Left(errorPrefix + "For 'custom' arg expected three arguments: url, white icon name and black icon name")
       case "github" if splitted.size == 2 => Right(Github(splitted(1)))
       case "github" => Left(errorPrefix + "For 'github' arg expected one argument: url")
       case "twitter" if splitted.size == 2 => Right(Twitter(splitted(1)))

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

@@ -142,22 +142,22 @@ class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: Do
 
     val isRootApiPageSelected = rootApiPage.fold(false)(_.link.dri == pageLink.dri)
     val isDocsApiPageSelected = rootDocsPage.fold(false)(_.link.dri == pageLink.dri)
-    val apiNav = rootApiPage.map { p => p.children.map(renderNested(_, 0)) match
+    val apiNav = rootApiPage.map { p => p.children.filterNot(_.hidden).map(renderNested(_, 0)) match
       case entries => (entries.exists(_._1) || isRootApiPageSelected, entries.map(_._2))
     }
-    val docsNav = rootDocsPage.map { p => p.children.map(renderNested(_, 0)) match
+    val docsNav = rootDocsPage.map { p => p.children.filterNot(_.hidden).map(renderNested(_, 0)) match
       case entries => (entries.exists(_._1) || isDocsApiPageSelected, entries.map(_._2))
     }
 
     (apiNav, docsNav)
 
   private def hasSocialLinks = !args.socialLinks.isEmpty
 
-  private def socialLinks(whiteIcon: Boolean = true) =
-    val icon = (link: SocialLinks) => if whiteIcon then link.whiteIconName else link.blackIconName
+  private def socialLinks =
+    def icon(link: SocialLinks) = link.className
     args.socialLinks.map { link =>
-      a(href := link.url)(
-        span(cls := s"social-icon", Attr("data-icon-path") := icon(link))
+      a(href := link.url) (
+        button(cls := s"icon-button ${icon(link)}")
       )
     }
 
@@ -213,10 +213,9 @@ class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: Do
         div(cls := "header-container-left")(
           projectLogoElem.toSeq,
           darkProjectLogoElem.toSeq,
+          span(cls := "project-name")(args.name),
           span(onclick := "dropdownHandler(event)", cls := "text-button with-arrow", id := "dropdown-trigger")(
-            a()(
-              args.projectVersion.map(v => div(cls:="projectVersion")(v)).getOrElse("")
-            ),
+            a(args.projectVersion.map(v => div(cls:="projectVersion")(v)).toSeq),
           ),
           div(id := "version-dropdown", cls := "dropdown-menu") ()
         ),
@@ -302,18 +301,7 @@ class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: Do
          "Generated with"
         ),
         div(cls := "right-container")(
-          a(href := "https://github.com/lampepfl/dotty") (
-            button(cls := "icon-button gh")
-          ),
-          a(href := "https://twitter.com/scala_lang") (
-            button(cls := "icon-button twitter")
-          ),
-          a(href := "https://discord.com/invite/scala") (
-            button(cls := "icon-button discord"),
-          ),
-          a(href := "https://gitter.im/scala/scala") (
-            button(cls := "icon-button gitter"),
-          ),
+          socialLinks,
           div(cls := "text")(
             "© 2002-2021 · LAMP/EPFL"
           )