Laminar
API
Generated with
Laminar/com.raquo.laminar/com.raquo.laminar.keys

com.raquo.laminar.keys

package com.raquo.laminar.keys

Members list

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

Attributes

Supertypes
class Key
class Object
trait Matchable
class Any
class CompositeKey[K <: Key, -El <: Base](val name: String, val getRawDomValue: El => String, val setRawDomValue: (El, String) => Unit, val separator: String) extends Key

Attributes

Companion
object
Supertypes
class Key
class Object
trait Matchable
class Any
object CompositeKey

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait DerivedStyleBuilder[SS, DSP[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object style.type
class StyleProp[V]
object DerivedStyleBuilder

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
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

Attributes

Supertypes
class Object
trait Matchable
class Any
class EventProcessor[Ev <: Event, V](val eventProp: EventProp[Ev], val shouldUseCapture: Boolean, val shouldBePassive: 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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object EventProcessor

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
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

Attributes

Supertypes
class Key
class Object
trait Matchable
class Any
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

Attributes

Supertypes
class Key
class Object
trait Matchable
class Any
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

Attributes

Supertypes
class Key
class Object
trait Matchable
class Any
Self type
HtmlProp[V, DomV]
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"

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AriaAttr[V]
class CompositeKey[K, El]
class EventProp[Ev]
class HtmlAttr[V]
class HtmlProp[V, DomV]
class StyleProp[V]
class SvgAttr[V]
Show all
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

Attributes

Supertypes
class Object
trait Matchable
class Any
class LockedEventKey[Ev <: Event, -In, +Out](eventProcessor: EventProcessor[Ev, In], composer: EventStream[In] => Observable[Out])

Attributes

Supertypes
class Object
trait Matchable
class Any
class StyleProp[V](val name: String, val prefixes: Seq[String]) extends Key, GlobalKeywords, DerivedStyleBuilder[StyleSetter, DerivedStyleProp]

Attributes

Supertypes
class Key
class Object
trait Matchable
class Any
Show all
object StyleVendorPrefixes

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class SvgAttr[V](val localName: String, val codec: Codec[V, String], val namespacePrefix: 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
namespacePrefix
  • e.g. "xlink". For namespace URI, see namespaceUri

Attributes

Companion
object
Supertypes
class Key
class Object
trait Matchable
class Any
object SvgAttr

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SvgAttr.type
Generated with