Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@smui/ripple

Package Overview
Dependencies
Maintainers
1
Versions
89
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@smui/ripple

Svelte Material UI - Ripple

  • 7.0.0-beta.9
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
12K
decreased by-1.07%
Maintainers
1
Weekly downloads
 
Created
Source

Svelte Material UI - Ripple

Ripples are an interaction feedback mechanism.

Installation

npm install --save-dev @smui/ripple

Examples and Usage Information

https://sveltematerialui.com/demo/ripple

Exports

(default)

A ripple Svelte action.

Props / Defaults

The action accepts an array, with two entries. The first is a boolean, whether the ripple is enabled. The second is an object with the props:

  • ripple: true - Whether to enable the ripple.
  • surface: false - Whether the ripple surface classes should be added.
  • unbounded: false - Whether the ripple is unbounded.
  • disabled: false - Whether the node is disabled.
  • color: undefined - The ripple color. ('surface', 'primary', or 'secondary')
  • active: undefined - Used to determine active status of the ripple. If it's undefined, the ":active" pseudo class will be checked on activeTarget or the node.
  • eventTarget: undefined - An alternate element where ripple triggering event listeners will be added.
  • activeTarget: undefined - An alternate element where active status will be checked.
  • addClass: (className) => node.classList.add(className) - A function to add a class to the node.
  • removeClass: (className) => node.classList.remove(className) - A function to remove a class from the node.
  • addStyle: (name, value) => node.style.setProperty(name, value) - A function to add a style property to the node. If given a value of '' or null, it should remove the property.
  • initPromise: Promise.resolve() - A promise to wait for before initializing the ripple.

More Information

See Ripple in MDC-Web for information about the upstream library's architecture.

Keywords

FAQs

Package last updated on 20 Jun 2023

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc