https://github.com/scommons/scommons-material-ui

Scala.js facades for material-ui components
https://github.com/scommons/scommons-material-ui

code-generation doctrine material-ui react react-docgen reactjs scalajs

Last synced: 5 days ago
JSON representation

Scala.js facades for material-ui components

• Host: GitHub
• URL: https://github.com/scommons/scommons-material-ui
• Owner: scommons
• License: mit
• Created: 2021-08-29T13:06:14.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-09T14:25:25.000Z (8 months ago)
• Last Synced: 2024-03-19T15:03:22.249Z (8 months ago)
• Topics: code-generation, doctrine, material-ui, react, react-docgen, reactjs, scalajs
• Language: Scala
• Homepage:
• Size: 293 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        

[![CI](https://github.com/scommons/scommons-material-ui/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/scommons/scommons-material-ui/actions/workflows/ci.yml?query=workflow%3Aci+branch%3Amaster)

[![Coverage Status](https://coveralls.io/repos/github/scommons/scommons-material-ui/badge.svg?branch=master)](https://coveralls.io/github/scommons/scommons-material-ui/?branch=master)

[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.8.0.svg)](https://www.scala-js.org)

## Scala Commons Material UI

Scala.js facades for [Material-UI (v4)](https://v4.mui.com/getting-started/usage/) components and APIs.

It uses common [scalajs-reactjs](https://github.com/shogowada/scalajs-reactjs) binding/facade library.

### How to add it to your project

```scala

val scommonsMaterialUiVer = "1.0.0-SNAPSHOT"

libraryDependencies ++= Seq(

  "org.scommons.material-ui" %%% "scommons-material-ui-core" % scommonsMaterialUiVer,

  

  // mocks of native Components and APIs

  "org.scommons.material-ui" %%% "scommons-material-ui-test" % scommonsMaterialUiVer % "test"

)

```

Latest `SNAPSHOT` version is published to [Sonatype Repo](https://oss.sonatype.org/content/repositories/snapshots/org/scommons/), just make sure you added

the proper dependency resolver to your `build.sbt` settings:

```scala

resolvers += "Sonatype Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots/"

```

### Quick Start

```scala

import io.github.shogowada.scalajs.reactjs.ReactDOM

import org.scalajs.dom

import scommons.materialui._

import scommons.materialui.styles._

import scommons.react._

object App extends FunctionComponent[Unit] {

  protected def render(compProps: Props): ReactElement = {

    <.Button(^.variant := "contained", ^.color := "primary")(

      "Hello World"

    )

  }

}

object AppMain {

  def main(args: Array[String]): Unit = {

    val mountNode = dom.document.getElementById("root")

    dom.document.title = "Demo material-ui app"

    ReactDOM.render(<(App()).empty, mountNode)

  }

}

```

### Components Demos

Please, see [README.md in showcase](showcase/README.md) sub-folder

for how to build and run showcase app locally.

* [Button](https://v4.mui.com/components/buttons/) => [demos](showcase/src/main/scala/scommons/materialui/showcase/button) => [tests](showcase/src/test/scala/scommons/materialui/showcase/button)

* ...TBD