An adapter between Redux Form and Material UI components


836721.0.0-beta.64 years ago4 years agoMinified + gzip package size for @gfpacheco/redux-form-material-ui in KB



NPM Version NPM Downloads Build Status codecov.io CDNJS version

redux-form-material-ui is a set of wrappers to facilitate the use of material-ui components with redux-form.

Live Demo :eyes:


Using npm:

  $ npm install --save redux-form-material-ui

Available Components


Rather than import your component class from material-ui, import it from redux-form-material-ui and then pass the component class directly to the component prop of Field.

import { reduxForm, Field } from 'redux-form'
import MenuItem from 'material-ui/MenuItem'
import { RadioButton } from 'material-ui/RadioButton'
import {
} from 'redux-form-material-ui'

class MyForm extends Component {
  render() {
    return (
        <Field name="username" component={TextField} hintText="Street"/>

        <Field name="plan" component={SelectField} hintText="Select a plan">
          <MenuItem value="monthly" primaryText="Monthly"/>
          <MenuItem value="yearly" primaryText="Yearly"/>
          <MenuItem value="lifetime" primaryText="Lifetime"/>

        <Field name="agreeToTerms" component={Checkbox} label="Agree to terms?"/>
        <Field name="eventDate" component={DatePicker} format={null} hintText="What day is the event?"/>

        <Field name="receiveEmails" component={Toggle} label="Please spam me!"/>

        <Field name="bestFramework" component={RadioButtonGroup}>
          <RadioButton value="react" label="React"/>
          <RadioButton value="angular" label="Angular"/>
          <RadioButton value="ember" label="Ember"/>

// Decorate with redux-form
MyForm = reduxForm({
  form: 'myForm'

export default MyForm

No Default Values

Because of the strict "controlled component" nature of redux-form, some of the Material UI functionality related to defaulting of values has been disabled e.g. defaultValue, defaultDate, defaultTime, defaultToggled, defaultChecked, etc. If you need a field to be initialized to a certain state, you should use the initialValues API of redux-form.

Instance API


Returns a reference to the Material UI component that has been rendered. This is useful for calling instance methods on the Material UI components. For example, if you wanted to focus on the username element when your form mounts, you could do:

componentWillMount() {
  this.refs.firstField      // the Field
    .getRenderedComponent() // on Field, returns ReduxFormMaterialUITextField
    .getRenderedComponent() // on ReduxFormMaterialUITextField, returns TextField
    .focus()                // on TextField

as long as you specified a ref and withRef on your Field component.

render() {
  return (
      <Field name="username" component={TextField} withRef ref="firstField"/>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.