rmcw v0.2.0

Use

import { Button } from "rmcw";

function MyComponent() {
  return <Button />;
}

What's the library for?

This library provide react wrapper for material design components.

What's different between other wrapper library?

Under this library, the mdc's stats only follow react stats. This mean the mdc's stats would not change until react stats change. This library always sync the react stats and the mdc stats. (By default, mdc usually modify the element's stats automatically that make the mdc element out of control in react framework)

For example:

const [open, setOpen] = React.useState(false);

<Dialog open={open}>{children}</Dialog>;

The dialog would be open when open is true and closed when open is false. And when user click the scrim, this library just only invoke onScrimClick callback and do nothing (dialog will keep open if open is true after click). No one can force you to close the dialog on fixed callback in the library (for example, in rmwc library if you don't close dialog in onClose callback, your react state will out of sync with mwc and component behave will be unpredictable).

If programmer want to close dialog when user click the scrim, the only way is:

const [open, setOpen] = React.useState(false);

<Dialog open={open} onScrimClick={() => setOpen(false)}>
  {children}
</Dialog>;

This library will block most of mdc default behave that keep the dom state sync with react state. Including some input element, the state will keep sync without call Event.preventDefault() conditionally (Checkbox, Radio and etc).

But TextArea and TextField still keep normal react input control style. Use Event.preventDefault() to prevent state change conditionally.

Compatible with React 18

You can enable StrictMode without error or warning message whatever you want. No legacy api use.

Demo

Clone the repo and run the command

npm i
npm run storybook

Components

• Banner
• Button
• Card
• Checkbox
• Chip
• CircularProgress
• DataTable
• Dialog
• Drawer
• Elevation
• Fab
• Icon
• IconButton
• LinearProgress
• ListDivider
• ListItem
• Menu
• Radio
• Ripple
• SegmentedButton
• Select
• Slider
• Snackbar
• Switch
• Tab
• TabBar
• TextArea
• TextField
• Tooltip
• TopAppBar
• Typography

Additional Components

• Theme (Unified theme settings and better dark theme support)

function ThemeSwitch() {
  /// false: force light theme
  /// true: force dark theme
  /// undefined: automatically (state from 'window.matchMedia('(prefers-color-scheme: dark)')')
  const [enableDarkTheme, setEnableDarkTheme] = React.useState(undefined);
  return <Theme enableDarkTheme={enableDarkTheme}>{myComponent}</Theme>;
}

Development requirement

If you use webpack, it require sass loader to pack .scss file into project (the project that come from "create-react-app" script already have sass loader).

If you use vite, nothing is required to do.