Skip to main content

Modules

Naming

rescript-material-ui provides all components in individual files. The file pattern is:

Mui.[COMPONENT_NAME].res

If you wish to use the Typography component for example, it would look like this:

<Mui.Typography>
{"Some example text"->React.string}
</Mui.Typography>

The component names map one to one to the ones found in the Component API section of the MUI documentation.

Global module

With version 3.0.0, this library switched to the ReScript namespace Mui which replaces the previous MaterialUi module.

For convenience, the Mui module includes a few special modules, which will be discussed later. To avoid name clashes, we suggest you stick to typing out Mui.[COMPONENT_NAME] instead of using open.

@react.component
let make = () =>
<div>
<Mui.Typography variant=#h4 gutterBottom=true>
{"Headline"->React.string}
</Mui.Typography>
<Mui.Typography>
{"Some example text"->React.string}
</Mui.Typography>
</div>

Special modules

The Mui namespace contains the following special modules: