Skip to content

Commit

Permalink
Fix css bugs wih link and table row (Kotlin#2284)
Browse files Browse the repository at this point in the history
* Remove extra top margin in paragraph

* Remove margin-bottom from platform-hinted

* Fix link underlining in table and anchor icon

* Make breakable names of constructors

* Add test for breakable name of constructor
  • Loading branch information
vmishenev authored and owengray-google committed Dec 29, 2021
1 parent b0a5d53 commit 91d3b51
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 5 deletions.
4 changes: 3 additions & 1 deletion plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
Expand Up @@ -450,7 +450,9 @@ open class HtmlRenderer(
it.filter { sourceSetRestriction == null || it.sourceSets.any { s -> s in sourceSetRestriction } }
.forEach {
span("inline-flex") {
it.build(this, pageContext, sourceSetRestriction)
div {
it.build(this, pageContext, sourceSetRestriction)
}
if (it is ContentLink && !anchorDestination.isNullOrBlank()) buildAnchorCopyButton(
anchorDestination
)
Expand Down
Expand Up @@ -261,7 +261,7 @@ open class DefaultPageCreator(
needsAnchors = true,
extra = PropertyContainer.empty<ContentNode>() + SimpleAttr.header("Constructors")
) {
link(it.name, it.dri, kind = ContentKind.Main)
link(it.name, it.dri, kind = ContentKind.Main, styles = setOf(ContentStyle.RowTitle))
sourceSetDependentHint(
it.dri,
it.sourceSets.toSet(),
Expand Down
6 changes: 3 additions & 3 deletions plugins/base/src/main/resources/dokka/styles/style.css
Expand Up @@ -228,6 +228,7 @@ html ::-webkit-scrollbar-thumb {
margin-top: 8px;
}

p.paragraph:first-child,
.brief p.paragraph {
margin-top: 0;
}
Expand Down Expand Up @@ -746,7 +747,6 @@ td.content {
}

.main-subrow .anchor-icon {
padding: 0 8px;
opacity: 0;
transition: 0.2s 0.5s;
}
Expand All @@ -765,8 +765,9 @@ td.content {

.main-subrow .anchor-wrapper {
position: relative;
width: 16px;
width: 24px;
height: 16px;
margin-left: 3px;
}

.inline-flex {
Expand All @@ -776,7 +777,6 @@ td.content {
.platform-hinted {
flex: auto;
display: block;
margin-bottom: 5px;
}

.platform-hinted > .platform-bookmarks-row > .platform-bookmark {
Expand Down
@@ -0,0 +1,48 @@
package content.functions

import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.model.DClass
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.pages.*
import org.junit.jupiter.api.Test
import utils.assertNotNull
import kotlin.test.assertEquals

class ContentForConstructors : BaseAbstractTest() {
private val testConfiguration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
analysisPlatform = "jvm"
}
}
}

@Test
fun `constructor name should have RowTitle style`() {
testInline("""
|/src/main/kotlin/test/source.kt
|package test
|
|/**
| * Dummy text.
| */
|class Example(val exampleParameter: Int) {
|}
""".trimIndent(), testConfiguration) {
pagesTransformationStage = { module ->
val classPage =
module.dfs { it.name == "Example" && (it as ContentPage).documentable is DClass } as ContentPage
val constructorsTable =
classPage.content.dfs { it is ContentTable && it.dci.kind == ContentKind.Constructors } as ContentTable

assertEquals(1, constructorsTable.children.size)
val primary = constructorsTable.children.first()
val constructorName =
primary.dfs { (it as? ContentText)?.text == "Example" }.assertNotNull("constructorName")

assert(ContentStyle.RowTitle in constructorName.style)
}
}
}
}

0 comments on commit 91d3b51

Please sign in to comment.