Skip to content
Slinky wrappers around https://www.styled-components.com
Scala Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
project
src
.gitignore
.travis.yml
README.md
build.sbt
publish.sbt
publish.sh
secrets.tar.enc

README.md

slinky-styled-components

use styled-components from Slinky apps!

Getting Started

Add the library to your build and styled-components for Webpack bundling:

libraryDependencies += "me.shadaj" %%% "slinky-styled-components" % "0.1.0"

npmDependencies += "styled-components" -> "3.4.10"

Creating Components

Let's see how to create styled components with a simple example of a colored button:

import slinky.styledcomponents._

val styledButton = styled.button(
  css"""
    color: green;
  """
)

We can then use this in our app just like a regular component:

div(
  styledButton(id := "my-button")(
    "Hello World!"
  )
)

If we want to calculate styles based on some dynamic data, we can use props:

case class StyledButtonProps(color: String)
val styledButtonDynamicData = styled.button(
  css"""
    color: ${p: Props => p.color}
  """
)

div(
  styledButtonDynamicData(StyledButtonProps("pink"))(
    "Hello, this button is pink!"
  )
)

Extending Components

You can extend existing components with additional styles. For example, you could extend a styled button with more CSS:

case class Props(color: String)

val baseStyled = styled.button(
  css"""
    border-radius: 3px;
    color: ${p: Props => p.color};
  """
)

val extendedStyled = styled(baseStyled)(
  css"""
    font-size: 10px;
    background-color: ${p: Props => p.color}
  """
)

You can also extend Slinky components to assign them more styles, with the requirement that the component must take a className prop.

@react class IntHeaderComponent extends StatelessComponent {
  case class Props(number: Int, className: String = "")

  override def render(): ReactElement = {
    h1(className := props.className)(props.number.toString)
  }
}

// ...

val styledIntHeader = styled(IntHeaderComponent).apply[IntHeaderComponent.Props](
  css"""
    color: green;
  """
)

// ...

styledIntHeader(IntHeaderComponent.Props(123))

CSS Animations

The key feature of styled-components is the ability to use all CSS features, even ones like CSS animations. To build an animation that uses key frames, you can use the keyframes string interpolator.

val fadeIn = keyframes"""
  0% {
    opacity: 0;
  }
  100% {
    opacity: 1;
  }
"""

val fadedButton = styled.button(
  css"""
    animation: 1s $fadeIn ease-out;
  """
)

CSS Fragments

You can store css interpolations as variables and reuse them across multiple components. For example, you can use a shared color styling fragment.

val colorCSS = css"color: pink"
val styledButton = styled.button(
  css"""
    border-radius: 3px;
    $colorCSS
  """
)

val styledDiv = styled.div(
  css"""
    border-radius: 10px;
    $colorCSS
  """
)
You can’t perform that action at this time.