@lion/ui 0.20.0 → 0.21.1-menu-system.0

package/components/menu/README.md

@@ -0,0 +1,334 @@
+# Menu
+
+A menu is a widget that offers a list of choices to the user, such as a set of actions or functions. A menu is usually opened, or made visible, by activating a menu button, choosing an item in a menu that opens a sub menu, or by invoking a command, such as Shift + F10 in Windows, that opens a context specific menu. When a user activates a choice in a menu, the menu usually closes unless the choice opened a submenu.
+
+A menu that is visually persistent is a menubar. A menubar is typically horizontal and is often used to create a menu bar similar to those found near the top of the window in many desktop applications, offering the user quick access to a consistent set of commands.
+
+A common convention for indicating that a menu item launches a dialog box is to append "…" (ellipsis) to the menu item label, e.g., "Save as …".
+
+> From [menu wai-aria best practices](https://www.w3.org/TR/wai-aria-practices/#menu)
+
+```js script
+import { html } from 'lit-html';
+import './lion-menu.js';
+import '../../../../docs/components/menu/src/DemoTree.js';
+import '../../../../docs/components/menu/src/DemoToolbar.js';
+import '../../../../docs/components/menu/src/DemoSpinButton.js';
+import { applyMenuDemoStyles } from './applyMenuDemoStyles.js';
+
+applyMenuDemoStyles();
+
+export default {
+  title: 'Navigation/Menu',
+};
+```
+
+```js preview-story
+export const menuButton = () => html`
+  <nav>
+    <button data-invoker>Open menu</button>
+    <lion-menu>
+      <div role="menuitem">Go to Definition</div>
+      <div role="menuitem">Go to Type Definition</div>
+      <div>
+        <div role="menuitem" data-invoker>Peek</div>
+        <lion-menu>
+          <div role="menuitem">Peek Call Hierarchy</div>
+          <div role="separator"></div>
+          <div role="menuitem">Peek Definition</div>
+        </lion-menu>
+      </div>
+      <div role="separator"></div>
+      <div role="menuitem">Find all References</div>
+    </lion-menu>
+  </nav>
+`;
+```
+
+```js preview-story
+export const menuButtonZ = () => html`
+  <nav>
+    <button data-invoker for="menu">Open menu</button>
+    <lion-menu id="menu">
+      <lion-menuitem> Go to Definition </lion-menuitem>
+      <lion-menuitem> Go to Type Definition </lion-menuitem>
+      <lion-menuitem>
+        <button slot="invoker">Peek</button>
+        <lion-menu>
+          <lion-menuitem type="radio"> Peek Call Hierarchy </lion-menuitem>
+          <div role="separator"></div>
+          <lion-menuitem type="radio"> Peek Definition </lion-menuitem>
+        </lion-menu>
+      </lion-menuitem>
+      <div role="separator"></div>
+      <lion-menuitem type="checkbox"> Find all References </lion-menuitem>
+    </lion-menu>
+  </nav>
+`;
+```
+
+## Groups, menuitemradios and menuitemcheckboxes
+
+From [wai aria menu fragment](https://www.w3.org/TR/wai-aria-practices-1.1/examples/menubar/menubar-2/menubar-2.html)
+
+```js preview-story
+export const groups = () => html`
+  <lion-menu bar invoker-interaction="hover">
+    <div>
+      <div role="menuitem">Font</div>
+      <lion-menu aria-label="Font">
+        <div role="menuitemradio">Sans-serif</div>
+        <div role="menuitemradio">Serif</div>
+        <div role="menuitemradio">Monospace</div>
+        <div role="menuitemradio">Fantasy</div>
+      </lion-menu>
+    </div>
+    <div>
+      <div role="menuitem">Style/Color</div>
+      <lion-menu aria-label="Style/Color">
+        <div role="menuitemcheckbox" aria-checked="true">Bold</div>
+        <div role="menuitemcheckbox" aria-checked="true">Italic</div>
+        <div role="separator"></div>
+        <div role="group" aria-label="Text Color">
+          <div role="menuitemradio" aria-checked="false">Black</div>
+          <div role="menuitemradio" aria-checked="false">Blue</div>
+          <div role="menuitemradio" aria-checked="true">Red</div>
+          <div role="menuitemradio" aria-checked="false">Green</div>
+        </div>
+        <div role="separator"></div>
+        <div role="group" aria-label="Text Decoration">
+          <div role="menuitemradio" aria-checked="true">None</div>
+          <div role="menuitemradio" aria-checked="false">Overline</div>
+          <div role="menuitemradio" aria-checked="false">Line-through</div>
+          <div role="menuitemradio" aria-checked="false">Underline</div>
+        </div>
+      </lion-menu>
+    </div>
+  </lion-menu>
+`;
+```
+
+## Tree
+
+```js preview-story
+export const tree = () => html`
+  <demo-tree>
+    <div>
+      <div role="treeitem">Fruits</div>
+      <demo-tree>
+        <div role="treeitem">Peek Call Hierarchy</div>
+        <div role="treeitem">Peek Definition</div>
+      </demo-tree>
+    </div>
+    <div>
+      <div role="treeitem">Vegetables</div>
+      <demo-tree>
+        <div role="treeitem">Peek Call Hierarchy</div>
+        <div>
+          <div role="treeitem">Peek</div>
+          <demo-tree>
+            <div role="treeitem">Peek Call Hierarchy</div>
+            <div role="treeitem">Peek Definition</div>
+          </demo-tree>
+        </div>
+      </demo-tree>
+    </div>
+    <div>
+      <div role="treeitem">Grains</div>
+      <demo-tree>
+        <div role="treeitem">Peek Call Hierarchy</div>
+        <div role="treeitem">Peek Definition</div>
+      </demo-tree>
+    </div>
+  </demo-tree>
+`;
+```
+
+## Disclosure menu
+
+See [disclosure navigation](https://www.w3.org/TR/wai-aria-practices-1.1/examples/disclosure/disclosure-navigation.html)
+
+```js preview-story
+export const disclosureMenu = () => html`
+ <nav aria-label="Mythical University">
+   <lion-menu bar>
+    <div role="listitem">
+      <button data-invoker>About</button>
+      <lion-menu>
+        <div role="listitem">
+          <a href="#mythical-page-content">Overview</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Administration</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Facts</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Campus Tours</a>
+        </div>
+      </ul>
+    </div>
+    <div role="listitem">
+      <button data-invoker>
+        Admissions
+      </button>
+      <lion-menu id="id_admissions_menu">
+        <div role="listitem">
+          <a href="#mythical-page-content">Apply</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Tuition</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Sign Up</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Visit</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Photo Tour</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Connect</a>
+        </div>
+      </ul>
+    </div>
+    <div role="listitem">
+      <button data-invoker>Academics</button>
+      <lion-menu>
+        <div role="listitem">
+          <a href="#mythical-page-content">Colleges & Schools</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Programs of Study</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Honors Programs</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Online Courses</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Course Explorer</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Register for Class</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Academic Calendar</a>
+        </div>
+        <div role="listitem">
+          <a href="#mythical-page-content">Transcripts</a>
+        </div>
+      </ul>
+    </div>
+  </ul>
+</nav>
+`;
+```
+
+## Toolbar
+
+From [wai aria toolbar](https://www.w3.org/TR/wai-aria-practices-1.2/examples/toolbar/toolbar.html)
+
+```js preview-story
+export const toolbar = () => html`
+  <demo-toolbar>
+    <div>
+      <button data-item title="bold" aria-label="Bold">
+        <span class="fas fa-bold" aria-hidden="true"></span>
+      </button>
+      <button data-item title="italic" aria-label="Italic">
+        <span class="fas fa-italic" aria-hidden="true"></span>
+      </button>
+      <button data-item title="underline" aria-label="Underline">
+        <span class="fas fa-underline" aria-hidden="true"></span>
+      </button>
+    </div>
+    <div role="separator"></div>
+    <div role="radiogroup" aria-label="Text Alignment">
+      <button data-item role="radio" aria-label="Text Align Left">
+        <span class="fas fa-align-left" aria-hidden="true"></span>
+      </button>
+      <button data-item role="radio" aria-label="Text Align Center">
+        <span class="fas fa-align-center" aria-hidden="true"></span>
+      </button>
+      <button data-item role="radio" aria-label="Text Align Right">
+        <span class="fas fa-align-right" aria-hidden="true"></span>
+      </button>
+    </div>
+    <div role="separator"></div>
+
+    <demo-spin-button data-item now="20" min="12" max="40" unit="px"></demo-spin-button>
+    <div role="separator"></div>
+
+    <div>
+      <div role="menuitem">Font</div>
+      <lion-menu aria-label="Font">
+        <div role="menuitemradio">Sans-serif</div>
+        <div role="menuitemradio">Serif</div>
+        <div role="menuitemradio">Monospace</div>
+        <div role="menuitemradio">Fantasy</div>
+      </lion-menu>
+    </div>
+    <div>
+      <div role="menuitem">Style/Color</div>
+      <lion-menu aria-label="Style/Color">
+        <div role="menuitemcheckbox" aria-checked="true">Bold</div>
+        <div role="menuitemcheckbox" aria-checked="true">Italic</div>
+        <div role="separator"></div>
+        <div role="group" aria-label="Text Color">
+          <div role="menuitemradio" aria-checked="false">Black</div>
+          <div role="menuitemradio" aria-checked="false">Blue</div>
+          <div role="menuitemradio" aria-checked="true">Red</div>
+          <div role="menuitemradio" aria-checked="false">Green</div>
+        </div>
+        <div role="separator"></div>
+        <div role="group" aria-label="Text Decoration">
+          <div role="menuitemradio" aria-checked="true">None</div>
+          <div role="menuitemradio" aria-checked="false">Overline</div>
+          <div role="menuitemradio" aria-checked="false">Line-through</div>
+          <div role="menuitemradio" aria-checked="false">Underline</div>
+        </div>
+      </lion-menu>
+    </div>
+  </demo-toolbar>
+`;
+```
+
+## Tree lion-item
+
+```js preview-storyb
+export const tree = () => html`
+  <demo-tree>
+    <lion-item>
+      <div>Fruits</div>
+      <demo-tree>
+        <lion-item>Peek Call Hierarchy</lion-item>
+        <lion-item>Peek Definition</lion-item>
+      </demo-tree>
+    </lion-item>
+    <lion-item>
+      <div>Vegetables</div>
+      <demo-tree>
+        <lion-item>Peek Call Hierarchy</lion-item>
+        <lion-item>
+          <div>Peek</div>
+          <demo-tree>
+            <lion-item>Peek Call Hierarchy</lion-item>
+            <lion-item>Peek Definition</lion-item>
+          </demo-tree>
+        </lion-item>
+      </demo-tree>
+    </lion-item>
+    <lion-item>
+      <div>Grains</div>
+      <demo-tree>
+        <lion-item>Peek Call Hierarchy</lion-item>
+        <lion-item>Peek Definition</lion-item>
+      </demo-tree>
+    </lion-item>
+  </demo-tree>
+`;
+```

package/components/menu/index.js

@@ -0,0 +1,2 @@
+export { LionMenu } from './src/LionMenu.js';
+export { InteractiveListMixin } from './src/InteractiveListMixin.js';

package/components/menu/lion-menu.js

@@ -0,0 +1,3 @@
+import { LionMenu } from './src/LionMenu.js';
+
+customElements.define('lion-menu', LionMenu);

package/components/menu/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@lion/menu",
+  "version": "0.0.0",
+  "description": "A menu is a widget that offers a list of choices to the user, such as a set of actions or functions",
+  "license": "MIT",
+  "author": "ing-bank",
+  "homepage": "https://github.com/ing-bank/lion/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ing-bank/lion.git",
+    "directory": "packages/menu"
+  },
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "files": [
+    "*.d.ts",
+    "*.js",
+    "docs",
+    "src",
+    "test",
+    "test-suites",
+    "translations",
+    "types"
+  ],
+  "scripts": {
+    "prepublishOnly": "../../scripts/npm-prepublish.js",
+    "test": "cd ../../ && yarn test:browser --grep \"packages/menu/test/**/*.test.js\"",
+    "test:watch": "cd ../../ && yarn test:browser:watch --grep \"packages/menu/test/**/*.test.js\""
+  },
+  "sideEffects": [
+    "lion-menu.js"
+  ],
+  "dependencies": {
+    "@lion/core": "0.11.0",
+    "@lion/form-core": "0.6.0"
+  },
+  "keywords": [
+    "lion",
+    "menu",
+    "web-components"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/components/menu/requirements.temp.md

@@ -0,0 +1,12 @@
+## Menu
+
+### Assumptions
+
+1. Menus are not always overlays (same holds for selects and comboboxes).Although often an overlay, a menu can be defined in the document flow as well: - a menu inside a left dialog sheet/ sidebar - a combobox like: <https://lion-web-components.netlify.app/?path=/docs/forms-combobox-extensions--whatsapp>Concretely, this means that the disclosure
+
+2. The api for a menu should follow platform and community standards as closely as possible- for instance: dialog / details / new popup spec (invoker is sibling of collapsible menu)
+
+3. It should be possible to add ‘lightweight’ menu items (like a div with [role=menuitemradio] or [role=separator])
+
+4. We want to reuse existing interaction patterns for all ‘’interactive lists’ (horizontal and vertical): listbox/select/combobox/menu/toolbar/tree
+   - Deprecated menu spec (with the exception that menu items should always allow html (avoid label and icon attrs)