Path

Breadcrumb-style path bar implementation in TypeScript. Supports keyboard navigation, integrated menus, and seamless menu traversal.

Install

npm i @y14e/path

// npm
import Path from '@y14e/path';
// with middleware
import Path, { flip, offset, shift } from '@y14e/path';

// CDNs
import Path from 'https://esm.sh/@y14e/[email protected]';
// or
import Path from 'https://cdn.jsdelivr.net/npm/@y14e/[email protected]/+esm';
// or
import Path from 'https://esm.unpkg.com/@y14e/[email protected]';

Usage

new Path(root, options);
// => Path
//
// root: HTMLElement
// options (optional): PathOptions

🪄 Options

interface PathOptions {
  // Work in progress
}

interface PathPopoverOptions {
  arrow?: boolean;           // default: true
  middleware?: Middleware[]; // default: [flip(), offset(), shift()]
  placement?: Placement;     // default: 'bottom-start'
}

[!NOTE] Middleware and Placement are provided by Floating UI. See the Floating UI docs for details.

⚙️ Customize defaults

Override the global default settings applied to all path instances.

import Path from '@y14e/path';

Path.defaults = {
  delay: 500,
  selector: {
    list: 'ul',
  },
};

new Path(root);

📦 APIs

destroy

Destroys the instance and cleans up all event listeners and menus.

Path.destroy(force);
// => Promise<void>
//
// force (optional): If true, skips waiting for animations to finish.

Demo

https://y14e.github.io/path/

Credits

• Floating UI