Laminar/com.raquo.laminar.keys

com.raquo.laminar.keys

package com.raquo.laminar.keys

Type members

Classlikes

class AriaAttr[V](suffix: String, val codec: Codec[V, String]) extends Key

This class represents an HTML Element Attribute. Meaning the key that can be set, not the whole a key-value pair.

This class represents an HTML Element Attribute. Meaning the key that can be set, not the whole a key-value pair.

Type parameters:
V

type of values that this Attribute can be set to

class CompositeKey[K <: Key, -El <: Base](val name: String, val getRawDomValue: El => String, val setRawDomValue: (El, String) => Unit, val separator: String) extends Key
Companion:
object
object CompositeKey
Companion:
class
trait DerivedStyleBuilder[SS, DSP[_]]
Companion:
object
object DerivedStyleBuilder
Companion:
class
class DerivedStyleProp[InputV](val key: StyleProp[_], val encode: InputV => String)

This class represents derived style props like height.px or backgroundImage.url

This class represents derived style props like height.px or backgroundImage.url

class EventProcessor[Ev <: Event, V](val eventProp: EventProp[Ev], val shouldUseCapture: Boolean, val processor: Ev => Option[V])

This class represents a sequence of transformations that are applied to events feeding into an EventListener EventProcessor-s are immutable, so can be reused by multiple setters.

This class represents a sequence of transformations that are applied to events feeding into an EventListener EventProcessor-s are immutable, so can be reused by multiple setters.

Example syntax: input(onChange().preventDefault.mapTo(true) --> myBooleanWriteBus)

Note: Params are protected to avoid confusing autocomplete options (e.g. "useCapture")

Value parameters:
processor

Processes incoming events before they're passed to the next processor or to the listening EventBus. Returns an Option of the processed value. If None, the value should not passed down the chain.

shouldUseCapture

(false means using bubble mode) See useCapture docs here: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

Companion:
object
object EventProcessor
Companion:
class
class EventProp[Ev <: Event](val name: String) extends Key

This class represents an HTML Element Event Property. Meaning the key that can be set, not a key-value pair.

This class represents an HTML Element Event Property. Meaning the key that can be set, not a key-value pair.

An example would be an "onclick" property.

Note: ReactiveEventProp is implicitly converted to EventProcessor. See all the useful methods there.

Type parameters:
Ev

type of DOM Events that the event handler callback for this event prop accepts

class HtmlAttr[V](val name: String, val codec: Codec[V, String]) extends Key

This class represents an HTML Element Attribute. Meaning the key that can be set, not the whole a key-value pair.

This class represents an HTML Element Attribute. Meaning the key that can be set, not the whole a key-value pair.

Type parameters:
V

type of values that this Attribute can be set to

class HtmlProp[V, DomV](val name: String, val codec: Codec[V, DomV]) extends Key

This class represents a DOM Element Property. Meaning the key that can be set, not a key-value pair.

This class represents a DOM Element Property. Meaning the key that can be set, not a key-value pair.

Note: following the Javascript DOM Spec, Properties are distinct from Attributes even when they share a name.

Type parameters:
DomV

type of values that this Property holds in the native Javascript DOM

V

type of values that this Property can be set to

abstract class Key

This class represents a Key typically found on the left hand side of the key-value pair key := value

This class represents a Key typically found on the left hand side of the key-value pair key := value

Example would be a particular attribute or a property (without the corresponding value), e.g. "href"

class LockedCompositeKey[K <: Key, -El <: Base](val key: CompositeKey[K, El], val items: List[String])

Laminar key specific to a particular set of CompositeAttr values

Laminar key specific to a particular set of CompositeAttr values

class LockedEventKey[Ev <: Event, -In, +Out](eventProcessor: EventProcessor[Ev, In], composer: EventStream[In] => Observable[Out])
class StyleProp[V](val name: String, val prefixes: Seq[String]) extends Key with GlobalKeywords with DerivedStyleBuilder[StyleSetter, DerivedStyleProp]
object StyleVendorPrefixes
class SvgAttr[V](localName: String, val codec: Codec[V, String], val namespace: Option[String]) extends Key

This class represents an Svg Element Attribute. Meaning the key that can be set, not the whole a key-value pair.

This class represents an Svg Element Attribute. Meaning the key that can be set, not the whole a key-value pair.

Type parameters:
V

type of values that this Attribute can be set to

Value parameters:
localName
  • Unqualified name, without the namespace prefix
Companion:
object
object SvgAttr
Companion:
class