@material/menu-surface
Advanced tools
Changelog
14.0.0 (2022-04-27)
unset is unsupported in IE. (f460e23)validateTooltipWithCaretDistances method. (3e30054)theme-styles mixin... the value being retreived from the $theme map and css property name was swapped. The mixin would request font-size/font-weight/letter-spacing from the $theme map (which expects size/weight/tracking)... so these values would always be null. (32b3913)attachTo. (05db65e)showTimeout is not set (indicating that this tooltip is about to be re-shown). (6ca8b8f)minRange param to range sliders to request a minimum gap between the two thumbs. (8fffcb5)valueToAriaValueTextFn and valueToValueIndicatorTextFn functions are called for. (b6510c8)PiperOrigin-RevId: 444830518
PiperOrigin-RevId: 419837612
Readme
The MDC Menu Surface component is a reusable surface that appears above the content of the page and can be positioned adjacent to an element. Menu Surfaces require JavaScript to properly position themselves when opening.
npm install @material/menu-surface
<div class="mdc-menu-surface">
...
</div>
@use "@material/menu-surface/mdc-menu-surface";
import {MDCMenuSurface} from '@material/menu-surface';
const menuSurface = new MDCMenuSurface(document.querySelector('.mdc-menu-surface'));
See Importing the JS component for more information on how to import JavaScript.
The menu surface can be positioned to automatically anchor to a parent element when opened.
<div id="toolbar" class="toolbar mdc-menu-surface--anchor">
<div class="mdc-menu-surface">
...
</div>
</div>
The menu surface can be positioned to automatically anchor to another element, by wrapping the other element with the anchor class.
<div class="mdc-menu-surface--anchor">
<button id="menu-surface-button">Open Menu Surface</button>
<div class="mdc-menu-surface">
...
</div>
</div>
The menu surface can use fixed positioning when being displayed.
<div class="mdc-menu-surface mdc-menu-surface--fixed">
...
</div>
Or in JS:
// ...
menuSurface.setFixedPosition(true);
The menu surface can use absolute positioning when being displayed. This requires that the element containing the
menu has the position: relative style.
<div class="mdc-menu-surface">
...
</div>
// ...
menuSurface.setAbsolutePosition(100, 100);
| CSS Class | Description |
|---|---|
mdc-menu-surface | Mandatory. |
mdc-menu-surface--animating-open | Indicates the menu surface is currently animating open. This class is removed once the animation completes. |
mdc-menu-surface--open | Indicates the menu surface is currently open, or is currently animating open. |
mdc-menu-surface--animating-closed | Indicates the menu surface is currently animating closed. This class is removed once the animation completes. |
mdc-menu-surface--anchor | Used to indicate which element the menu should be anchored to. |
mdc-menu-surface--fixed | Used to indicate that the menu is using fixed positioning. |
mdc-menu-surface--fullwidth | Sets the menu-surface's width to match that of its parent anchor. Do not use with mdc-menu-surface--fixed or if hoisting to body. |
| Mixin | Description |
|---|---|
ink-color($color) | Sets the color property of the mdc-menu-surface. |
fill-color($color) | Sets the background-color property of the mdc-menu-surface. |
shape-radius($radius, $rtl-reflexive) | Sets the rounded shape to menu surface with given radius size. Set $rtl-reflexive to true to flip radius values in RTL context, defaults to false. |
| Constant Name | Description |
|---|---|
Corner | Enum for representing an element corner for positioning the menu-surface. See constants.ts. |
| Type Name | Description |
|---|---|
MDCMenuDimensions | Width/height of an element. See types.ts. |
MDCMenuDistance | Margin values representing the distance from anchor point that the menu surface should be shown. See types.ts. |
MDCMenuPoint | X/Y coordinates. See types.ts. |
MDCMenuSurface Properties and Methods| Property | Value Type | Description |
|---|---|---|
quickOpen | boolean | Proxies to the foundation's setQuickOpen() method. |
anchorElement | Element | Gets or sets the element that the surface is anchored to, or null if the surface is not anchored. Defaults to the root element's parent mdc-menu-surface--anchor element if present. |
| Method Signature | Description |
|---|---|
isOpen() => boolean | Proxies to the foundation's isOpen method. |
open() => void | Proxies to the foundation's open method. |
close(skipRestoreFocus: boolean) => void | Proxies to the foundation's close method. |
setAnchorCorner(Corner) => void | Proxies to the foundation's setAnchorCorner(Corner) method. |
setAnchorMargin(Partial<MDCMenuDistance>) => void | Proxies to the foundation's setAnchorMargin(Partial<MDCMenuDistance>) method. |
setFixedPosition(isFixed: boolean) => void | Adds the mdc-menu-surface--fixed class to the mdc-menu-surface element. Proxies to the foundation's setIsHoisted() and setFixedPosition() methods. |
setAbsolutePosition(x: number, y: number) => void | Proxies to the foundation's setAbsolutePosition(x, y) method. Used to set the absolute x/y position of the menu on the page. Should only be used when the menu is hoisted to the body. |
setMenuSurfaceAnchorElement(element: Element) => void | Sets the element used as an anchor for menu-surface positioning logic. |
setIsHoisted() => void | Proxies to the foundation's setIsHoisted method. |
getDefaultFoundation() => MDCMenuSurfaceFoundation | Returns the foundation. |
| Event Name | Data | Description |
|---|---|---|
MDCMenuSurface:closed | none | Event emitted after the menu surface is closed. |
MDCMenuSurface:closing | none | Event emitted when the menu surface is closing, but animation may not have completed yet. |
MDCMenuSurface:opened | none | Event emitted after the menu surface is opened. |
If you are using a JavaScript framework, such as React or Angular, you can create a Menu Surface for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.
MDCMenuSurfaceAdapter| Method Signature | Description |
|---|---|
addClass(className: string) => void | Adds a class to the root element. |
removeClass(className: string) => void | Removes a class from the root element. |
hasClass(className: string) => boolean | Returns a boolean indicating whether the root element has a given class. |
hasAnchor: () => boolean | Returns whether the menu surface has an anchor for positioning. |
notifyClose() => void | Dispatches an event notifying listeners that the menu surface has been closed. |
notifyOpen() => void | Dispatches an event notifying listeners that the menu surface has been opened. |
isElementInContainer(el: Element) => boolean | Returns true if the el Element is inside the mdc-menu-surface container. |
isRtl() => boolean | Returns boolean indicating whether the current environment is RTL. |
setTransformOrigin(value: string) => void | Sets the transform origin for the menu surface element. |
isFocused() => boolean | Returns a boolean value indicating whether the root element of the menu surface is focused. |
saveFocus() => void | Stores the currently focused element on the document, for restoring with restoreFocus. |
restoreFocus() => void | Restores the previously saved focus state, by making the previously focused element the active focus again. |
getInnerDimensions() => MDCMenuDimensions | Returns an object with the items container width and height. |
getAnchorDimensions() => ClientRect | null | Returns an object with the dimensions and position of the anchor. |
getBodyDimensions() => MDCMenuDimensions | Returns an object with width and height of the body, in pixels. |
getWindowDimensions() => MDCMenuDimensions | Returns an object with width and height of the viewport, in pixels. |
getWindowScroll() => MDCMenuPoint | Returns an object with the amount the body has been scrolled on the x and y axis. |
setPosition(position: Partial<MDCMenuDistance>) => void | Sets the position of the menu surface element. |
setMaxHeight(value: string) => void | Sets max-height style for the menu surface element. |
MDCMenuSurfaceFoundation| Method Signature | Description |
|---|---|
setAnchorCorner(corner: Corner) => void | Sets the corner that the menu surface will be anchored to. See constants.ts |
setAnchorMargin(margin: Partial<MDCMenuDistance>) => void | Sets the distance from the anchor point that the menu surface should be shown. |
setIsHoisted(isHoisted: boolean) => void | Sets whether the menu surface has been hoisted to the body so that the offsets are calculated relative to the page and not the anchor. |
setFixedPosition(isFixed: boolean) => void | Sets whether the menu surface is using fixed positioning. |
setAbsolutePosition(x: number, y: number) => void | Sets the absolute x/y position of the menu. Should only be used when the menu is hoisted or using fixed positioning. |
handleBodyClick(event: MouseEvent) => void | Method used as the callback function for the click event. |
handleKeydown(event: KeyboardEvent) => void | Method used as the callback function for the keydown events. |
open() => void | Opens the menu surface. |
close() => void | Closes the menu. |
isOpen() => boolean | Returns a boolean indicating whether the menu surface is open. |
setQuickOpen(quickOpen: boolean) => void | Sets whether the menu surface should open and close without animation when the open/close methods are called. |
FAQs
The Material Components for the web menu surface component
The npm package @material/menu-surface receives a total of 773,506 weekly downloads. As such, @material/menu-surface popularity was classified as popular.
We found that @material/menu-surface demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.