commonMain.kotlinx.css.CssBuilder.kt Maven / Gradle / Ivy

Go to download
package kotlinx.css

fun CssBuilder(
    indent: String = "",
    allowClasses: Boolean = true,
    parent: RuleContainer? = null,
    isHolder: Boolean = false,
    isStyledComponent: Boolean = false,
): CssBuilder = CssBuilderImpl(indent, allowClasses, parent, isHolder, isStyledComponent)

interface CssBuilder : StyledElement, RuleContainer {
    val allowClasses: Boolean
    var parent: RuleContainer?
    val classes: MutableList
    val styleName: MutableList

    // Indicates that the builder holds CSS for further use (forwarding, etc.)
    val isHolder: Boolean

    // Indicates that the builder was created by kotlin-styled (legacy)
    val isStyledComponent: Boolean

    operator fun String.invoke(block: RuleSet) = rule(this, passStaticClassesToParent = false, block = block)

    operator fun String.invoke(css: CssBuilder) = rule(this, passStaticClassesToParent = false, css = css)

    operator fun TagSelector.invoke(block: RuleSet) = tagName(block)

    // https://developer.mozilla.org/en/docs/Web/CSS/Pseudo-classes
    // The experimental ones were omitted
    fun active(block: RuleSet) = "&:active"(block)
    fun checked(block: RuleSet) = "&:checked"(block)
    fun default(block: RuleSet) = "&:default"(block)
    fun defined(block: RuleSet) = "&:defined"(block)
    fun disabled(block: RuleSet) = "&:disabled"(block)
    fun empty(block: RuleSet) = "&:empty"(block)
    fun enabled(block: RuleSet) = "&:enabled"(block)
    fun firstChild(block: RuleSet) = "&:first-child"(block)
    fun firstOfType(block: RuleSet) = "&:first-of-type"(block)
    fun fullscreen(block: RuleSet) = "&:fullscreen"(block)
    fun focus(block: RuleSet) = "&:focus"(block)
    fun focusVisible(block: RuleSet) = "&:focus-visible"(block)
    fun focusWithin(block: RuleSet) = "&:focus-within"(block)
    fun hover(block: RuleSet) = "&:hover"(block)
    fun indeterminate(block: RuleSet) = "&:indeterminate"(block)
    fun inRange(block: RuleSet) = "&:in-range"(block)
    fun invalid(block: RuleSet) = "&:invalid"(block)
    fun lastChild(block: RuleSet) = "&:last-child"(block)
    fun lastOfType(block: RuleSet) = "&:last-of-type"(block)
    fun link(block: RuleSet) = "&:link"(block)
    fun not(vararg selector: String, block: RuleSet): Rule {
        // The verbosity is necessitated by an IR bug, do not inline!
        val selectorString = selector.joinToString { "&:not($it)" }
        return selectorString(block)
    }

    fun nthChild(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "&:nth-child($it)" }
        return selectorString(block)
    }

    fun nthLastChild(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "&:nth-last-child($it)" }
        return selectorString(block)
    }

    fun nthLastOfType(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "&:nth-last-of-type($it)" }
        return selectorString(block)
    }

    fun nthOfType(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "&:nth-of-type($it)" }
        return selectorString(block)
    }

    fun onlyChild(block: RuleSet) = "&:only-child"(block)
    fun onlyOfType(block: RuleSet) = "&:only-of-type"(block)
    fun optional(block: RuleSet) = "&:optional"(block)
    fun outOfRange(block: RuleSet) = "&:out-of-range"(block)
    fun placeholderShown(block: RuleSet) = "&:placeholder-shown"(block)
    fun readOnly(block: RuleSet) = "&:read-only"(block)
    fun readWrite(block: RuleSet) = "&:read-write"(block)
    fun required(block: RuleSet) = "&:required"(block)
    fun valid(block: RuleSet) = "&:valid"(block)
    fun visited(block: RuleSet) = "&:visited"(block)

    // Children & descendants
    fun children(vararg selector: String = arrayOf("*"), block: RuleSet): Rule {
        val selectorString = selector.joinToString { "& > $it" }
        return selectorString(block)
    }

    fun descendants(vararg selector: String = arrayOf("*"), block: RuleSet): Rule {
        val selectorString = selector.joinToString { "& $it" }
        return selectorString(block)
    }

    fun ancestorHover(vararg selector: String, block: RuleSet): Rule {
        // https://github.com/styled-components/styled-components/issues/3244#issuecomment-687676703
        val selectorRef = if (isStyledComponent) "&&" else "&"
        val selectorString = selector.joinToString { "$it:hover $selectorRef" }
        return selectorString(block)
    }

    // https://developer.mozilla.org/en/docs/Web/CSS/Pseudo-elements
    fun after(block: RuleSet) = "&::after" {
        content = "".quoted
        block()
    }

    fun before(block: RuleSet) = "&::before" {
        content = "".quoted
        block()
    }

    fun firstLetter(block: RuleSet) = "&::first-letter"(block)
    fun firstLine(block: RuleSet) = "&::first-line"(block)

    fun placeholder(block: RuleSet) {
        "&::placeholder"(block)
        "&::-webkit-input-placeholder"(block) // Chrome, Opera, Safari
        "&::-moz-placeholder"(block) // Firefox 19+
        "&::-ms-input-placeholder"(block) // IE 10+
        "&:-moz-placeholder"(block) // Firefox 18-
    }

    fun selection(block: RuleSet) = "&::selection"(block)

    // Combinators
    fun child(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "> $it" }
        return selectorString(block)
    }

    fun child(vararg selector: String, css: CssBuilder): Rule {
        val selectorString = selector.joinToString { "> $it" }
        return selectorString(css)
    }

    fun sibling(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "~ $it" }
        return selectorString(block)
    }

    fun adjacentSibling(vararg selector: String, block: RuleSet): Rule {
        val selectorString = selector.joinToString { "+ $it" }
        return selectorString(block)
    }

    // Universal selector
    fun universal(block: RuleSet) = "*"(block)

    operator fun compareTo(rule: Rule): Int {
        // remove current rule
        rules.removeAt(rules.lastIndex)
        child(rule.selector, css = rule.css)
        return 0
    }

    operator fun Rule.not() {
        rules.removeAt(rules.lastIndex)
        selector.replace(NOT_REGEX, "$1:not($2)")(css)
    }

    operator fun Rule.unaryPlus() {
        rules.removeAt(rules.lastIndex)
        "&.$selector"(css)
    }

    fun specific(specificity: Int = 2, block: RuleSet) = rule("&".repeat(specificity), passStaticClassesToParent = true, block = block)

    fun prefix(vararg selector: String, block: RuleSet): Rule {
        // https://github.com/styled-components/styled-components/issues/3244#issuecomment-687676703
        val selectorRef = if (isStyledComponent) "&&" else "&"
        val selectorString = selector.joinToString { "$it $selectorRef" }
        return selectorString(block)
    }

    // https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule
    fun media(query: String, block: RuleSet) = "@media $query"(block)

    fun supports(query: String, block: RuleSet) = "@supports $query"(block)

    fun container(query: String, block: RuleSet) = "@container $query"(block)

    fun fontFace(block: RuleSet) = rule("@font-face", passStaticClassesToParent = false, repeatable = true, block = block)

    fun retina(block: RuleSet) {
        media("(-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi)") {
            block()
        }
    }

    // Custom properties
    fun root(block: RuleSet) {
        ":root" {
            block()
        }
    }

    /**
     * Add custom property to CSS [declarations]. If the variable name is in the camelCase, it turns it to snake-case
     */
    fun setCustomProperty(name: String, value: CssValue) {
        put("--$name", value.value)
    }

    // Functions
    fun min(v1: LinearDimension, v2: LinearDimension): LinearDimension =
        LinearDimension("min($v1, $v2)")

    fun max(v1: LinearDimension, v2: LinearDimension): LinearDimension =
        LinearDimension("max($v1, $v2)")

    fun clamp(min: LinearDimension, preferred: LinearDimension, max: LinearDimension): LinearDimension =
        LinearDimension("clamp($min, $preferred, $max)")

    // Operator overrides
    operator fun RuleSet.unaryPlus()

    operator fun String.unaryPlus() = addClass(this)

    operator fun Array.unaryPlus() = this.forEach { addClass(it) }

    operator fun Iterable.unaryPlus() = this.forEach { addClass(it) }

    private fun addClass(className: String) {
        if (allowClasses) {
            classes.add(className)
        } else {
            (parent as? CssBuilder)?.addClass(className)
        }
    }

    fun append(other: CssBuilder) {
        declarations.putAll(other.declarations)
        other.classes.forEach(this::addClass)
        styleName.addAll(other.styleName)
        rules.addAll(other.rules)
        multiRules.addAll(other.multiRules)
    }

    companion object {
        private val NOT_REGEX by lazy { Regex("^(&?)(.*)$") }
    }
}

typealias RuleSet = CssBuilder.() -> Unit

fun ruleSet(set: RuleSet) = set

fun String.toCustomProperty(): String {
    return "var(--$this)"
}

open class CssBuilderImpl(
    override val indent: String = "",
    override val allowClasses: Boolean = true,
    override var parent: RuleContainer? = null,
    override val isHolder: Boolean = false,
    override val isStyledComponent: Boolean = false,
) : CssBuilder {
    override val classes = mutableListOf()
    override fun RuleSet.unaryPlus() = this()

    override val declarations = CssDeclarations()

    override val styleName = mutableListOf()

    override fun toString() = buildString {
        append(declarations)
        buildRules(indent)
    }

    private var memoizedHashCode: Int? = null
    override fun hashCode(): Int {
        return memoizedHashCode
            ?: (rules.sumOf { it.hashCode() } + multiRules.sumOf { it.hashCode() } + declarations.hashCode())
                .also { hashCode -> memoizedHashCode = hashCode }
    }

    override fun equals(other: Any?) = this.calculateEquals(other) { otherCss ->
        rules == otherCss.rules && multiRules == otherCss.multiRules && declarations == otherCss.declarations
    }

    override val rules = mutableListOf()
    override val multiRules = mutableListOf()
}