Skip to content

An accessible, responsive, and customisable React menu component library.

License

Notifications You must be signed in to change notification settings

9688882172/react-menu

 
 

Repository files navigation

React-Menu

An accessible, responsive, and customisable React menu library.

Live examples and documentation

NPM TypeScript Known Vulnerabilities

Features

  • React menu components for easy and fast web development.
  • Unlimited levels of submenu.
  • Supports radio and checkbox menu items.
  • Supports context menu.
  • Flexible menu positioning.
  • Customisable styling.
  • Comprehensive keyboard interactions.
  • Adheres to WAI-ARIA Authoring Practices.

Installation

# with npm
npm install @szhsin/react-menu

# with Yarn
yarn add @szhsin/react-menu

No peer dependency is required except React 16.8+.

Usage

import React from 'react';
import {
    Menu,
    MenuItem,
    MenuButton,
    SubMenu
} from '@szhsin/react-menu';
import '@szhsin/react-menu/dist/index.css';

export default function Example() {
    return (
        <Menu menuButton={<MenuButton>Open menu</MenuButton>}>
            <MenuItem>New File</MenuItem>
            <SubMenu label="Open">
                <MenuItem>index.html</MenuItem>
                <MenuItem>example.js</MenuItem>
                <MenuItem>about.css</MenuItem>
            </SubMenu>
            <MenuItem>Save</MenuItem>
        </Menu>
    );
}

More examples and documentation

License

MIT Licensed. Copyright (c) 2020 Zheng Song.

About

An accessible, responsive, and customisable React menu component library.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.9%
  • SCSS 8.0%
  • HTML 2.1%