Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.83 KB

README.md

File metadata and controls

58 lines (38 loc) · 2.83 KB
Raw

ReScript Bindings for MUI

Installation

  1. Install all necessary packages according to the official MUI-Material installation guide: https://mui.com/material-ui/getting-started/installation/.
  2. Install @rescript-mui/material
npm install @rescript-mui/material
  1. Add it to dependencies in your rescript.json:
{
  "bs-dependencies": ["@rescript-mui/material"]
}

This library provides ReScript bindings for MUI.

These bindings will only work with ReScript 11 (uncurried mode) and JSX version 4, as it enables us to utilize untagged variants, optional record fields, and record props spread. The latter is especially important, as we are finally able to inherit props from one component to another more easily.

What happened to the bindings for Material-UI 4?

They are still available, check out the old website: https://rescript-material-ui.cca.io/.

Why no new website?

  1. One of the goals of this rewrite is to make the usage of MUI in ReScript more accessible. In the best case you never need to leave your editor, since now we have doc comments for (almost) every property.
  2. It just takes too much time to maintain.
  3. In our opinion, it is much more useful (albeit not as pretty) to just have a look at the examples folder.

What's inside?

MUI package ReScript bindings package Namespace Progress
@mui/material @rescript-mui/material Mui 100 %
@mui/lab @rescript-mui/lab MuiLab 100 %
@mui/x-date-pickers @rescript-mui/x-date-pickers MuiXDatePickers 30 %
@mui/system @rescript-mui/system MuiSystem 0 %
@mui/base Not implemented! MuiBase (?) -
@mui/joy Not implemented! Joy (?) -
@mui/x-data-grid Not implemented! MuiXDataGrid (?) -

NOTE: @mui/styles will never be implemented, as it is the legacy styling solution which is not compatible with React.StrictMode or React 18.

Documentation

See documentation.

Changelog

See CHANGELOG.

Contributing

See CONTRIBUTING.