https://github.com/erikras/redux-form-material-ui

A set of wrapper components to facilitate using Material UI with Redux Form
https://github.com/erikras/redux-form-material-ui

Last synced: about 2 hours ago
JSON representation

A set of wrapper components to facilitate using Material UI with Redux Form

• Host: GitHub
• URL: https://github.com/erikras/redux-form-material-ui
• Owner: erikras
• License: mit
• Created: 2016-05-23T23:25:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T08:23:25.000Z (almost 2 years ago)
• Last Synced: 2024-05-05T09:42:26.163Z (7 months ago)
• Language: JavaScript
• Homepage: http://erikras.github.io/redux-form-material-ui/
• Size: 7.18 MB
• Stars: 831
• Watchers: 19
• Forks: 228
• Open Issues: 74
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-material-ui - Redux-Form-Material-UI - Wrapper components to facilitate using Material-UI with Redux Form. (Components)
• awesome-redux - redux-form-material-ui - Set of wrapper components to facilitate using Material UI with Redux Form. (React Integration / Side Effects)

README

        
---

# redux-form-material-ui

---

[![NPM Version](https://img.shields.io/npm/v/redux-form-material-ui.svg?style=flat-square)](https://www.npmjs.com/package/redux-form-material-ui)

[![NPM Downloads](https://img.shields.io/npm/dm/redux-form-material-ui.svg?style=flat-square)](https://www.npmjs.com/package/redux-form-material-ui)

[![Build Status](https://img.shields.io/travis/erikras/redux-form-material-ui/master.svg?style=flat-square)](https://travis-ci.org/erikras/redux-form-material-ui)

[![codecov.io](https://codecov.io/github/erikras/redux-form-material-ui/coverage.svg?branch=master)](https://codecov.io/github/erikras/redux-form-material-ui?branch=master)

[![CDNJS version](https://img.shields.io/cdnjs/v/redux-form-material-ui.svg)](https://cdnjs.com/libraries/redux-form-material-ui)

### For [`material-ui`](https://github.com/callemall/material-ui) v1-beta support see [5.0](https://github.com/erikras/redux-form-material-ui/tree/5.0) Documentation.

[`redux-form-material-ui`](https://github.com/erikras/redux-form-material-ui) is a set of

wrappers to facilitate the use of

[`material-ui`](https://github.com/callemall/material-ui) components with

[`redux-form`](https://github.com/erikras/redux-form).

---

## [Live Demo](http://erikras.github.io/redux-form-material-ui/) :eyes:

## Installation

Using [npm](https://www.npmjs.org/):

```bash

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

```

## Available Components

* [AutoComplete](http://www.material-ui.com/#/components/auto-complete)

* [Checkbox](http://www.material-ui.com/#/components/checkbox)

* [TimePicker](http://www.material-ui.com/#/components/time-picker)

* [DatePicker](http://www.material-ui.com/#/components/date-picker)

* [RadioButtonGroup](http://www.material-ui.com/#/components/radio-button)

* [SelectField](http://www.material-ui.com/#/components/select-field)

* [Slider](http://www.material-ui.com/#/components/slider)

* [TextField](http://www.material-ui.com/#/components/text-field)

* [Toggle](http://www.material-ui.com/#/components/toggle)

## 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`.

```js

import { reduxForm, Field } from 'redux-form'

import MenuItem from 'material-ui/MenuItem'

import { RadioButton } from 'material-ui/RadioButton'

import {

  Checkbox,

  RadioButtonGroup,

  SelectField,

  TextField,

  Toggle,

  DatePicker

} from 'redux-form-material-ui'

class MyForm extends Component {

  render() {

    return (

      

        

        

          

          

          

        

        

        

        

        

          

          

          

        

      

    )

  }

}

// 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:

```js

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.

```js

render() {

  return (

    

      ...

      

      ...

    

  )

}

```