@y14e/menu 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yusuke Kamiyamane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+# Menu
+
+WAI-ARIA compliant menu ([menu button](https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/)) pattern implementation in TypeScript. Supports checkbox item, radio item, and infinitely nested menus.
+
+## Install
+
+```bash
+npm i @y14e/menu
+```
+
+```ts
+// npm
+import Tabs from '@y14e/menu@1.4.0';
+
+// CDNs
+import Tabs from 'https://esm.sh/@y14e/menu@1.4.0';
+// or
+import Tabs from 'https://cdn.jsdelivr.net/npm/@y14e/menu@1.4.0/+esm';
+// or
+import Tabs from 'https://esm.unpkg.com/@y14e/menu@1.4.0';
+```
+
+## Usage
+
+```ts
+new Menu(root, options);
+// => Menu
+//
+// root: HTMLElement
+// options (optional): MenuOptions
+
+```
+
+## 🪄 Options
+
+```ts
+interface MenuOptions {
+  animation?: {
+    duration?: number;            // ms (default: 300)
+  };
+  delay?: number;                 // ms (default: 200)
+  popover?: {
+    menu?: MenuPopoverOptions;
+    submenu?: MenuPopoverOptions;
+    transformOrigin?: boolean;    // default: true
+  };
+  selector?: {
+    checkboxItem?: string;        // default: '[role="menuitemcheckbox"]'
+    group?: string;               // default: '[role="group"]'
+    item?: string;                // default: '[role^="menuitem"]'
+    list?: string;                // default: '[role="menu"]'
+    radioItem?: string;           // default: '[role="menuitemradio"]'
+    trigger?: string;             // default: '[data-menu-trigger]'
+  };
+}
+
+interface MenuPopoverOptions {
+  arrow?: boolean;                // default: true
+  middleware?: Middleware[];      // default: [flip(), offset(), shift()]
+  placement?: Placement;          // default: 'bottom-start' (menu) / 'right-start' (submenu)
+}
+```
+
+> [!NOTE]
+> `Middleware` and `Placement` are provided by [Floating UI](https://floating-ui.com/). See the Floating UI docs for details.
+
+### ⚙️ Customize defaults
+
+Override the global default settings applied to all menu instances.
+
+```ts
+import Menu from './menu';
+
+Menu.defaults = {
+  delay: 500,
+  selector: {
+    trigger: '.trigger',
+  },
+};
+
+new Menu(root);
+```
+
+## 📦 APIs
+
+### `open`
+
+```ts
+menu.open();
+// => void
+```
+
+### `close`
+
+```ts
+menu.close();
+// => void
+```
+
+### `destroy`
+
+Destroys the instance and cleans up all event listeners and submenus.
+
+```ts
+menu.destroy(force);
+// => Promise<void>
+//
+// force (optional): If true, skips waiting for animations to finish.
+```
+
+## Demo
+
+https://y14e.github.io/menu/
+
+## Credits
+
+* [Floating UI](https://floating-ui.com/)