element-book
Version:
An [`element-vir`](https://npmjs.com/package/element-vir) drop-in element for building, testing, and demonstrating a collection of elements (or, in other words, a design system).
24 lines (23 loc) • 712 B
TypeScript
import { type BookEntry } from './book-entry.js';
/**
* Create a list of URL breadcrumbs for the given element-book entry.
*
* @internal
*/
export declare function listUrlBreadcrumbs(entry: BookEntry, includeSelf: boolean): string[];
/**
* Convert an element-book entry's title to a URL-safe breadcrumb title.
*
* @internal
*/
export declare function titleToUrlBreadcrumb(title: string): string;
/**
* Check if a full list of URL breadcrumbs (`searchIn`) starts with the subset list of URL
* breadcrumbs (`searchFor`).
*
* @internal
*/
export declare function doBreadcrumbsStartWith({ searchFor, searchIn, }: {
searchIn: ReadonlyArray<string>;
searchFor: ReadonlyArray<string>;
}): boolean;