react-native-view-pdf/lib/index.d.ts

React native Pdf viewer implementation

import React from 'react';
import type { StyleProp, ViewStyle } from 'react-native';
export declare type UrlPropsType = {
    /**
     * `method` is the HTTP Method to use. Defaults to GET if not specified.
     */
    method?: string;
    /**
     * `headers` is an object representing the HTTP headers to send along with the
     * request for a remote image.
     */
    headers?: {
        [key: string]: string;
    };
    /**
     * `body` is the HTTP body to send with the request. This must be a valid
     * UTF-8 string, and will be sent exactly as specified, with no
     * additional encoding (e.g. URL-escaping or base64) applied.
     */
    body?: string;
};
export interface PDFViewUrlProps {
    /**
     * `method` is the HTTP Method to use. Defaults to GET if not specified.
     */
    method?: string;
    /**
     * `headers` is an object representing the HTTP headers to send along with the
     * request for a remote image.
     */
    headers?: {
        [key: string]: string;
    };
    /**
     * `body` is the HTTP body to send with the request. This must be a valid
     * UTF-8 string, and will be sent exactly as specified, with no
     * additional encoding (e.g. URL-escaping or base64) applied.
     */
    body?: string;
}
export interface PDFViewProps {
    /**
     * `style` View Style Property https://reactnative.dev/docs/view-style-props
     */
    style?: StyleProp<ViewStyle>;
    /**
     * A Function. Invoked on load error with {nativeEvent: {error}}.
     */
    onError?: (error: {
        message: string;
    }) => void;
    /**
     * A Function. Invoked when load completes successfully.
     */
    onLoad?: () => void;
    /**
     * A Function. Invoked when page is changed.
     * @param {Number} page - The active page.
     * @param {Number} pageCount - Total pages.
     */
    onPageChanged?: (page: number, pageCount: number) => void;
    /**
     * A Function. Invoked when page is scrolled.
     * @param {Number} offset - Offset. Currently only 1 and 0 are supported.
     *                          where:
     *                            0 - beginning of the document
     *                            1 - end of the document
     */
    onScrolled?: (offset: number) => void;
    /**
     * A String value. Defines the resource to render. Can be one of:
     *   - url. Example: http://www.pdf995.com/samples/pdf.pdf
     *   - base64. Example: 'JVBERi0xLjcKCjEgMCBvYmogICUgZW50...'
     *   - fileName - Example: Platform.OS === 'ios' ?
     *       'test-pdf.pdf' : '/sdcard/Download/test-pdf.pdf'
     */
    resource: string;
    /**
     * A String value. Defines the resource type. Can be one of:
     *   - "url", for url
     *   - "base64", for base64 data
     *   - "file", for local files
     */
    resourceType?: 'url' | 'base64' | 'file';
    /**
     * iOS file location. Can be one of:
     *   - "bundle"
     *   - "documentsDirectory"
     *   - "libraryDirectory"
     *   - "cachesDirectory"
     *   - "tempDirectory"
     */
    fileFrom?: 'bundle' | 'documentsDirectory' | 'libraryDirectory' | 'cachesDirectory' | 'tempDirectory';
    /**
     * Extended props for "url" resource type
     */
    urlProps?: PDFViewUrlProps;
    /**
     * A String value. Defines encoding type. Can be one of:
     *   - "utf-8", default
     *   - "utf-16"
     */
    textEncoding?: 'utf-8' | 'utf-16';
    /**
     * A Number value. Fades in the webview (in ms) on load successfully (iOS Only):
     *   - 0.0, default
     */
    fadeInDuration?: number;
    /**
     * A Boolean value. Enables annotations view on Android
     *   - false, default
     */
    enableAnnotations?: boolean;
}
declare class PDFView extends React.Component<PDFViewProps> {
    _viewerRef: any;
    static defaultProps: {
        fadeInDuration: number;
        resourceType: string;
        textEncoding: string;
        urlProps: {};
        enableAnnotations: boolean;
        fileFrom: string;
    };
    onError: (event: any) => void;
    onPageChanged: (event: any) => void;
    onScrolled: (event: any) => void;
    _getCommands: () => any;
    _setViewRef: (ref: any) => void;
    /**
     * A Function. Invoke it when PDF document needs to be reloaded. Use `ref` to
     * access it. Throws an exception in case of errors
     */
    reload(): Promise<void>;
    render(): React.ReactElement;
}
export default PDFView;