react-pdf-highlighter-plus

Interface LeftPanelUtils

Utilities and state available within the LeftPanel context

interface LeftPanelUtils {
    activeTab: LeftPanelTab;
    currentPage: number;
    goToOutlineItem: ((item) => void);
    goToPage: ((pageNumber) => void);
    hasOutline: boolean;
    isOpen: boolean;
    isOutlineLoading: boolean;
    loadThumbnail: ((pageNumber) => Promise<void>);
    outline: null | ProcessedOutlineItem[];
    pdfDocument: null | PDFDocumentProxy;
    setActiveTab: ((tab) => void);
    setIsOpen: ((open) => void);
    thumbnails: Map<number, ThumbnailData>;
    totalPages: number;
}

Properties

activeTab currentPage goToOutlineItem goToPage hasOutline isOpen isOutlineLoading loadThumbnail outline pdfDocument setActiveTab setIsOpen thumbnails totalPages

Properties

activeTab

activeTab: LeftPanelTab

currentPage

currentPage: number

goToOutlineItem

goToOutlineItem: ((item) => void)

Type declaration

goToPage

goToPage: ((pageNumber) => void)

Type declaration

    • (pageNumber): void

    • Parameters

      • pageNumber: number

      Returns void

hasOutline

hasOutline: boolean

isOpen

isOpen: boolean

isOutlineLoading

isOutlineLoading: boolean

loadThumbnail

loadThumbnail: ((pageNumber) => Promise<void>)

Type declaration

    • (pageNumber): Promise<void>

    • Parameters

      • pageNumber: number

      Returns Promise<void>

outline

outline: null | ProcessedOutlineItem[]

pdfDocument

pdfDocument: null | PDFDocumentProxy

setActiveTab

setActiveTab: ((tab) => void)

Type declaration

setIsOpen

setIsOpen: ((open) => void)

Type declaration

    • (open): void

    • Parameters

      • open: boolean

      Returns void

thumbnails

thumbnails: Map<number, ThumbnailData>

totalPages

totalPages: number