aldler / react-menu

React component for building accessible menu, dropdown, submenu, context menu and more.

Home Page:https://szhsin.github.io/react-menu/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

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) 2021 Zheng Song.

About

React component for building accessible menu, dropdown, submenu, context menu and more.

https://szhsin.github.io/react-menu/

License:MIT License


Languages

Language:JavaScript 86.1%Language:SCSS 12.2%Language:HTML 1.7%