# @riot-material/ripple

> You can install it via nodejs ```sh npm install @riot-material/ripple ``` or download one of the bundled file ```js /** * `dist/index.amd.js` * `dist/index.amd+libs.js` * `dist/index.umd.js` * `dist/index.umd+libs.js` */ requirejs.config(

Latest version **1.2.0** (published 2021-10-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @riot-material/ripple
pnpm add @riot-material/ripple
yarn add @riot-material/ripple
bun add @riot-material/ripple
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2021-10-01 |
| First published | 2020-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 81.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kal Aster |
| Maintainers | elitexxl97 |

## Links

- npm: https://www.npmjs.com/package/@riot-material/ripple
- npm.io page: https://npm.io/package/@riot-material/ripple

## Dependencies (1)

- [what-input](https://npm.io/package/what-input.md) ^5.2.10

## Recent versions

- 1.2.0 (latest) — 2021-10-01
- 1.1.4 — 2021-09-17
- 1.1.3 — 2021-09-17
- 1.1.2 — 2021-07-23
- 1.1.1 — 2021-07-23
- 1.1.0 — 2021-07-23
- 1.0.6 — 2021-07-13
- 1.0.5 — 2020-12-07
- 1.0.4 — 2020-12-05
- 1.0.3 — 2020-12-01
- 1.0.2 — 2020-11-26
- 1.0.1 — 2020-11-26
- 1.0.0 — 2020-11-21

## README

# checkbox component based on [Material Design](https://material.io/components/selection-controls#checkboxes) for [riot-material](https://github.com/riot-material/riot-material)
## Installation
You can install it via nodejs
```sh
npm install @riot-material/ripple
```
or download one of the bundled file
```js
/**
 * `dist/index.amd.js`
 * `dist/index.amd+libs.js`
 * `dist/index.umd.js`
 * `dist/index.umd+libs.js`
 */
requirejs.config({
  paths: {
      "@riot-material/ripple": "path/to/@riot-material/ripple",
   },
});

require(['@riot-material/ripple'], function (ripple) {
    // ...
});

/**
 * `dist/index.js`
 * `dist/index.es.js`
 * npm installation
 */
import * as ripple from "@riot-material/ripple";

```
otherwise you can include the script in your project html
```html
<script src="@riot-material/ripple/index.umd.js" />
<!-- or -->
<script src="@riot-material/ripple/index.umd+libs.js" />
```
and access it via
```js
window.riotMaterial.ripple;
```
*Note: all the bundled file having `+libs` contain also the dependencies needed by the component, which, in this case, are:  
`what-input`  
Be sure to have them when installing manually or including via html*
## Methods
### `ripple(element: HTMLElement, options?: `[`IRippleOptions`](#irippleoptions)`): `[`IRipple`](#iripple)
### `isRipple(element: HTMLElement): boolean`
## Types
### IRipple
`highlight(): Ripple`

`start(x: number | null, y: number | null, event?: PointerEvent | FocusEvent, type?: TYPE): Ripple`

`set(options: IRippleOptions): IRipple`

`getOption(option: string): any`
### IRippleOptions
`radius: number` *optional*

`centered: boolean` *optional*

`unbounded: boolean` *optional*

`disabled: boolean` *optional*

`highlight: boolean` *optional*

`instantHighlight: boolean` *optional*

`unboundedFocus: boolean` *optional*

`focusTarget: HTMLElement` *optional*

`color: string` *optional*

`detectLabel: boolean` *optional*

`usePointerFocus: boolean` *optional*

`stopRippling: boolean` *optional*

---
_Source: https://npm.io/package/@riot-material/ripple · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._