Skip to content

Commit

Permalink
Add note about reasoning behind single level submenus
Browse files Browse the repository at this point in the history
  • Loading branch information
mrwweb authored Dec 14, 2022
1 parent 93c4f8d commit 6c0e850
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Clicky Menus lets you create a progressively-enhanced, accessible one-level drop
- Close open submenu with click outside of open menu
- Basic offscreen-menu prevention

### Why only one level of submenu?

This script only supports a single level of submenus, i.e., there are no "sub-sub-menus" or "tertiary menus". This is intentional because:

1. I don't like them personally and think of them as a bit of a "navigation smell"—a la "code smell".
2. This makes it very easy to make "mega menus" that can contain nested lists (basically permanently visible tertiary menus).

If you really want this feature, there's an [open issue for sharing use cases](https://github.com/mrwweb/clicky-menus/issues/8). If you want to submit a pull request, please coordinate on that issue before doing any work!

## Browser Support

All Modern Browsers such as Firefox, Chrome, Edge, and Safari.
Expand Down Expand Up @@ -41,4 +50,4 @@ Include `clicky-menus.js` anywhere in the DOM and `clicky-menus.css` in the `<he
## Changelog

### 1.0.0
- It's alive!
- It's alive!

0 comments on commit 6c0e850

Please sign in to comment.