HTML Flip Book - v0.0.0-alpha.36
    Preparing search index...

    Interface TocPageProps

    Props for the TocPage component.

    interface TocPageProps {
        className?: string;
        direction?: "rtl" | "ltr";
        filter?: (entry: TocEntry, pageIndex: number) => boolean;
        heading?: string;
        onNavigate: (pageIndex: number) => void;
        pageSemantics?: any;
        renderEntry?: (entry: TocEntry, onClick: () => void) => ReactNode;
        totalPages: number;
    }
    Index

    Properties

    className? direction? filter? heading? onNavigate pageSemantics? renderEntry? totalPages

    Properties

    className?: string

    Custom CSS class for the container

    direction?: "rtl" | "ltr"

    Reading direction for RTL support

    filter?: (entry: TocEntry, pageIndex: number) => boolean

    Filter function to determine which pages appear in TOC. By default, only pages with a title are included.

    heading?: string

    Custom heading text. Default: "Table of Contents"

    onNavigate: (pageIndex: number) => void

    Callback to navigate to a specific page

    pageSemantics?: any

    Page semantics for generating titles and page numbers

    renderEntry?: (entry: TocEntry, onClick: () => void) => ReactNode

    Custom render function for TOC entries. If not provided, uses default rendering.

    totalPages: number

    Total number of pages in the book

    Settings

    Member Visibility

    On This Page

    Properties