https://github.com/codebrahma/react-flexible-sliding-menu

A React library which provides Flexible Sliding Menu with an easy to use API and a bunch of other awesome features. Also, you get to choose which animation you want for the sliding menu.
https://github.com/codebrahma/react-flexible-sliding-menu

Last synced: 7 months ago
JSON representation

A React library which provides Flexible Sliding Menu with an easy to use API and a bunch of other awesome features. Also, you get to choose which animation you want for the sliding menu.

• Host: GitHub
• URL: https://github.com/codebrahma/react-flexible-sliding-menu
• Owner: Codebrahma
• License: mit
• Created: 2019-12-14T13:19:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-31T12:49:34.000Z (over 1 year ago)
• Last Synced: 2024-11-29T21:45:30.172Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://react-flexible-sliding-menu.netlify.com/
• Size: 1010 KB
• Stars: 22
• Watchers: 5
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Logo](https://react-flexible-sliding-menu.netlify.com/docs/public/Logo.svg)

[![NPM Version Badge](https://img.shields.io/npm/v/react-flexible-sliding-menu)](https://www.npmjs.com/package/react-flexible-sliding-menu)

[![NPM Downloads Badge](https://img.shields.io/npm/dm/react-flexible-sliding-menu)](https://www.npmjs.com/package/react-flexible-sliding-menu)

[![Minified Size Badge](https://img.shields.io/bundlephobia/min/react-flexible-sliding-menu?label=min%20size)](https://bundlephobia.com/result?p=react-flexible-sliding-menu)

[![Minified Zip Size Badge](https://img.shields.io/bundlephobia/minzip/react-flexible-sliding-menu?label=minzip%20size)](https://bundlephobia.com/result?p=react-flexible-sliding-menu)

[![License Badge](https://img.shields.io/npm/l/react-flexible-sliding-menu)](https://github.com/Codebrahma/react-flexible-sliding-menu/blob/master/LICENSE)

[![Netlify(Docs) Build Badge](https://img.shields.io/netlify/ec537a2b-5835-41cb-833c-ca62fcc8a436?label=netlify%28docs%29)](https://app.netlify.com/sites/react-flexible-sliding-menu/deploys)

[![Github Stars Badge](https://img.shields.io/github/stars/Codebrahma/react-flexible-sliding-menu?style=social)](https://github.com/Codebrahma/react-flexible-sliding-menu/stargazers)

[![Github Watchers Badge](https://img.shields.io/github/watchers/Codebrahma/react-flexible-sliding-menu?style=social)](https://github.com/Codebrahma/react-flexible-sliding-menu/watchers)

# React Flexible Sliding Menu

A **React** library which provides **Flexible Sliding Menu** with an easy to use [API](https://react-flexible-sliding-menu.netlify.com/API/MenuProvider) and a bunch of other awesome [features](https://react-flexible-sliding-menu.netlify.com/#features). Also, you get to choose which [animation](https://react-flexible-sliding-menu.netlify.com/animations/slide) you want for the sliding menu.

> **Note:** The library is not restricted to just menus, technically you can provide any React Component to make it slide.

## Documentation 📖

Read the full Documentation [here](https://react-flexible-sliding-menu.netlify.com).

## Features

1. **Fully Flexible:** Pass whatever component you want, to make it slide and attach the triggers to whatever component you want.

2. **Conditionally Rendered:** Rather than hiding the menu (_setting `opacity:0`, or sending it off the viewport_), it is removed from the DOM itself.

3. **Fully Managed State:** Unlike most other libraries, state of Menu is managed by the library so that you don't have to.

4. **Uses React Context:** several methods are provided via context, so you can access it wherever you want in the component tree.

## Motivation

There are a lot of libraries out there which set out to do the same thing, some accomplished it some don't. But, I always found one or another thing missing in them. Hence, I built this library to fulfill my needs and possibly yours.