5.1.6 (2023-12-11)

Bug Fixes

• @react-md/chip: add overflow to support font icons (da44bbd), closes #1432
• select: port fixed positioning fixes back from v6.0.0 (feb9ec6), closes #1461

Documentation

• react-md.dev: update blog to include additional releases (b305882)

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

• @react-md/autocomplete: fix typos in utils tests (c0333cc)
• react-md.dev: correctly render escaped html in markdown (8a523cb)
• react-md.dev: fix text color for animating app bar (01ec1af)
• typos: fix additional typos throughout repo (ef20132)

5.1.2 (2022-04-02)

Bug Fixes

• @react-md/tabs: Scroll tabs correctly in RTL mode (a23d708), closes #1356

Other Internal Changes

• @react-md/layout: Update snapshots after updating tree component (ec84800)
• @react-md/utils: Update keyboard movement (71d1343)
• react-md.dev: useIsomorphicLayoutEffect to hide SSR warning (aa0d3cd)
• react-md.dev: Fix BadgedButton documentation (b147a88)
• react-md.dev: Update Light/Dark Theme Toggle Icons (60a8825)
• react-md.dev: useLayoutEffect for page transitions (638c8ec)

5.1.0 (2022-03-18)

Bug Fixes

• @react-md/app-bar: AppBarTitle now applies flex: 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: useTooltip supports new disabled option (a934ae9)

Documentation

• @react-md/tooltip: Remove documentation around Tooltipped component (1a59190), closes #1367

Other Internal Changes

• removed old eslint rules (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 useTooltip when it is conditionally applied (cfca184)
• react-md.dev: Update examples for useTooltip disabled option (f318ecf)
• stylelint: bump stylelint plugins to latest (2bb6429)

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 the Configuration component from @react-md/layout
• Wrapping a DropdownMenu in the MenuConfigurationProvider and adding a prop renderAsSheet="phone"
• Directly on a DropdownMenu with the renderAsSheet="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: TextArea applies custom height style when resize="none" (e77d939)
• @react-md/list: Pass disableEnterClick in ListItem (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: useRefCache returns non-mutable object (b696b72)
• @react-md/utils: Positioning logic for inner-left/inner-right and vertical anchors (a38abfb)

Features

• @react-md/dialog: Add new overlayProps to configure the dialog's overlay (cfc30f0)
• @react-md/divider: Update useVerticalDividerHeight to support any HTMLElement (edd9287)
• @react-md/divider: Update divider styles for non-hr elements (7ccd0a6)
• @react-md/form: Update TextFieldContainer to 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 FileInput snapshots 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 MenuBar visibility for touch devices (1288be7)
• @react-md/menu: Fixed keyboard movement in MenuBars with visible menus (5b2494a)
• @react-md/utils: Export enableScrollLock and disableScrollLock utils (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 next from 12.0.7 to 12.0.9 (04749c6)
• examples: Updated create-react-app examples to use v5.0.0 (f7850b8)
• examples: Updated gatsby examples to v4.4.0 (8a12699)
• react-md.dev: Add migration guides for react-md major 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_TIME has been renamed to DEFAULT_HOVER_MODE_EXIT_TIME.
• Menu buttons will no longer open by pressing the ArrowUp or ArrowDown keys.
• The DropdownMenu component no longer accepts a list of items and instead the children should be the MenuItem components.
• The 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.
• The 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.
• The DropdownMenuItem component is no longer required for nested dropdown menus and is an "internal" component instead that shouldn't really be used.
• The exitVisibilityDelay always defaults to DEFAULT_HOVER_MODE_EXIT_TIME.
• The MenuItemSeparator now renders as an <li> instead of an <hr> or <div>.
• The useContextMenu now returns an object instead of an ordered list.
• The useHoverMode hook no longer accepts an HTMLElement generic and instead the event handlers will automatically infer the HTMLElement based on usage.
• The 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.
• The following typescript types have been removed: HoverModeOnlyOptions, HoverModeOnlyReturnValue
• Using any of the MenuItem 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.

4.0.3 (2021-12-31)

Bug Fixes

• @react-md/icon: FileInput default icon changed from file_download to file_upload (174d1c1), closes #1325
• @react-md/table: Sortable Column Alignment (e447cc5), closes #1321
• @react-md/utils: useIsUserInteractionMode get mode via context (b5f93ae), closes #1322
• examples: Updated create-react-app README to use correct start command (37acdc3)

Other Internal Changes

• Update tests to use jest.mocked (4bb25fb)
• Updated all packages' peerDependenciesMeta (60fcd71), closes #1319
• @react-md/dev-utils: Update watch command for new sass modules (2e7a87a)
• examples: Update next to latest version (3521e9b)

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 getPercentage to optionally not throw errors (ff8a1d6)

Documentation

• @react-md/transition: Fix transitionTo documentation to use useEffect (31a31da)

Other Internal Changes

• Updated imports to use import type when possible (ba96bb6)
• react-md.dev: Fixed demo styles that included CodeBlock (1f1a04e)
• react-md.dev: Fixes for Concurrent Rendering (5946bd9)
• react-md.dev: Update order of previous docs links (87998b9)

4.0.0 (2021-11-24)

This release focused on updating the @react-md/transition package to no longer log errors in React.StrictMode because react-ransition-group was using ReactDOM.findDOMNode to handle transitions. All react-md packages will no longer use react-transition-group since all that functionality has been built into @react-md/transition with a slightly different API.

This release has also included my first attempt at automating upgrading to new major releases by introducing a new @react-md/codemod package that is similar to the react-codemod package. You can automate some of this release by running:

npx @react-md/codemod v3-to-v4/preset

Since I am still learning how to use jscodeshift, it will not be able to migrate everything but should still help with most changes.

Bug Fixes

• @react-md/menu: DropdownMenu and Menu portal by default (98a6a9f), closes #1264
• @react-md/tooltip: cancel timer when element is clicked (5416554)
• sass: Do not use legacy global functions (6159e16)

Features

• Update to use new JSX Transform and latest eslint (8111cd3)
• @react-md/portal: ConditionalPortal supports ReactNode children (c83d578)
• @react-md/transition: No longer use findDOMNode for transitions (cb952da)
• @react-md/typography: Renamed Text to Typography (30cf056)
• @react-md/utils: Export additional positioning types (b50a04c)
• codemod: Created a new @react-md/codemod package to help with new releases (41c1fa6)

Documentation

• Hackily fix codesandbox.io not using sass resolutions in package.json (db22cde), closes #1261
• @react-md/form: Updated hook overrides so documentation appears correctly (436fbff)
• react-md.dev: Enable rust compiler by removing custom babelrc (796efd0)
• react-md.dev: Fallback code language to markup instead of none (0efaf9b)
• react-md.dev: Fix alert sandboxes (8f19297)
• react-md.dev: Removed SwipeableTabs demo since it didn't really work (2d79f93)
• react-md.dev: Separate Code and CodeBlock into separate folders (4c492b3)
• react-md.dev: Try to allow custom Code/CodeBlock in sandboxes (5d494bf)
• react-md.dev: update code components to use css modules (9bdf6ba)
• react-md.dev: Use react-marked-renderer for markdown stuffs (93ebaa4)

Other Internal Changes

• always skip lib check (229cef1)
• Re-ran prettier (9632d82)
• update workflows to include node 16 (f756b92)
• updated branches for build, lint, and test (b5eeae9)
• Updated remaining docs and tests for react-router-dom v6 (e012ef9)
• @react-md/dev-utils: Added error message for combining styles (aa5ecfd)
• @react-md/dev-utils: match quotation marks for sass files (98ffe40)
• @react-md/dev-utils: Update sassdoc to not through uncaught exceptions (8bdf532)
• @react-md/dev-utils: Update release for new major versions and legacy docs (86c5c02)
• @react-md/format: ran prettier after upgrading to v2.4.0 (06110af)
• codemod: Added comment about ignoring CodeQL alert (631d56c)
• examples: enable strict mode by default for nextjs-typescript (83e4c44)
• examples: added lint command to nextjs examples (788a8b8)
• examples: bump nextjs examples from v11.1.2 to v12.0.2 (be45277)
• examples: fixed prefers-color-scheme in examples (f799d3a)
• examples: Updated create-react-app example to use react-router-dom v6 (3c4d1ea)
• examples: Updated create-react-app-typescript example to use react-router-dom v6 (ae469ef)
• examples: Updated examples to no longer import React (c0b8cb5)
• react-md: Remove prop-types package and usage (2637a6f)
• react-md.dev: Enable React.StrictMode (219937e)
• react-md.dev: Updated some transition documentation (44bfa20)
• stylelint: Updated to use stylelint (22d1598)
• test: Update coverage for watch mode (74cee51)
• typescript: Stopped using deprecated HTMLTable(Data|Header)CellElement (23ba342)

Breaking Changes

• Minimum React version is now 16.14 instead of 16.8
• @react-md/menu: The DropdownMenu and Menu components portal by default. This should really only affect snapshot tests
• @react-md/typography: The Text component has been renamed to Typography to help with auto-imports conflicting with the Text element that exists in lib.d.ts
• react-md: There will no longer be run-time prop validation with the prop-types package.

3.1.0 (2021-09-10)

Bug Fixes

• @react-md/dialog: DialogFooter align prop applies correct classes (644971d)
• @react-md/form: TooManyFilesError is only used if all the other validation has passed (6ed3f54)
• @react-md/form: ensure file names end with a period for useFileUpload extensions (9238140)
• @react-md/form: prevent infinite rerenders when calling useFileUpload's reset in useEffect (b2875b1)
• @react-md/utils: useDropzone fix around onDragLeave behavior (fdff9f2)
• typescript: updated all array types to be readonly (8f71bcb)

Features

• @react-md/form: add isValidFileName option to useFileUpload (dbd0375)
• @react-md/typography: override default typography without globals (ce89374), closes #1239

Documentation

• react-md.dev: updated sassdoc for new module system (4746d26)
• react-md.dev: updated SortableColumns example to import SortOrder type (b629e3e)

Other Internal Changes

• ran yarn format to include new files (48d3d7f)
• Simplifying format and covering json and yml files (#1227) (045ba5e)
• @react-md/dev-utils: fixed spelling of gzipped (baad174)
• examples: updated nextjs examples to latest version of next (b50d745)
• react-md.dev: added sassdoc hot-reloading (9d58e09)
• react-md.dev: updated sassdoc examples to be linkable (9ed096e)
• react-md.dev: Updated fonts for latest nextjs build optimizations (ca9ecbd)
• typescript: support typescript@v4.4.2 (5a9dd72)

3.0.0 (2021-08-13)

This release should be relatively simple for most consumers of this library since the main breaking change is dropping support for node-sass and requiring sass since node sass has been deprecated as well as removing deprecated variables, hooks, and components. Most users should be able to run the following commands to upgrade to v3.0.0:

npm update react-md
npm uninstall node-sass
npm install sass

Or with yarn

yarn add react-md
yarn remove node-sass
yarn add sass

In addition, there is now partial support for the new Sass module system with the react-md package which also simplifies the import usage and has a slight build performance improvement for large projects. To start using the new module system, update all the @import statements as shown below:

-@import '~@react-md/theme/dist/mixins';
-@import '~@react-md/utils/dist/mixins';
-// other react-md imports
+@use 'react-md' as *;

 // No other changes required!

If you override variables within react-md:

-@import '~@react-md/theme/dist/color-palette';
-$rmd-theme-light: false;
-$rmd-theme-primary: $rmd-purple-500;
-$rmd-theme-secondary: $rmd-pink-a-200;
-
-@import '~react-md/dist/styles';
+@use '@react-md/theme/dist/color-palette' as color;
+@use 'react-md' as * with (
+  $rmd-theme-light: false,
+  $rmd-theme-primary: color.$rmd-theme-purple-500,
+  $rmd-theme-secondary: color.$rmd-theme-pink-a-200,
+);
+
+@include react-md-utils;

Check out the updated customizing your theme documentation, #1214, or 958f34f for more in-depth examples.

BREAKING CHANGES

• @react-md/theme: $rmd-theme-dark-elevation now defaults to true instead of false
• sass: node-sass is no longer supported and users must switch to sass
• @react-md/utils: Removed InteractionModeListener since it was an alias for UserInteractionModeListener
• @react-md/utils: Removed ResizeObserver component and useResizeObserverV1 implementation
• @react-md/tooltip: Removed TooltipHoverModeConfig component
• @react-md/card: Removed deprecated $rmd-card-dark-elevation-bordered-background-color variable
• @react-md/tooltip: Removed deprecated props from Tooltipped component
• @react-md/form: The second argument for useIndeterminateChecked is now an object of options

Bug Fixes

• sass: drop node-sass in favor of sass since it's deprecated (126fb5a)
• sass: use math.div instead of division since it's deprecated (d8c3f12)

Features

• @react-md/theme: $rmd-theme-dark-elevation defaults to true (b371337)
• react-md: Simplify sass usage with: @use 'react-md'; (787bfb5)

Documentation

• react-md.dev: removed documentation around pre-compiling styles (29b5d74)
• react-md.dev: Update Sass Documentation for @use (68e8c6b)
• react-md.dev: Updated sandboxes for new Sass module system (095ae97)

Other Internal Changes

• Added additional tests to bump test coverage (4d0371c)
• @react-md/card: removed deprecated $rmd-card-dark-elevation-bordered-background-color variable (01c9350)
• @react-md/dev-utils: Added simple sass-migrator command (a8e8df3)
• @react-md/dev-utils: autoConfirm flag passed to initBlog (dec09b8)
• @react-md/dev-utils: Combine all scss files into react-md/dist/_everything.scss (c7177e6)
• @react-md/dev-utils: Update release script to hopefully work with prereleases (e0ef881)
• @react-md/dev-utils: updated sassdoc and variables to use everything.scss (a0f0699)
• @react-md/dev-utils: updated variables command to work with sass (5376be1)
• @react-md/form: removed deprecated implementation in useIndeterminateChecked (6b7871f)
• @react-md/tooltip: removed deprecated props from Tooltipped component (6dca9b1)
• @react-md/tooltip: removed TooltipHoverModeConfig component (664ec30)
• @react-md/utils: remove ResizeObserver component and useResizeObserverV1 implementation (6a6b109)
• @react-md/utils: removed InteractionModeListener alias (216c8ef)
• examples: updated examples to latest dependencies (f2eb07a)
• react-md.dev: Each package includes a link to typedoc API in navigation tree (c388ba6)
• react-md.dev: ran migrator for deprecated division (98d2c58)
• react-md.dev: removed tilde from imports (6081e14)
• react-md.dev: update all scss files for @use imports (958f34f)
• react-md.dev: update all styles to use react-md/dist/everything (2da5033)
• react-md.dev: Update links for previous versions (2d0a0e6)
• react-md.dev: updated docs for new rmd-theme-dark-elevation defaults (b2269ff)
• react-md.dev: updated examples to work with sass instead of node-sass (d8ddf51)
• react-md.dev: updated sandboxes to use root react-md (c0f25f7)