com.raquo.laminar.modifiers.Binder.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of laminar_sjs1_2.13 Show documentation

Laminar

The newest version!

package com.raquo.laminar.modifiers

import com.raquo.airstream.ownership.DynamicSubscription
import com.raquo.laminar.nodes.ReactiveElement

/** Binder is a Modifier that creates a subscription when invoked.
  * - Note, this Modifier is NOT idempotent:
  *   Calling it N times will create and bind N subscriptions
  * - `onMountBind` can take care of this, see the docs
  */
trait Binder[-El <: ReactiveElement.Base] extends Modifier[El] {

  /** This method is used by onMountBind to cancel this subscription on unmount */
  def bind(element: El): DynamicSubscription

  final override def apply(element: El): Unit = bind(element)
}

object Binder {

  type Base = Binder[ReactiveElement.Base]

  def apply[El <: ReactiveElement.Base](fn: El => DynamicSubscription): Binder[El] = {
    new Binder[El] {
      override def bind(element: El): DynamicSubscription = fn(element)
    }
  }

  def withSelf[El <: ReactiveElement.Base](fn: (El, Binder[El]) => DynamicSubscription): Binder[El] = {
    new Binder[El] {
      override def bind(element: El): DynamicSubscription = fn(element, this)
    }
  }
}