ysny.karibu-tools.karibu-tools.0.20.source-code.Notifications.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of karibu-tools Show documentation

Karibu-Tools: The Vaadin Missing Utilities

There is a newer version: 0.21

package com.github.mvysny.kaributools

import com.vaadin.flow.component.button.Button
import com.vaadin.flow.component.button.ButtonVariant
import com.vaadin.flow.component.html.Span
import com.vaadin.flow.component.icon.Icon
import com.vaadin.flow.component.icon.VaadinIcon
import com.vaadin.flow.component.notification.Notification
import com.vaadin.flow.dom.Element
import java.lang.reflect.Field

private val Notification._templateElement: Element
    get() {
        require(VaadinVersion.get < SemanticVersion(24, 0, 0, "alpha8")) { "Unsupported on Vaadin 24+" }
        val f: Field = Notification::class.java.getDeclaredField("templateElement")
        f.isAccessible = true
        return f.get(this) as Element
    }

/**
 * Returns the notification text.
 *
 * Vote for https://github.com/vaadin/web-components/issues/2446
 */
public fun Notification.getText(): String {
    if (hasChildren) {
        // adding components to the notification clears the notification text
        return ""
    }
    if (VaadinVersion.get >= SemanticVersion(24, 0, 0, "alpha8")) {
        return element.getProperty("text") ?: ""
    }
    val e: Element = _templateElement
    return e.getProperty("innerHTML") ?: ""
}

/**
 * Adds a close button to the notification.
 *
 * Vote for https://github.com/vaadin/web-components/issues/438
 */
public fun Notification.addCloseButton(): Notification {
    if (getText().isNotBlank()) {
        // adding components clears the text; preserve the original text in a Span.
        add(Span(getText()))
    }
    val closeButton = Button(Icon(VaadinIcon.CLOSE))
    closeButton.addThemeVariantsCompat(ButtonVariant.LUMO_ICON, ButtonVariant.LUMO_TERTIARY)
    closeButton.addClickListener { close() }
    add(closeButton)
    return this
}