LinkButtonComponent

open class LinkButtonComponent : PushButtonComponent

This class extends the PushButtonComponent and adds link specific properties to it.

Example:

linkButton {
text("fritz2") // define the default label
href("//www.fritz2.dev") // specifies the URL of the page the link goes to
target("_blank") // specifies where to open the linked document

icon { fromTheme { check } } // set up an icon
iconPlacement { right } // place the icon on the right side (``left`` is the default)
loading(someStore.loading) // pass in some [Flow<Boolean>] that shows a spinner if ``true`` is passed
loadingText("saving") // show an _alternate_ label, if store sends ``true``
disabled(true) // disable the button; could also be a ``Flow<Boolean>`` for dynamic disabling
element {
// exposes the underlying HTML button element for direct access. Use with caution!
}
}

See also

Constructors

Link copied to clipboard
fun LinkButtonComponent()

Functions

Link copied to clipboard
open override fun enabled(value: Boolean)
open override fun enabled(value: Flow<Boolean>)
Link copied to clipboard
fun href(value: String)
fun href(value: Flow<String>)
Link copied to clipboard
fun loading(value: Flow<Boolean>)
Link copied to clipboard
fun loadingText(value: String)
fun loadingText(value: Flow<String>)
Link copied to clipboard
open override fun render(    context: RenderContext,     styling: BoxParams.() -> Unit,     baseClass: StyleClass,     id: String?,     prefix: String)

Central method that should do the actual rendering of a component.

Link copied to clipboard
fun target(value: String)
fun target(value: Flow<String>)
Link copied to clipboard
fun text(value: String)
fun text(value: Flow<String>)
Link copied to clipboard
open override fun tooltip(vararg text: String, build: TooltipComponent.() -> Unit)
open override fun tooltip(    styling: BasicParams.() -> Unit,     text: String?,     baseClass: StyleClass,     id: String,     prefix: String,     build: TooltipComponent.() -> Unit)

Properties

Link copied to clipboard
val centerIconStyle: Style<BasicParams>
Link copied to clipboard
val centerSpinnerStyle: Style<BasicParams>
Link copied to clipboard
open override val disabled: DynamicComponentProperty<Boolean>
Link copied to clipboard
open override val element: ComponentProperty<Button.() -> Unit>

This property enables the client to access the deeper features of an element even though the component itself does not offer an appropriate functionality. A client should use this with caution, as it might massively change the default behaviour of the component!

Link copied to clipboard
open override val events: ComponentProperty<EventContext<HTMLButtonElement>.() -> Unit>

This property enables the client to access all events offered by the underlying HTML element.

Link copied to clipboard
val icon: ComponentProperty<Icons.() -> IconDefinition?>
Link copied to clipboard
val leftIconStyle: Style<BasicParams>
Link copied to clipboard
val leftSpinnerStyle: Style<BasicParams>
Link copied to clipboard
open override val renderTooltip: ComponentProperty<Tag<HTMLElement>.() -> Unit>
Link copied to clipboard
val rightIconStyle: Style<BasicParams>
Link copied to clipboard
val rightSpinnerStyle: Style<BasicParams>
Link copied to clipboard
val size: ComponentProperty<FormSizesStyles.() -> Style<BasicParams>>
Link copied to clipboard
val type: ComponentProperty<PushButtonTypes.() -> ColorScheme>
Link copied to clipboard