Skip to content

Commit 441b802

Browse files
committed
Update README
1 parent 4429109 commit 441b802

File tree

3 files changed

+18
-26
lines changed

3 files changed

+18
-26
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
# React-Menu
22

3-
> An accessible and keyboard-friendly React menu library.
3+
> An accessible, keyboard-friendly React menu library
44
55
**[Live examples and docs](https://szhsin.github.io/react-menu/)**
66

77
[![NPM](https://img.shields.io/npm/v/@szhsin/react-menu.svg)](https://www.npmjs.com/package/@szhsin/react-menu)
88
[![NPM](https://img.shields.io/npm/dm/@szhsin/react-menu)](https://www.npmjs.com/package/@szhsin/react-menu)
9-
[![TypeScript](https://img.shields.io/badge/TypeScript-.d.ts-blue.svg)](https://github.com/szhsin/react-menu/blob/master/types/index.d.ts)
9+
[![bundlephobia](https://img.shields.io/bundlephobia/minzip/@szhsin/react-menu)](https://bundlephobia.com/package/@szhsin/react-menu)
1010
[![Known Vulnerabilities](https://snyk.io/test/github/szhsin/react-menu/badge.svg)](https://snyk.io/test/github/szhsin/react-menu)
1111

1212
## Features
1313

14-
- Unstyled and lightweight [(8kB)](https://bundlephobia.com/package/@szhsin/react-menu) React menu components
15-
- Unlimited levels of submenu
16-
- Supports dropdown, hover, and context menu
17-
- Supports radio and checkbox menu items
18-
- Flexible menu positioning
19-
- Comprehensive keyboard interactions
20-
- Customisable [styling](https://szhsin.github.io/react-menu/#styling)
21-
- [Level 3 support](https://github.com/reactwg/react-18/discussions/70) of React 18 concurrent rendering
14+
- [Lightweight](https://bundlephobia.com/package/@szhsin/react-menu), unstyled React menu components
15+
- Unlimited submenu nesting
16+
- Supports dropdown, hover, and context menus
17+
- Radio and checkbox menu items
18+
- Flexible positioning options
19+
- Full keyboard interaction support
20+
- Compatible with React 18+ concurrent rendering
2221
- Supports server-side rendering
2322
- Implements [WAI-ARIA menu](https://www.w3.org/WAI/ARIA/apg/patterns/menu/) pattern
2423

example/src/data/codeExamples.js

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1255,22 +1255,15 @@ export const features = {
12551255
desc: (
12561256
<ul className="features">
12571257
<li>
1258-
Unstyled and lightweight{' '}
1259-
<a href="https://bundlephobia.com/package/@szhsin/react-menu">(8kB)</a> React menu
1260-
components.
1261-
</li>
1262-
<li>Unlimited levels of submenu</li>
1263-
<li>Supports dropdown, hover, and context menu</li>
1264-
<li>Supports radio and checkbox menu items</li>
1265-
<li>Flexible menu positioning</li>
1266-
<li>Comprehensive keyboard interactions</li>
1267-
<li>
1268-
Customisable <Link href={'#styling'}>styling</Link>
1269-
</li>
1270-
<li>
1271-
<a href="https://github.com/reactwg/react-18/discussions/70">Level 3 support</a> of React 18
1272-
concurrent rendering
1258+
<a href="https://bundlephobia.com/package/@szhsin/react-menu">Lightweight</a>, unstyled
1259+
React menu components
12731260
</li>
1261+
<li>Unlimited submenu nesting</li>
1262+
<li>Supports dropdown, hover, and context menus</li>
1263+
<li>Radio and checkbox menu items</li>
1264+
<li>Flexible positioning options</li>
1265+
<li>Full keyboard interaction support</li>
1266+
<li>Compatible with React 18+ concurrent rendering</li>
12741267
<li>Supports server-side rendering</li>
12751268
<li>
12761269
Implements{' '}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@szhsin/react-menu",
33
"version": "4.4.1",
4-
"description": "React component for building accessible menu, dropdown, submenu, context menu and more.",
4+
"description": "React component for building accessible menu, dropdown, submenu, context menu, and more",
55
"author": "Zheng Song",
66
"license": "MIT",
77
"repository": "szhsin/react-menu",

0 commit comments

Comments
 (0)