# surstromming

> Smelly fish, and also a slider thing

Latest version **1.0.1** (published 2021-10-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install surstromming
pnpm add surstromming
yarn add surstromming
bun add surstromming
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-10-05 |
| First published | 2021-10-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | erikthalen |

## Links

- npm: https://www.npmjs.com/package/surstromming
- npm.io page: https://npm.io/package/surstromming

## Recent versions

- 1.0.1 (latest) — 2021-10-05
- 1.0.0 — 2021-10-05

## README

# surstromming

[Demo](https://codesandbox.io/s/surstromming-uleoe)

```js
import { surstromming } from 'surstromming'

const instance = surstromming('.element', {
  // at what breakpoint is changes mode
  modeChangeBreakpoint = 768,

  // selector of the items inside the container
  itemSelector = ".item",

  // how fast the mouse moves the items
  speed = 0.05,

  // runs in init
  onInit = ({ element, list, items }) => {},

  // runs each frame in 'mouse' mode
  onFrame = () => {},

  // what a new item becomes active
  onChange = (oldActive, newActive) => {},

  // on window resize between big/small
  onModeChange = (bigMode) => {},
});

// destroy/remove event listeners
instance.destroy()
```

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