# famous-sidepanel

> A famo.us SidepanelLayout - for swiping menus

Latest version **0.1.0** (published 2014-10-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install famous-sidepanel
pnpm add famous-sidepanel
yarn add famous-sidepanel
bun add famous-sidepanel
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-10-14 |
| First published | 2014-10-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Mark Marijnissen |
| Maintainers | markmarijnissen |
| Keywords | famous, sidepanel, layout |

## Links

- npm: https://www.npmjs.com/package/famous-sidepanel
- Repository: https://github.com/markmarijnissen/famous-sidepanel
- Issues: https://github.com/markmarijnissen/famous-sidepanel/issues
- npm.io page: https://npm.io/package/famous-sidepanel

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2014-10-14

## README

famous-sidepanel
==========

famous-sidepanel is a typical swipe-to-open-menu layout.  

![Example](example.gif)


## Getting started

Install using bower or npm

```bash
  bower install famous-sidepanel
  npm install famous-sidepanel
```

## Usage

```javascript
var layout = new SidepanelLayout({
    sidepanel: null,    //RenderNode for sidepanel
    content: null,      //RenderNode for content

    maxPos: 1e4,        // Max position (dragging) (x-coordinate)
    width: 225,         // Open position (x-coordinate)
    transition: {
        duration: 300,
        curve: 'easeOut'
    },
    moveThreshold: 20,  // When should you start moving?
    posThreshold: 138,  // When should sidepanel open?
    velThreshold: 0.75, // When should sidepanel open?
});
this.add(layout);
```

The `sidepanel` and `content` options are mandatory, the rest is optional.

## Contribute

Feel free to contribute to this project in any way. The easiest way to support this project is by giving it a star.

## Contact
-   @markmarijnissen
-   http://www.madebymark.nl
-   info@madebymark.nl

© 2014 - Mark Marijnissen

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