v0.2.0
- BREAKING: Instead of taking key and refs as additional parameters next to props, they are now taken in through the methods
withKey
andwithRef
(components and external components only) - BREAKING: Introduce the experimental macro annotation
@react
to simplify component and external component creation with auto-generated companion object for a component class (or external component object). This is a major change to how applications with Slinky are written, so please see the notes at the end of the changelog PR #29- BREAKING: This change also renames the
Component
class toComponentWrapper
. TheComponent
class is now used for the@react
annotation.
- BREAKING: This change also renames the
- BREAKING: Rename
ExternalComponentWithTagMods
toExternalComponentWithAttributes
and take attributes as a curried parameter instead of an extra parameter afterProps
PR #26 - BREAKING: Introduce
ExternalComponentNoProps
andExternalComponentNoPropsWithAttributes
for cases where an external component takes no props PR #58 - BREAKING: Slinky now expects that the
-P:scalajs:sjsDefinedByDefault
compiler option is enabled in the@react
macro annotation [] - Have mouse attributes such as
onMouseDown
take aMouseEvent
instead of just anEvent
PR #27 - Add support for generating
Reader
andWriter
for sealed traits, value classes, and case objects (through a Magnolia upgrade) PR #45 - Fix bug with hot loading not updating instances of readers and writers PR #49
- Fix bug with hot loading using the wrong proxy component when there are multiple components classes in the tree PR #50
- Add support for reading and writing js.Dynamic (and anything that extends js.Any) PR #51
- Add support for reading and writing union types (js.|) PR #52
- Slinky's implementation of mapping Scala types to JS types is now available as a separate module
slinky-readwrite
PR #54 - Improve type safety of ExternalComponentWithAttributes by restricting the type parameter to tag types PR #55
@react
macro annotation (experimental)
One of Slinky's main goals is to have React components written in Scala look very similar to ES6. In version 0.1.x, Slinky required
extra boilerplate for defining an object that contained apply
methods and then creating a Def
inner class that contained the actual component logic.
This version includes the @react
macro annotation, which makes it possible to directly write the class containing component logic and have Slinky generate
the companion object for constructing component instances. The macro annotation also now generates special apply
methods when your Props is a case class
so that constructing Scala components looks more similar to JSX, with the Props values directly taken as parameters of the apply
.
Note that the macro annotation is experimental and not required. To use the original component style simply replace the extends Component
with extends ComponentWrapper
and your
components should continue to function as they did before.
As an example of migrating an existing component to the new macro annotation style, take a simple component that displays a header:
import me.shadaj.slinky.core.WrapperComponent
import me.shadaj.slinky.web.html._
object HelloMessage extends WrapperComponent {
case class Props(name: String)
type State = Unit
@ScalaJSDefined
class Def(jsProps: js.Object) extends Definition(jsProps) {
def render() = {
div(s"Hello ${props.name}")
}
}
}
to use the new macro annotation style, we essentially extract out the definition class, move the Props
and State
types into the class, and extend Component
instead of Definition
:
import me.shadaj.core.{Component, react}
import me.shadaj.slinky.web.html._
@react class HelloMessage extends Component {
case class Props(name: String)
def render() = {
div(s"Hello ${props.name}")
}
}
If we want to use this component, we now have a new option for constructing it directly passing in the Props values
HelloMessage(HelloMessage.Props("Shadaj")) // old style
HelloMessage("Shadaj") // now possible!
HelloMessage(name = "Shadaj") // now possible, closest to JSX
The @react
annotation is also available for external components. For external components, the annotation generates the new apply
method style in the same style as Scala components.
import me.shadaj.slinky.core.annotations.react
import me.shadaj.slinky.core.ExternalComponent
@react object React3 extends ExternalComponent {
case class Props(mainCamera: String, width: Int, height: Int,
onAnimate: Option[() => Unit] = None, alpha: Boolean = false)
override val component: js.Object = js.Dynamic.global.React3.asInstanceOf[js.Object]
}
this makes it possible to construct the external component as
React3(mainCamera = "camera", width = 800, height = 800)