@jcoreio/redux-form-material-ui

    5.0.0-beta.5 • Public • Published

    redux-form-material-ui


    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-uibeta components with redux-form.

    Latest version is supported by only for material-ui beta.


    Live Demo 👀

    Installation

    Using npm:

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

    Using yarn:

      $ yarn add redux-form-material-ui@next

    Available Components

    Usage

    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/core/MenuItem'
    import Radio from '@material-ui/core/RadioButton'
    import {
      Checkbox,
      RadioGroup,
      Select,
      TextField,
      Switch,
      FormControlLabel,
    } from 'redux-form-material-ui'
     
    class MyForm extends Component {
      render() {
        return (
          <form>
            <Field name="username" component={TextField} placeholder="Street"/>
     
            <Field name="plan" component={Select} placeholder="Select a plan">
              <MenuItem value="monthly">Monthly</MenuItem>
              <MenuItem value="yearly">Yearly</MenuItem>
              <MenuItem value="lifetime">Lifetime</MenuItem>
            </Field>
     
            <FormControlLabel control={<Field name="agreeToTerms" component={Checkbox} /> } label="Agree to terms?" />
     
          <FormControlLabel control={<Field name="receiveEmails" component={Switch} /> } label="Please spam me!" />
     
            <Field name="bestFramework" component={RadioGroup}>
              <Radio value="react" label="React"/>
              <Radio value="angular" label="Angular"/>
              <Radio value="ember" label="Ember"/>
            </Field>
          </form>
        )
      }
    }
     
    // Decorate with redux-form
    MyForm = reduxForm({
      form: 'myForm'
    })(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

    getRenderedComponent()

    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 (
        <form>
          ...
          <Field name="username" component={TextField} withRef ref="firstField"/>
          ...
        </form>
      )
    }

    Install

    npm i @jcoreio/redux-form-material-ui

    DownloadsWeekly Downloads

    81

    Version

    5.0.0-beta.5

    License

    MIT

    Unpacked Size

    2.07 MB

    Total Files

    37

    Last publish

    Collaborators

    • emily-stener
    • dsorensen
    • awinkler
    • mbrigdan
    • ngutzmann
    • jrmclaurin
    • jedwards1211
    • eladendorf
    • prudhvitella
    • brayden-arthur
    • rossjbartlett
    • anton.biryukov
    • etbci