outwatch / outwatch

The Functional and Reactive Web-Frontend Library for ScalaJS

Version Matrix

Outwatch

The Functional and Reactive Web-Frontend Library for ScalaJS

Typelevel incubator Scala.js Gitter chat

import outwatch._
import outwatch.dsl._
import colibri._
import cats.effect.IO

object Main {
  def main(args: Array[String]): Unit = {
    
    val counter = Subject.behavior(0)
    val myComponent = div(
      button("+", onClick(counter.map(_ + 1)) --> counter),
      counter,
    )

    OutWatch.renderReplace[IO]("#app", myComponent).unsafeRunSync()
  }
}

In Outwatch, you can describe your whole web application without doing any side effect - you only run your application when rendering it.

  • Write UI-components using pure functions
  • Manage state in a referentially transparent way using cats-effect
  • Built-in lightweight Observable and Subject types from colibri
  • Seamlessly works with existing reactive programming libraries: Monix, scala.rx
  • Low-boilerplate, many convenient helper functions
  • Built on top of snabbdom, a virtual dom library

You will find interactive examples and explanations in our documentation.

Documentation

Quickstart

Template

The quickest way to play with outwatch is to use our template.

Make sure that java, sbt, nodejs and yarn are installed.

sbt new outwatch/seed.g8

In your newly created project directory, run:

sbt dev

and point your browser to http://localhost:8080.

Manual setup

Add the scalajs and scalajs-bundler plugins to your project/plugins.sbt:

addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.x.x")
addSbtPlugin("ch.epfl.scala" % "sbt-scalajs-bundler" % "x.x.x")

Add the outwatch dependencies to your build.sbt:

enablePlugins(ScalaJSPlugin)
enablePlugins(ScalaJSBundlerPlugin)

resolvers += "jitpack" at "https://jitpack.io"
val outwatchVersion = "<latest git commit>"
libraryDependencies ++= Seq(
  "com.github.outwatch.outwatch" %%% "outwatch"      % outwatchVersion,
  // optional dependencies:
  "com.github.cornerman.colibri" %%% "colibri-monix" % outwatchVersion, // Monix
  "com.github.cornerman.colibri" %%% "colibri-rx"    % outwatchVersion, // Scala.rx
  "com.github.outwatch.outwatch" %%% "outwatch-util" % outwatchVersion, // Store, Websocket, Http
)

Bugs and Feedback

For bugs, questions and discussions please use GitHub Issues.

Community

We adopted the Scala Code of Conduct. People are expected to follow it when discussing Outwatch on the Github page, Gitter channel, or other venues.

LICENSE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.