@react-md/form
Advanced tools
@react-md/form - npm Package Versions
Changelog
5.1.3 (2022-05-07)
Bug Fixes
- @react-md/button: do not shrink in flex containers (66bf6e0)
- @react-md/card: fix spelling of raisable and deprecate raiseable prop (453023b)
- @react-md/form: fix typo for transparent in disabled toggle hover color (7346587)
- @react-md/layout: fix spelling of
DEFAULT_LAYOUT_NAV_TOGGLE_CLASSNAMES(2d20a2e) - @react-md/utils: fix spelling of DropzoneHandlers (6ba510b)
Documentation
- fix typos throughout codebase (725d1a2)
- @react-md/form: Add simple examples for Select/NativeSelect (05358f5), closes #1396
Other Internal Changes
Changelog
5.1.2 (2022-04-02)
Bug Fixes
Other Internal Changes
- @react-md/layout: Update snapshots after updating tree component (ec84800)
- @react-md/utils: Update keyboard movement (71d1343)
- react-md.dev:
useIsomorphicLayoutEffectto hide SSR warning (aa0d3cd) - react-md.dev: Fix
BadgedButtondocumentation (b147a88) - react-md.dev: Update Light/Dark Theme Toggle Icons (60a8825)
- react-md.dev: useLayoutEffect for page transitions (638c8ec)
Changelog
5.1.0 (2022-03-18)
Bug Fixes
- @react-md/app-bar:
AppBarTitlenow appliesflex: 1 1 auto(4a47c92) - @react-md/tooltip: Tooltips stay visible on mobile Firefox (7039fef)
Features
- @react-md/menu: Provide props for Menu's
List(2b5fb23) - @react-md/tooltip:
useTooltipsupports new disabled option (a934ae9)
Documentation
Other Internal Changes
- removed old
eslintrules (88eb2b2) - run lint-scripts --fix for consistent-type-imports (42d839d)
- Updated the v5.0.0 release notes (6106751)
- @react-md/dev-utils: Fix indexer for consistent-type-imports (2d2d1e9)
- @react-md/form: bump nanoid from 3.2.0 to 3.3.1 (e625488)
- react-md.dev: Add demo for rendering DropdownMenus as a
Grid(3ac42ef) - react-md.dev: Do not lazy load icons through next/head (47ccc1d)
- react-md.dev: Fix 404 page for sandboxes (4772c88)
- react-md.dev: Fix tooltip dense demo (efc7f8c)
- react-md.dev: Fix usage of
useTooltipwhen it is conditionally applied (cfca184) - react-md.dev: Update examples for
useTooltipdisabled option (f318ecf) - stylelint: bump
stylelintplugins to latest (2bb6429)
Changelog
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:
Hoverable Menus
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.
Conditionally Rendering Menus within a Sheet
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:
- Adding
menuConfiguration={{ renderAsSheet: "phone" }}on theConfigurationcomponent from@react-md/layout - Wrapping a
DropdownMenuin theMenuConfigurationProviderand adding a proprenderAsSheet="phone" - Directly on a
DropdownMenuwith therenderAsSheet="phone"prop
The 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.
Bug Fixes
- @react-md/form:
TextAreaapplies custom height style whenresize="none"(e77d939) - @react-md/list: Pass
disableEnterClickinListItem(b5e8b69) - @react-md/overlay: Allow for custom onClick behavior (60dce54)
- @react-md/transition: Do not create styles for hidden elements (6eff8a8)
- @react-md/typography: Fixed overline class name (1e544d0)
- @react-md/utils:
useRefCachereturns non-mutable object (b696b72) - @react-md/utils: Positioning logic for inner-left/inner-right and vertical anchors (a38abfb)
Features
- @react-md/dialog: Add new
overlayPropsto configure the dialog's overlay (cfc30f0) - @react-md/divider: Update
useVerticalDividerHeightto support any HTMLElement (edd9287) - @react-md/divider: Update divider styles for non-hr elements (7ccd0a6)
- @react-md/form: Update
TextFieldContainerto optionally fill all space in flex containers (2c8e68c) - @react-md/list: Created rmd-list-unstyled utility class from the mixin (6c9b7f4)
- @react-md/menu: Implemented new Menu API (c27bf55)
- @react-md/menu: Better floating action button default behavior (0cdeff7)
- @react-md/utils: export focusable query constants (f9f7955)
- @react-md/utils: Implemented new keyboard focus behavior (77f0d01)
- @react-md/utils: Updated the HoverMode API (ac60bdb)
Documentation
- Added documentation for using a GitHub template to bootstrap a new project (aac11ba)
- Removed Working with v1 documentation (8aa71ac)
- @react-md/sheet: Move tsdoc around for easier sharing (83fcaac)
- react-md.dev: Better migration guide search behavior (9729269)
- react-md.dev: Disable TOCs in dev mode and use temporary layout (3203af4)
- react-md.dev: Fixed weird dev error with spreading props and key (7cd7b8c)
Other Internal Changes
- Removed commitizen since I never use it (3e738b4)
- @react-md/form: Updated
FileInputsnapshots for new icon (f5e43fe) - @react-md/icon: Renamed the download icon to upload (2752a98)
- @react-md/icon: Updated docs and examples to use ConfiguredIcons type (bbfebed)
- @react-md/menu: Added tests for the new menu API and fixed a few issues (7202dd0)
- @react-md/menu: Fixed
MenuBarvisibility for touch devices (1288be7) - @react-md/menu: Fixed keyboard movement in MenuBars with visible menus (5b2494a)
- @react-md/utils: Export
enableScrollLockanddisableScrollLockutils (6a95734) - @react-md/utils: Remove touch utils and passive events checks (3597d32)
- @react-md/utils: useScrollListener no longer accepts an element or options (74a0274)
- examples: bump
nextfrom 12.0.7 to 12.0.9 (04749c6) - examples: Updated
create-react-appexamples to use v5.0.0 (f7850b8) - examples: Updated gatsby examples to v4.4.0 (8a12699)
- react-md.dev: Add migration guides for
react-mdmajor versions (78b7396) - react-md.dev: Add word-break to headings for markdown pages (03b1301)
- react-md.dev: Fixed ids for emulated phones (10984f5)
- react-md.dev: Suppress hydration for markdown (8bb4d51)
- react-md.dev: Update HoverableMenus example to not use
TextArea(5361825) - react-md.dev: Updated a few menu demos (c43cd31)
Breaking Changes
DEFAULT_HOVER_MODE_STICKY_EXIT_TIMEhas been renamed toDEFAULT_HOVER_MODE_EXIT_TIME.- Menu buttons will no longer open by pressing the
ArrowUporArrowDownkeys. - The
DropdownMenucomponent no longer accepts a list ofitemsand instead thechildrenshould be theMenuItemcomponents. - The
DropdownMenucomponent no longer supports themenuRendereranditemRendererprops. Instead, there is built-in support for conditionally rendering as aSheetcomponent using therenderAsSheetprop. - The
DropdownMenucomponent now requires a parentAppSizeListenerbecause of the conditionalSheetrendering functionality. This might require updating your tests to either use theConfigurationcomponent from@react-md/layout(recommended) or adding theAppSizeListenerto tests that includeDropdownMenus. - The
DropdownMenuItemcomponent is no longer required for nested dropdown menus and is an "internal" component instead that shouldn't really be used. - The
exitVisibilityDelayalways defaults toDEFAULT_HOVER_MODE_EXIT_TIME. - The
MenuItemSeparatornow renders as an<li>instead of an<hr>or<div>. - The
useContextMenunow returns an object instead of an ordered list. - The
useHoverModehook no longer accepts anHTMLElementgeneric and instead the event handlers will automatically infer theHTMLElementbased on usage. - The
useHoverModehook no longer returnsstickyHandlersand instead returnshoverHandlersthat only includeonMouseEnterandonMouseLeave. Thehandlersthat are returned now includeonClick,onMouseEnter, andonMouseLeave. This was kind of what thestickyHandlerswas before. In addition, clicking an element no longer disabled the hover mode behavior. - The following typescript types have been removed:
HoverModeOnlyOptions,HoverModeOnlyReturnValue - Using any of the
MenuItemcomponents requires the<MenuKeyboardFocusProvider>to be mounted as a parent component which might affect tests. This will not break anything if you are using theDropdownMenuorMenucomponents.
Changelog
4.0.3 (2021-12-31)
Bug Fixes
- @react-md/icon:
FileInputdefault icon changed fromfile_downloadtofile_upload(174d1c1), closes #1325 - @react-md/table: Sortable Column Alignment (e447cc5), closes #1321
- @react-md/utils:
useIsUserInteractionModeget mode via context (b5f93ae), closes #1322 - examples: Updated
create-react-appREADME to use correct start command (37acdc3)
Other Internal Changes
Changelog
4.0.1 (2021-11-27)
Bug Fixes
- @react-md/form: Added fixes required for Concurrent Rendering (b4994f4)
- @react-md/layout: Added fixes required for Concurrent Rendering (c0b29a8)
- @react-md/menu: Added fixes required for Concurrent Rendering (05ec620)
- @react-md/sheet: Added fixes required for Concurrent Rendering (75663e4)
- @react-md/utils: Update
getPercentageto optionally not throw errors (ff8a1d6)
Documentation
- @react-md/transition: Fix transitionTo documentation to use useEffect (31a31da)