Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thoughtworksinc/bindable.scala
User-friendly Binding.scala components
https://github.com/thoughtworksinc/bindable.scala
data-binding functional-reactive-programming scala scala-js type-classes
Last synced: 3 months ago
JSON representation
User-friendly Binding.scala components
- Host: GitHub
- URL: https://github.com/thoughtworksinc/bindable.scala
- Owner: ThoughtWorksInc
- License: mit
- Created: 2019-03-07T16:47:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-05T00:12:35.000Z (10 months ago)
- Last Synced: 2024-05-05T01:25:00.408Z (10 months ago)
- Topics: data-binding, functional-reactive-programming, scala, scala-js, type-classes
- Language: Scala
- Homepage:
- Size: 356 KB
- Stars: 23
- Watchers: 20
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bindable.scala
[](https://index.scala-lang.org/thoughtworksinc/bindable.scala/bindable)
[](https://javadoc.io/page/com.thoughtworks.binding/bindable_sjs0.6_2.13/latest/com/thoughtworks/binding/bindable/index.html)
[](https://github.com/ThoughtWorksInc/bindable.scala/actions/workflows/scala.yml)**bindable.scala** is a library of type classes for creating user-friendly [Binding.scala](https://github.com/ThoughtWorksInc/Binding.scala) components.
## Motivation
When creating a component that accepts parameters or “holes”, it is difficult to determine the types of those parameters.
For example, the following component accepts two `Binding` as parameters:```scala
@dom def myComponent1(title: Binding[String], children: Binding[BindingSeq[Node]]) = {
{children.bind}
}
```By typing parameters as `Binding`s, `myComponent1` allows partial rendering whenever the value of `title` or `children` is changed. Unfortunately, it is too verbose to use `myComponent1` for simple use cases when the parameters are constants.
```scala
// Does not compile
@dom def myUseCases1 = myComponent1("My Title",).bind
// Compiles, but too verbose
@dom def myUseCases2 = myComponent1(Constant("My Title"), Constant(Constants())).bind
```In this library, we introduced two type classes, `Bindable` and `BindableSeq`, to allow heterogeneous types of parameters for a component.
## Usage
### Step 1: adding the following settings into your `build.sbt`
```sbt
addCompilerPlugin("org.spire-math" %% "kind-projector" % "latest.release")libraryDependencies += "com.thoughtworks.binding" %%% "bindable" % "latest.release"
```### Step 2: creating a component that accepts bindable parameters
```scala
import com.thoughtworks.binding.bindable._
import org.scalajs.dom.raw._
@dom def myComponent2[Title: Bindable.Lt[?, String], Children: BindableSeq.Lt[?, Node]](title: Title, children: Children) = {
{children.bindSeq}
}
```### Step 3: using the component with any parameters that can be converted to `Binding` or `BindingSeq`
```scala
import com.thoughtworks.binding._, Binding._
@dom def myUseCases3 = myComponent2("My Title",).bind
@dom def myUseCases4 = myComponent2(Constant("My Title"), Constant(Constants())).bind
@dom def myUseCases5 = myComponent2("My Title",).bind
@dom def myUseCases6 = myComponent2("My Title", Binding()).bind
```Unlike use cases of `myComponent1`, all the above use cases of `myComponent2` compile now, with the help of the `Bindable` and `BindableSeq` type classes.
## Links
* [Documentation](https://javadoc.io/page/com.thoughtworks.binding/bindable_sjs0.6_2.13/latest/com/thoughtworks/binding/bindable/index.html)
* [Binding.scala](https://github.com/ThoughtWorksInc/Binding.scala)
* [Limitations of the component model](https://github.com/ThoughtWorksInc/Binding.scala/issues/128)