@react-md/form
Advanced tools
Create material design form elements with a lot of customization. This package exports the following form components:
Form - A simple wrapper for a <form> element that just prevents default
submit behavior for convenienceFieldset - A simple wrapper for the <fieldset> element that removes some
of the default styles and integrates a <legend> that be be conditionally
rendered for screen readers onlyLabel - A <label> element that is also built-in to the majority of the
other form controlsFileInput - A wrapper for <input type="file" /> that gains the
<Button /> stylesNativeSelect - A wrapper for the native <select> element that updates the
select to have the same styles as a TextField. You are unable to style the
<option>s due to styling restrictionsSelect - A component that allows you to create an accessible listbox that
behaves like a native <select> element but also allows for additional
styling from the @react-md/list packageTextField - A styled <input type="text" /> that supports a few themes as
well as other input types. Note:Password - A wrapper for the TextField to render as a type="password"
that has built-in functionality to temporarily show the password to the user
with an inline visibility toggle buttonTextArea - A styled <texxtarea> that has a few themes and can animate the
height as the user typesCheckbox - A wrapper for an <input type="checkbox" />Radio - A wrapper for an <input type="radio" />Switch - A wrapper for an <input type="checkbox" /> that looks like a
toggleable switchAsyncSwitch - A wrapper for the Switch component that has built-in support
for displaying a circular progress in the Switch during asynchronous actionsFormMessage - A component that can be used to display accessible help and
error messages along with other form components that will be read out to
screen readers.This package also exports the following helper components and hooks:
useChecked - A simple hook that controls the checked state for the
Checkbox or Switch componentsuseIndeterminateChecked - A hook that can be used for checkbox groups with
an indeterminate stateuseChoice - A simple hook that can be used to control the state of a radio
group or select components while type-casting the value for Typescript users.
Note: This does not validate the value stringuseSelectState - A hook for Typescript users that type-casts the value.
Note: This does not validate the value stringFloatingLabel - A <label> element that can be used to animate a label out
of an <input type="text" /> or <textarea> if additional customization is
requiredListbox - A component that implements the
listbox widget specifications
with keyboard search and movement built-in.Option - A wrapper for the SimpleListItem from @react-md/list that
allows for additional styling and accessibility requirements for an "option"
roleTextFieldContainer - A styled <div> that is used for render the different
themesTextFieldAddon - A component that might not be used much externally, but it
can be used to gain the styles for the addons for a TextArea and TextField
(built-in)InputToggle - A component that is used to render either a "checkbox" or
"radio" elementToggleCotainer - A helper component that is used to wrap either a
"checkbox" or "radio" for additional stylesnpm install --save @react-md/form
It is also recommended to install the other packages if you have not done so:
npm install --save @react-md/theme \
@react-md/typography \
You should check out the full documentation for live examples and more customization information, but an example usage is shown below.
It is recommended to check out the documentation site for a better example, but here's a simple one that you should really not copy:
import { useState } from "react";
import { render } from "react-dom";
import { Button } from "@react-md/button";
import { Form, TextField, Password, useChecked } from "@react-md/form";
import { EmailSVGIcon, PasswordSVGIcon } from "@react-md/material-icons";
const App = () => {
const [email, setEmail] = useState("");
const [password, setPassword] = useState("");
const [rememberMe, setRememberMe] = useChecked(false);
const [errors, setErrors] = useState<readonly string[]>([]);
const handleSubmit = async () => {
const response = await fetch("/login", {
method: "POST",
headers: {
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({ email, password }),
});
const json = await response.json();
if (json.errors) {
setErrors(errors);
} else {
// do something
}
};
return (
<Form onSubmit={handleSubmit}>
<FormMessage id="errors" role="alert" error disableWrap>
{errors.length && (
<ul>
{errors.map((error) => (
<li key={error}>{error}</li>
))}
</ul>
)}
</FormMessage>
<TextField
aria-describedby="errors"
id="email"
label="Email"
type="email"
name="email"
value={email}
onChange={(event) => setEmail(event.currentTarget.value)}
required
leftAddon={<EmailSVGIcon />}
/>
<Password
aria-describedby="errors"
id="password"
label="Password"
name="password"
value={password}
onChange={(event) => setPassword(event.currentTarget.value)}
required
leftAddon={<PasswordSVGIcon />}
/>
<Checkbox
id="remember-me"
name="rememberMe"
label="Remember me?"
checked={rememberMe}
onChange={setRememberMe}
/>
<Button id="submit" type="submit">
Log in
</Button>
</Form>
);
};
render(<App />, document.getElementById("root"));
5.0.0 (2022-01-31)
Check out the v4 to v5 Migration Guide for more information around updating code to this major version.
This release focused on creating a new Menu API that should hopefully make menus easier to use along with some other new features. The main difference is that the DropdownMenu no longer accepts a list of items that get converted to MenuItems behind the scenes. Instead, the children of the DropdownMenu should be all the MenuItem components that should be used inside the menu. The main reason for this change is to make it easier to create reusable components for different actions within your app and no longer needed to disable the React eslint rule around missing keys.
Another notable change is that nested dropdown menus no longer require the DropdownMenuItem component and instead the DropdownMenu automatically renders as a <li> if it appears as a child of another Menu component.
Here's a quick example of migrating to the new DropdownMenu API:
import type { ReactElement } from "react";
-import { DropdownMenu, DropdownMenuItem } from "@react-md/menu";
+import { DropdownMenu, MenuItem } from "@react-md/menu";
export default function Example(): ReactElement (
- <DropdownMenu
- id="example-dropdown-menu"
- items={[
- { onClick: () => console.log("Clicked Item 1"), children: "Item 1" },
- { onClick: () => console.log("Clicked Item 2"), children: "Item 2" },
- { onClick: () => console.log("Clicked Item 3"), children: "Item 3" },
- <DropdownMenuItem
- id="nested-dropdown-menu"
- items={["Subitem 1", "Subitem 2", "Subitem 3"]}
- >
- Submenu
- </DropdownMenuItem>,
- ]}
- >
- Dropdown
+ <DropdownMenu id="example-dropdown-menu" buttonChildren="Dropdown">
+ <MenuItem onClick={() => console.log("Clicked Item 1")}>Item 1</MenuItem>
+ <MenuItem onClick={() => console.log("Clicked Item 2")}>Item 2</MenuItem>
+ <MenuItem onClick={() => console.log("Clicked Item 3")}>Item 3</MenuItem>
+ <DropdownMenu
+ id="nested-dropdown-menu"
+ buttonChildren="Submenu"
+ >
+ <MenuItem>Subitem 1</MenuItem>
+ <MenuItem>Subitem 2</MenuItem>
+ <MenuItem>Subitem 3</MenuItem>
+ </DropdownMenu>
</DropdownMenu>
);
On top of the new API, two major new features have been integrated into this release:
Menus can now act like a browser's bookmark folder behavior where the user must click one of the dropdowns before all other menus become immediately visible on hover by using the new MenuBar component. This also implements some new keyboard movement behavior matching the menubar spec.
If the first-click behavior is undesired, the MenuBar also accepts a hoverTimeout prop which can be set to 0 to make the menus appear immediately on hover or another time in milliseconds to wait before the "hover mode" behavior should begin.
Check out the Hoverable Menus demo for more information.
Since menus aren't always ideal for small viewports, the DropdownMenu has been updated to conditionally rendering the Menu within a Sheet instead of being positioned relative to the Button element. This feature is opt-in by either:
menuConfiguration={{ renderAsSheet: "phone" }} on the Configuration component from @react-md/layoutDropdownMenu in the MenuConfigurationProvider and adding a prop renderAsSheet="phone"DropdownMenu with the renderAsSheet="phone" propThe Sheet will default to rendering at the bottom of the viewport and have a max height that should allow the user to close the menu by clicking the overlay behind the sheet. These defaults can be configured with the sheetPosition and sheetVerticalSize props.
The Sheet can also be configured to have an optional header and footer using the sheetHeader and sheetFooter props. If all else fails, the DropdownMenu accepts sheetProps which will be passed to the Sheet component.
Check out the Mobile Action Sheets demo for more information.
TextArea applies custom height style when resize="none" (e77d939)disableEnterClick in ListItem (b5e8b69)useRefCache returns non-mutable object (b696b72)overlayProps to configure the dialog's overlay (cfc30f0)useVerticalDividerHeight to support any HTMLElement (edd9287)TextFieldContainer to optionally fill all space in flex containers (2c8e68c)FileInput snapshots for new icon (f5e43fe)MenuBar visibility for touch devices (1288be7)enableScrollLock and disableScrollLock utils (6a95734)next from 12.0.7 to 12.0.9 (04749c6)create-react-app examples to use v5.0.0 (f7850b8)react-md major versions (78b7396)TextArea (5361825)DEFAULT_HOVER_MODE_STICKY_EXIT_TIME has been renamed to DEFAULT_HOVER_MODE_EXIT_TIME.ArrowUp or ArrowDown keys.DropdownMenu component no longer accepts a list of items and instead the children should be the MenuItem components.DropdownMenu component no longer supports the menuRenderer and itemRenderer props. Instead, there is built-in support for conditionally rendering as a Sheet component using the renderAsSheet prop.DropdownMenu component now requires a parent AppSizeListener because of the conditional Sheet rendering functionality. This might require updating your tests to either use the Configuration component from @react-md/layout (recommended) or adding the AppSizeListener to tests that include DropdownMenus.DropdownMenuItem component is no longer required for nested dropdown menus and is an "internal" component instead that shouldn't really be used.exitVisibilityDelay always defaults to DEFAULT_HOVER_MODE_EXIT_TIME.MenuItemSeparator now renders as an <li> instead of an <hr> or <div>.useContextMenu now returns an object instead of an ordered list.useHoverMode hook no longer accepts an HTMLElement generic and instead the event handlers will automatically infer the HTMLElement based on usage.useHoverMode hook no longer returns stickyHandlers and instead returns hoverHandlers that only include onMouseEnter and onMouseLeave. The handlers that are returned now include onClick, onMouseEnter, and onMouseLeave. This was kind of what the stickyHandlers was before. In addition, clicking an element no longer disabled the hover mode behavior.HoverModeOnlyOptions, HoverModeOnlyReturnValueMenuItem components requires the <MenuKeyboardFocusProvider> to be mounted as a parent component which might affect tests. This will not break anything if you are using the DropdownMenu or Menu components.FAQs
This package is for creating all the different form input types.
The npm package @react-md/form receives a total of 1,892 weekly downloads. As such, @react-md/form popularity was classified as popular.
We found that @react-md/form demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."