@y14e/path-bar 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 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,89 @@
+# Path Bar
+
+Breadcrumb-style path bar implementation in TypeScript. Supports keyboard navigation, integrated menus, and seamless menu traversal.
+
+## Install
+
+```bash
+npm i @y14e/path-bar
+```
+
+```ts
+// npm
+import PathBar from '@y14e/path-bar@1.0.0';
+// with middleware
+import PathBar, { flip, offset, shift } from '@y14e/path-bar@1.0.0';
+
+// CDNs
+import PathBar from 'https://esm.sh/@y14e/path-bar@1.0.0';
+// or
+import PathBar from 'https://cdn.jsdelivr.net/npm/@y14e/path-bar@1.0.0/+esm';
+// or
+import PathBar from 'https://esm.unpkg.com/@y14e/path-bar@1.0.0';
+```
+
+## Usage
+
+```ts
+new PathBar(root, options);
+// => PathBar
+//
+// root: HTMLElement
+// options (optional): PathBarOptions
+
+```
+
+## 🪄 Options
+
+```ts
+interface PathBarOptions {
+  // Work in progress
+}
+
+interface PathBarPopoverOptions {
+  arrow?: boolean;           // default: true
+  middleware?: Middleware[]; // default: [flip(), offset(), shift()]
+  placement?: Placement;     // default: 'bottom-start'
+}
+```
+
+> [!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 path bar instances.
+
+```ts
+import PathBar from '@y14e/path-bar';
+
+PathBar.defaults = {
+  delay: 500,
+  selector: {
+    list: 'ul',
+  },
+};
+
+new PathBar(root);
+```
+
+## 📦 APIs
+
+### `destroy`
+
+Destroys the instance and cleans up all event listeners and menus.
+
+```ts
+pathBar.destroy(force);
+// => Promise<void>
+//
+// force (optional): If true, skips waiting for animations to finish.
+```
+
+## Demo
+
+https://y14e.github.io/path-bar/
+
+## Credits
+
+* [Floating UI](https://floating-ui.com/)