This library uses Unform + Material UI styles to create super beautiful forms easily.
- Support all Material UI components;
- Better docs;
Just add unform to your project:
yarn add unform-material-ui @rocketseat/unform @material-ui/core
⚠️ This is a library that depends on Unform and Material UI to work, both must be installed in your project.
- Here's how to use the Unform library here
- Here's how to se up the Material UI here
️️
⚠️ For now, all components of the Material UI are not yet supported. Below are just the supported components.
The <TextField /> component, is similar to the default component <Input />. See the component documentation here for more information.
import React from 'react';
import { Form } from '@rocketseat/unform';
import { TextField } from 'unform-material-ui';
function App() {
function handleSubmit(data) {}
return (
<Form onSubmit={handleSubmit}>
<TextField name="name" />
<TextField multiline name="bio" />
<button type="submit">Send</button>
</Form>
);
}The <Select /> component, is similar to the default component <Select />. See the component documentation here for more information.
import React from 'react';
import { Form } from '@rocketseat/unform';
import { Select } from 'unform-material-ui';
function App() {
function handleSubmit(data) {
/**
* {
* "tech": ['node'],
* "country": "brazil"
* }
*/
}
return (
<Form onSubmit={handleSubmit}>
<Select multiple name="tech" options={[
{ value: 'node', label: 'NodeJS' },
{ value: 'react', label: 'React' },
]} />
<Select name="country" label="Country" options={[
{ value: 'brazil', label: 'Brazil' },
]} />
<button type="submit">Send</button>
</Form>
);
}The <Checkbox /> component, is similar to the default component <Checkbox />. See the component documentation here for more information.
ℹ️ Because of component nature, he is not completely "not controlled" all the time. Internally he becomes a controlled component when passed a property
checkedas true.
import React from 'react';
import { Form } from '@rocketseat/unform';
import { Checkbox } from 'unform-material-ui';
function App() {
function handleSubmit(data) {
/**
* {
* "terms": true,
* "acceptEmails": true
* }
*/
}
return (
<Form onSubmit={handleSubmit}>
{/* not controlled */}
<Checkbox name="terms" label="Terms & Conditions" />
{/* internally controlled */}
<Checkbox name="acceptEmails" label="I accept to receive promotional emails" checked />
<button type="submit">Send</button>
</Form>
);
}Thanks for being interested on making this package better. We encourage everyone to help improving this project with some new features, bug fixes and performance issues. Please take a little bit of your time to read our guides, so this process can be faster and easier.
Take a moment to read about our Contribution Guidelines so you can understand how to submit an issue, commit and create pull requests.
We expect you to follow our Code of Conduct. You can read it to understand what kind of behaviour will and will not be tolerated.
MIT © Italo Izaac