element-book - v25.2.0
    Preparing search index...

    Type Alias BaseBookEntry

    Base properties for all book entry types.

    type BaseBookEntry = {
        descriptionParagraphs: ReadonlyArray<string>;
        entryType: BookEntryType;
        errors: Error[];
        parent: unknown;
        title: string;
    }
    Index

    Properties

    descriptionParagraphs: ReadonlyArray<string>

    A description that will be displayed below the entry title. Each item in the array will be a separate paragraph.

    entryType: BookEntryType
    errors: Error[]
    parent: unknown

    The parent page. A value of undefined here indicates that the entry should be at the top level of the element book.

    title: string

    Title for the entry. This is used to create breadcrumbs and URL paths. Each title must be unique within a given entry's parent.