element-book/dist/data/book-entry/base-book-entry.d.ts

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).

import { type HTMLTemplateResult } from 'element-vir';
import { type BookEntryType } from './book-entry-type.js';
/**
 * Base properties for all book entry types.
 *
 * @category Internal
 */
export type BaseBookEntry = {
    /**
     * Title for the entry. This is used to create breadcrumbs and URL paths. Each title must be
     * unique within a given entry's parent.
     */
    title: string;
    entryType: BookEntryType;
    /**
     * The parent page. A value of undefined here indicates that the entry should be at the top
     * level of the element book.
     */
    parent: unknown;
    /**
     * A description that will be displayed below the entry title. Each item in the array will be a
     * separate paragraph.
     */
    descriptionParagraphs: ReadonlyArray<string | HTMLTemplateResult>;
    errors: Error[];
};