components/dev.fritz2.components/IconComponent

IconComponent

open class IconComponent : Component<Unit> , EventProperties<SVGElement>

Class for configuring the appearance of an icon.

An IconDefinitionmust be provided in order to render an icon. This definition wraps the pure SVG markup together with additional properties like the display-name and the viewbox.

In order to provide a comfortable way to use the predefined icons from the dev.fritz2.styling.theme.Theme, use the IconComponent.fromTheme method.

Constructors

IconComponent

fun IconComponent()

Types

Companion

object Companion

Functions

equals

open operator fun equals(other: Any?): Boolean

fromTheme

fun fromTheme(value: Icons.() -> IconDefinition)

hashCode

open fun hashCode(): Int

render

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.

toString

open fun toString(): String

Properties

def

val def: ComponentProperty<IconDefinition?>

displayName

val displayName: ComponentProperty<String?>

events

open override val events: ComponentProperty<WithEvents<SVGElement>.() -> Unit>

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

svg

val svg: ComponentProperty<String?>

viewBox

val viewBox: ComponentProperty<String>