4.0.1-p4.0.0.1 • Published 4 years ago
@limetech/mdc-dom v4.0.1-p4.0.0.1
DOM
MDC DOM provides commonly-used utilities for inspecting, traversing, and manipulating the DOM.
Most of the time, you shouldn't need to depend on mdc-dom directly. It is useful however if you'd like to write custom components that follow MDC Web's pattern and elegantly integrate with the MDC Web ecosystem.
Installation
npm install @limetech/mdc-domBasic Usage
import * as ponyfill from '@limetech/mdc-dom/ponyfill';See Importing the JS component for more information on how to import JavaScript.
Ponyfill Functions
The ponyfill module provides the following functions:
| Function Signature | Description |
|---|---|
closest(element: Element, selector: string) => ?Element | Returns the ancestor of the given element matching the given selector (which may be the element itself if it matches), or null if no matching ancestor is found. |
matches(element: Element, selector: string) => boolean | Returns true if the given element matches the given CSS selector. |
Event Functions
External frameworks and libraries can use the following event utility methods.
| Method Signature | Description |
|---|---|
util.applyPassive(globalObj = window, forceRefresh = false) => object | Determine whether the current browser supports passive event listeners |
NOTE: The function
util.applyPassivecache its results;forceRefreshwill force recomputation, but is used mainly for testing and should not be necessary in normal use.