Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bokuweb/react-motion-menu
[DEPRECATED] 🍔 A spring animation menu component for React.
https://github.com/bokuweb/react-motion-menu
menu react react-motion
Last synced: 2 days ago
JSON representation
[DEPRECATED] 🍔 A spring animation menu component for React.
- Host: GitHub
- URL: https://github.com/bokuweb/react-motion-menu
- Owner: bokuweb-sandbox
- License: mit
- Archived: true
- Created: 2015-12-02T01:09:04.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-20T06:07:03.000Z (almost 7 years ago)
- Last Synced: 2024-05-01T23:02:13.052Z (8 months ago)
- Topics: menu, react, react-motion
- Language: JavaScript
- Homepage: http://bokuweb.github.io/react-motion-menu/
- Size: 688 KB
- Stars: 333
- Watchers: 11
- Forks: 46
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-components-all - react-motion-menu - Motion menu component powered by React Motion. (Uncategorized / Uncategorized)
README
# Deprecated
Deprecated as the react-motion-menu project is no longer maintained.
---
# react-motion-menu
Animation menu component for React.
## Demo
See demo: [http://bokuweb.github.io/react-motion-menu/](http://bokuweb.github.io/react-motion-menu/)
## Installation
```sh
npm i react-motion-menu
```
## Overview
### Basic
``` javascript
import React from 'react';
import MotionMenu from '../../src';
export default () => (
);
```
## Properties
#### `x: PropTypes.number`
The position `x` of the menu button.
If ommited, set 0.
#### `y: PropTypes.number`
The position `y` of the menu button.
If ommited, set 0.
#### `type: PropTypes.oneOf(['vertical', 'horizontal', 'circle'])`
The Menu opening and closing type.
Please set `horizontal`, `vertical`, `circle`.
#### `margin: PropTypes.number`
The `margin` between items or menu button.
#### `wing: PropTypes.bool`
If set `true`, menu opened both side, when `vertical` or `horizontal` type selected.
#### `bumpy: PropTypes.bool`
This prop controls if the menu items should open in bumpy mode or in smooth mode.
Default mode is set to bumpy effect.
#### `openSpeed: PropTypes.number`
This prop controls how fast the menu items should open. Default speed is set to 60 milliseconds.
#### `reverse: PropTypes.bool`
This prop controls if the menu should open in reverse direction or not.
## Test
``` sh
npm t
```
## License
The MIT License (MIT)
Copyright (c) 2016 @bokuweb
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
