@react-md/icon
Advanced tools
This package is for including icons within react-md. There is included support for both font icons and SVG icons. There is also a helper component for applying spacing between icons and text.
Create icons using a font-icon library like material-icons or font-awesome or plain old accessible SVG icons. There are also a few additional helpers to creating animating rotating icons and separating text from an icon.
npm install --save @react-md/icon
It is also recommended to install the other packages if you have not done so:
npm install --save @react-md/theme @react-md/typography
If you would like to have access to all material icons as existing components
instead of having to manually remember the correct children to provide or the
correct path, you can install the @react-md/material-icons package. This
will include all material icons as font and SVGs.
You should check out the full documentation for live examples and more customization information, but an example usage is shown below.
Even though the FontIcon and SVGIcon components are the "main" exports for
this package, they are more utility components and probably won't be used much
once you set up your own icon system. The real exports are going to be the
TextIconSpacing and IconRotator components.
The TextIconSpacing component is used to add spacing between an icon and some
"text" where the text can be any renderable element. The IconRotator is used
to animate an icon rotation such as expander or collapse icons.
import { render } from "react-dom";
import { FontIcon, TextIconSpacing } from "@react-md/icon";
import { Typography } from "@react-md/typography";
// the Typography component is optional, it'll just add better typography
// than normal text.
const App = () => (
<>
// creates an icon spaced before the "Go Home" text
<TextIconSpacing icon={<FontIcon>home</FontIcon>}>
<Typography>Go Home</Typography>
</TextIconSpacing>
// creates an icon spaced after the "Go Home" text
<TextIconSpacing icon={<FontIcon>home</FontIcon>} iconAfter>
<Typography>Go Home</Typography>
</TextIconSpacing>
// it can also be combined
<TextIconSpacing icon={<FontIcon>arrow_back</FontIcon>}>
<TextIconSpacing icon={<FontIcon>home</FontIcon>} iconAfter>
<Typography>Go Home</Typography>
</TextIconSpacing>
</TextIconSpacing>
</>
);
render(<App />, document.getElementById("root"));
This package's icon component usage is really only helpful when generating icon
components through an external script or using font icons. However, here are a
few examples of using the FontIcon and SVGIcon components:
import { render } from "react-dom";
import { FontIcon, SVGIcon } from "@react-md/icon";
// When using font icons, you'll need to make sure they icon fonts have been
// correctly included in your app. Check out the documentation site for more
// info
const App = () => (
<>
<FontIcon>home</FontIcon>
<FontIcon iconClassName="fa fa-github" aria-label="Github" />
<SVGIcon title="Face">
<path d="M9 11.75c-.69 0-1.25.56-1.25 1.25s.56 1.25 1.25 1.25 1.25-.56 1.25-1.25-.56-1.25-1.25-1.25zm6 0c-.69 0-1.25.56-1.25 1.25s.56 1.25 1.25 1.25 1.25-.56 1.25-1.25-.56-1.25-1.25-1.25zM12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.41 0-8-3.59-8-8 0-.29.02-.58.05-.86 2.36-1.05 4.23-2.98 5.21-5.37C11.07 8.33 14.05 10 17.42 10c.78 0 1.53-.09 2.25-.26.21.71.33 1.47.33 2.26 0 4.41-3.59 8-8 8z" />
</SVGIcon>
</>
);
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 including icons within react-md. There is included support for both font icons and SVG icons. There is also a helper component for applying spacing between icons and text.
The npm package @react-md/icon receives a total of 3,494 weekly downloads. As such, @react-md/icon popularity was classified as popular.
We found that @react-md/icon 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
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."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.