# redux-form-material-ui
> An adapter between Redux Form and Material UI components
Latest version **4.3.4** (published 2018-04-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install redux-form-material-ui
pnpm add redux-form-material-ui
yarn add redux-form-material-ui
bun add redux-form-material-ui
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 4.3.4 |
| Published | 2018-04-07 |
| First published | 2016-05-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 823 |
| Author | Erik Rasmussen |
| Maintainers | erikras, mihir |
| Keywords | redux, redux-form, material-ui, redux-form-material-ui, adapter |
## Links
- npm: https://www.npmjs.com/package/redux-form-material-ui
- Repository: https://github.com/erikras/redux-form-material-ui
- Issues: https://github.com/erikras/redux-form-material-ui/issues
- npm.io page: https://npm.io/package/redux-form-material-ui
## Alternatives
- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads
## Recent versions
- 4.3.4 (latest) — 2018-04-07
- 5.0.0-beta.3 (next) — 2018-05-25
- 4.3.3 — 2018-01-13
- 4.3.2 — 2018-01-07
- 4.3.1 — 2017-11-18
- 5.0.0-beta.2 — 2017-11-11
- 5.0.0-beta.1 — 2017-10-14
- 4.3.0 — 2017-09-20
- 4.2.0 — 2017-04-14
- 4.1.4 — 2017-04-14
- 4.1.3 — 2017-03-31
- 4.1.2 — 2016-12-09
- 4.1.1 — 2016-12-01
- 4.1.0 — 2016-10-03
- 4.0.1 — 2016-08-02
- … 8 more at https://npm.io/package/redux-form-material-ui/versions
## README
---
# redux-form-material-ui
---
[](https://www.npmjs.com/package/redux-form-material-ui)
[](https://www.npmjs.com/package/redux-form-material-ui)
[](https://travis-ci.org/erikras/redux-form-material-ui)
[](https://codecov.io/github/erikras/redux-form-material-ui?branch=master)
[](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 (
)
}
```
---
_Source: https://npm.io/package/redux-form-material-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._