From 6c0e850124ab0a12004acfb27c4eb59f802cbcc0 Mon Sep 17 00:00:00 2001 From: Mark Root-Wiley Date: Wed, 14 Dec 2022 11:07:20 -0800 Subject: [PATCH] Add note about reasoning behind single level submenus --- readme.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index bbf59fb..1b04cf1 100644 --- a/readme.md +++ b/readme.md @@ -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. @@ -41,4 +50,4 @@ Include `clicky-menus.js` anywhere in the DOM and `clicky-menus.css` in the `