Package Health Score

77 / 100

security
No known security issues
popularity
Influential project
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version			Vulnerabilities	License Risk
14.0.0	\|	04/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L
13.0.0	\|	09/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L
12.0.0	\|	07/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.0.0	\|	04/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.0.0	\|	02/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (824,106)

GitHub Stars: 17.14K
Forks: 2.14K
Contributors: -

Direct Usage Popularity

The npm package @material/menu-surface receives a total of 824,106 downloads a week. As such, we scored @material/menu-surface popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package @material/menu-surface, we found that it has been starred 17,145 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 402
Open PR: 139
Last Release: 3 years ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @material/menu-surface based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for @material/menu-surface is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 8 Direct
Versions: 1.66K
Install Size: 365 kB
Dist-tags: 4
# of Files: 36
Maintainers: 14
TS Typings: No

@material/menu-surface has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Menu Surface

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.

Design & API Documentation

Installation

npm install @material/menu-surface

Usage

HTML Structure

<div class="mdc-menu-surface">
...
</div>

Styles

@use "@material/menu-surface/mdc-menu-surface";

JavaScript Instantiation

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.

Variants

Anchors and Positioning

Anchored To Parent

The menu surface can be positioned to automatically anchor to a parent element when opened.

<div class="toolbar mdc-menu-surface--anchor" id="toolbar">
  <div class="mdc-menu-surface">
  ...
  </div>
</div>

Anchor To Element Within Wrapper

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>

Fixed Position

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);

Absolute Position

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);

Style Customization

CSS Classes

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.

Sass Mixins

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.

Constants & Types

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) => void`	Proxies to the foundation's `setAnchorMargin(Partial)` 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.

Events

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.

Usage Within Frameworks

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) => 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) => 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.

@material/menu-surface dependencies

tslib @material/rtl @material/base @material/shape @material/theme @material/animation @material/elevation @material/feature-targeting

FAQs

What is @material/menu-surface?

The Material Components for the web menu surface component. Visit Snyk Advisor to see a full health score report for @material/menu-surface, including popularity, security, maintenance & community analysis.

Is @material/menu-surface popular?

The npm package @material/menu-surface receives a total of 824,106 weekly downloads. As such, @material/menu-surface popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @material/menu-surface well maintained?

We found indications that @material/menu-surface maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @material/menu-surface safe to use?

The npm package @material/menu-surface was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 26 November-2024, at 16:25 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP