@nutrient-sdk/react-native/types/index.d.ts

Nutrient React Native SDK

export default NutrientView;
/**
 * @typedef InstantDocumentData
 * @property { string } jwt The JWT received as part of the web response.
 * @property { string } serverUrl The server URL received as part of the web response.
 */
/**
 * @typedef InstantConfiguration
 * @property { boolean } enableInstantComments Specifies whether adding comment annotations is allowed.
 * @property { boolean } listenToServerChanges Automatically listen for and sync changes from the server.
 * @property { number } delay Delay in seconds before kicking off automatic sync after local changes are made to the ```editableDocument```'s annotations.
 * @property { boolean } syncAnnotations Specifies whether added annotations are automatically synced to the server.
 */
/**
 * @typedef PDFDocumentProperties
 * @property { string } documentId The document ID.
 * @property { number } pageCount The number of pages in the document.
 * @property { boolean } isEncrypted Indicates if the PDF document is encrypted (password protected).
 */
/**
 * Nutrient is a React Native {@link https://reactnative.dev/docs/native-modules-intro|Native Module} implementation used to call iOS and Android methods directly.
 * @hideconstructor
 * @example
 * const Nutrient = NativeModules.Nutrient;
 */
export class Nutrient {
    /**
     * Used to get the current version of the underlying Nutrient SDK.
     * @member versionString
     * @memberof Nutrient
     * @type { string }
     * @example
     * const version = Nutrient.versionString
     */
    versionString: string;
    /**
     * Used to get the document properties of the specified document.
     * @method getDocumentProperties
     * @memberof Nutrient
     * @param { string } documentPath The path to the document.
     * @returns { PDFDocumentProperties } The document properties.
     * @example
     * const properties = Nutrient.getDocumentProperties('path/to/document.pdf');
     */
    getDocumentProperties: (documentPath: string) => PDFDocumentProperties;
    /**
     * Used to set your Nutrient license key for the active platform only, either iOS or Android.
     * Nutrient is commercial software.
     * Each Nutrient license is bound to a specific app bundle ID.
     * Visit {@link https://my.nutrient.io} to get your demo or commercial license key.
     * @method setLicenseKey
     * @memberof Nutrient
     * @param { string | null } [key] Your Nutrient for React Native iOS or Nutrient for React Native Android license key.
     * @returns { boolean } A boolean returning ```true``` if the license key was set, and ```false``` if not.
     * @example
     * Nutrient.setLicenseKey('YOUR_LICENSE_KEY');
     */
    setLicenseKey: (key?: string | null) => boolean;
    /**
     * Used to set the your Nutrient license keys for both platforms.
     * Nutrient is commercial software.
     * Each Nutrient license is bound to a specific app bundle ID.
     * Visit {@link https://my.nutrient.io} to get your demo or commercial license key.
     * @method setLicenseKeys
     * @memberof Nutrient
     * @param { string | null } [androidKey] Your Nutrient for React Native Android license key.
     * @param { string | null } [iosKey] Your Nutrient for React Native iOS license key.
     * @returns { boolean } A boolean returning ```true``` if the license key was set, and ```false``` if not.
     * @example
     * Nutrient.setLicenseKeys('YOUR_ANDROID_LICENSE_KEY', 'YOUR_IOS_LICENSE_KEY');
     */
    setLicenseKeys: (androidKey?: string | null, iosKey?: string | null) => boolean;
    /**
     * Used to present a PDF document.
     * @method present
     * @memberof Nutrient
     * @param { string } documentPath The path to the PDF document to be presented.
     * @param { PDFConfiguration } configuration Configuration object to customize the appearance and behavior of Nutrient. See {@link https://nutrient.io/api/react-native/PDFConfiguration.html} for available options.
     * @returns { Promise<boolean> } A promise returning ```true``` if the document was successfully presented, and ```false``` if not.
     * @example
     * const fileName = 'document.pdf';
     * const exampleDocumentPath =
     * Platform.OS === 'ios' ? 'PDFs/' + fileName
     * : 'file:///android_asset/' + fileName;
     *
     * const configuration: PDFConfiguration = {
     *    pageMode: PDFConfiguration.PageMode.AUTOMATIC,
     *    scrollDirection: PDFConfiguration.ScrollDirection.HORIZONTAL,
     *    enableAnnotationEditing: PDFConfiguration.BooleanType.TRUE,
     *    pageTransition: PDFConfiguration.PageTransition.SCROLL_CONTINUOUS
     * };
     *
     * Nutrient.present(exampleDocumentPath, configuration);
     */
    present: (documentPath: string, configuration: PDFConfiguration) => Promise<boolean>;
    /**
     * Used to dismiss the ```NutrientView```.
     * @method dismiss
     * @memberof Nutrient
     * @returns { Promise<boolean> } A promise returning ```true``` if the view was successfully dismissed, and ```false``` if not.
     * @example
     * Nutrient.dismiss();
     */
    dismiss: () => Promise<boolean>;
    /**
     * Used to set the current page of the document. Starts at 0.
     * @method setPageIndex
     * @memberof Nutrient
     * @param { number } pageIndex The page to transition to.
     * @param { boolean } animated ```true``` if the transition should be animated, and ```false``` otherwise.
     * @returns { Promise<boolean> } A promise returning ```true``` if the page was successfully set, and ```false``` if not.
     * @example
     * Nutrient.setPageIndex(3, false);
     */
    setPageIndex: (pageIndex: number, animated: boolean) => Promise<boolean>;
    /**
     * Used to create a new document with processed annotations, allowing a password to unlock the source document.
     * @method processAnnotations
     * @memberof Nutrient
     * @param { Annotation.Change } annotationChange Specifies how an annotation should be included in the resulting document. See {@link https://nutrient.io/api/react-native/Annotation.html#.Change} for supported options.
     * @param { Array<Annotation.Type> } annotationTypes Specifies the annotation types that should be flattened. See {@link https://nutrient.io/api/react-native/Annotation.html#.Type} for supported types. Use ```Annotation.Type.ALL``` to include all annotation types.
     * @param { string } sourceDocumentPath The source document to use as input.
     * @param { string } processedDocumentPath The path where the output document should be written to.
     * @param { string | null } password The password to unlock the source document. Use ```null``` if not required.
     * @returns { Promise<boolean> } A promise returning ```true``` if the document annotations were successfully flattened, and ```false``` if not.
     * @example
     * const result = await Nutrient.processAnnotations(
     *                      'flatten',
     *                      'all',
     *                      sourceDocumentPath,
     *                      processedDocumentPath,
     *                      password);
     */
    processAnnotations: (annotationChange: Annotation.Change, annotationTypes: Array<Annotation.Type>, sourceDocumentPath: string, processedDocumentPath: string, password: string | null) => Promise<boolean>;
    /**
     * Used to present an Instant PDF document for collaboration.
     * @method presentInstant
     * @memberof Nutrient
     * @param { InstantDocumentData } documentData The Instant document data received entirely from the web response.
     * @param { PDFConfiguration } configuration Configuration object to customize the appearance and behavior of Nutrient. See {@link https://nutrient.io/api/react-native/PDFConfiguration.html} for available options. Also see {@link InstantConfiguration} for additional Instant configuration options.
     * @returns { Promise<boolean> } A promise returning ```true``` if the document was successfully presented, and ```false``` if not.
     * @see {@link https://github.com/PSPDFKit/react-native/blob/5b2716a3f3cd3732c0e5845cc39e28d19b618aa4/samples/Catalog/examples/InstantSynchronization.js#L85C7-L85C7} for an example implementation.
     * @example
     * // Data received from your backend service.
     * const serverResult = await fetch('your-backend-server-url');
     * const documentData = {
     *     jwt: serverResult.jwt,
     *     serverUrl: Constants.InstantServerURL
     * };
     * const configuration: PDFConfiguration = {
     *    enableInstantComments: PDFConfiguration.BooleanType.FALSE,
     *    listenToServerChanges: PDFConfiguration.BooleanType.TRUE,
     *    delay: 1,
     *    syncAnnotations: PDFConfiguration.BooleanType.TRUE,
     * };
     *
     * Nutrient.presentInstant(documentData, configuration);
     */
    presentInstant: (documentData: InstantDocumentData, configuration: PDFConfiguration) => Promise<boolean>;
    /**
     * Delay in seconds before kicking off automatic sync after local changes are made to the ```editableDocument```'s annotations.
     * @method setDelayForSyncingLocalChanges
     * @memberof Nutrient
     * @param { number } delay The delay in seconds.
     */
    setDelayForSyncingLocalChanges: (delay: number) => void;
    /**
     * Automatically listen for and sync changes from the server.
     * @method setListenToServerChanges
     * @memberof Nutrient
     * @param { boolean } listenToServerChanges ```true``` if server changes should be synced automatically, and false ```false``` otherwise.
     */
    setListenToServerChanges: (listenToServerChanges: boolean) => void;
    /**
     * Method used by React Native Native Modules
     * @ignore
     */
    addListener: (eventName: any) => void;
    /**
     * Method used by React Native Native Modules
     * @ignore
     */
    removeListeners: () => void;
    /**
     * Method used by React Native Native Modules
     * @ignore
     * @param { string } event The event name.
     * @param { number } componentId The component ID.
     * @returns { Promise<void> }
     */
    handleListenerAdded: (event: string, componentId: number) => Promise<void>;
    /**
     * Method used by React Native Native Modules
     * @ignore
     * @param { string } event The event name.
     * @param { number } componentId The component ID.
     * @returns { Promise<void> }
     */
    handleListenerRemoved: (event: string, componentId: number) => Promise<void>;
}
/**
 * @typedef BlankPDFConfiguration
 * @property { string } [name] The name of the new document.
 * @property { string } [filePath] The directory where the new document should be stored.
 * @property { number } width The width of the new document.
 * @property { number } height The height of the new document.
 * @property { boolean } override If ```true```, will override existing document with the same name.
 */
/**
 * @typedef PDFTemplatePageSize
 * @property { number } width The width of the page.
 * @property { number } height The height of the page.
 */
/**
 * @typedef PDFTemplatePageMargins
 * @property { number } top The top margin.
 * @property { number } left The left margin.
 * @property { number } right The right margin.
 * @property { number } bottom The bottom margin.
 */
/**
 * @typedef PDFTemplate
 * @property { PDFTemplatePageSize } pageSize The size of the page.
 * @property { string } [backgroundColor] The background color of the page. Can be either a rgba string, for example: rgba(0.871, 0.188, 0.643, 0.5), or standard colors such as ```blue``` or ```yellow```.
 * @property { string } [template] Which template to use. Options are: ```blank```, ```dot5mm```, ```grid5mm```, ```lines5mm``` and ```lines7mm```.
 * @property { number } [rotation] The page rotation, in degrees.
 * @property { PDFTemplatePageMargins } [pageMargins] The page margins.
 */
/**
 * @typedef TemplatePDFConfiguration
 * @property { string } [name] The name of the new document.
 * @property { string } [filePath] The directory where the new document should be stored.
 * @property { Array<PDFTemplate> } templates An array of the templates that should be used to construct the new document.
 * @property { boolean } override If ```true```, will override existing document with the same name.
 */
/**
 * @typedef PDFImage
 * @property { string } imageUri The URI to the image file.
 * @property { string } [position] The image position on the PDF page. Options are: ```top```, ```bottom```, ```left```, ```right```, ```center```.
 * @property { number } [rotation] The page rotation, in degrees.
 * @property { PDFTemplatePageMargins } [pageMargins] The page margins.
 * @property { PDFTemplatePageSize } [pageSize] The size of the page.
 */
/**
 * @typedef ImagePDFConfiguration
 * @property { string } [name] The name of the new document.
 * @property { string } [filePath] The directory where the new document should be stored.
 * @property { Array<PDFImage> } images An array of the images that should be used to construct the new document.
 * @property { boolean } override If ```true```, will override existing document with the same name.
 */
/**
 * @typedef PDFDocumentConfiguration
 * @property { string } documentPath The URI to the existing document.
 * @property { number } [pageIndex] The index of the page that should be used from the document. Starts at 0. If not specified, the entire document will be used.
 */
/**
 * @typedef DocumentPDFConfiguration
 * @property { string } [name] The name of the new document.
 * @property { string } [filePath] The directory where the new document should be stored.
 * @property { Array<PDFDocumentConfiguration> } documents An array of the documents that should be used to construct the new document.
 * @property { boolean } override If ```true```, will override existing document with the same name.
 */
/**
 * @typedef GeneratePDFConfiguration
 * @property { string } [name] The name of the new document.
 * @property { string } [filePath] The directory where the new document should be stored.
 * @property { boolean } override If ```true```, will override existing document with the same name.
 */
/**
 * @typedef GeneratePDFResult
 * @property { string } fileURL The path on the filesystem where the new document is stored.
 */
/**
 * Processor is a React Native {@link https://reactnative.dev/docs/native-modules-intro|Native Module} implementation used to call iOS and Android methods directly.
 * @hideconstructor
 * @example
 * const Processor = NativeModules.RNProcessor;
 */
export class Processor {
    /**
     * Used to generate a new blank PDF document.
     * @method generateBlankPDF
     * @memberof Processor
     * @param { BlankPDFConfiguration } configuration The configuration to generate a new blank PDF document.
     * @returns { Promise<GeneratePDFResult> } A promise containing the path to the newly generated document.
     * @example
     * const configuration = {
     *    name: 'newDocument.pdf',
     *    width: 595,
     *    height: 842,
     *    override: true,
     *  };
     * const { fileURL } = await Processor.generateBlankPDF(configuration);
     */
    generateBlankPDF: (configuration: BlankPDFConfiguration) => Promise<GeneratePDFResult>;
    /**
     * Used to generate a new PDF document from an HTML string.
     * @method generatePDFFromHtmlString
     * @memberof Processor
     * @param { GeneratePDFConfiguration } configuration The configuration to generate a new PDF document.
     * @param { string } html The HTML string from which the document should be generated.
     * @returns { Promise<GeneratePDFResult> } A promise containing the path to the newly generated document.
     * @example
     * const fileName = 'newDocument.pdf';
     * const { tempDir } = await Processor.getTemporaryDirectory();
     * const documentPath = `${tempDir}/${fileName}`;
     *
     * const htmlString = `<html lang="en"><head></head><body><h1>PDF generated from HTML</h1></body></html>`;
     * const configuration = {
     *    filePath: documentPath,
     *    override: true,
     *  };
     * const { fileURL } = await Processor.generatePDFFromHtmlString(configuration, htmlString);
     */
    generatePDFFromHtmlString: (configuration: GeneratePDFConfiguration, html: string) => Promise<GeneratePDFResult>;
    /**
     * Used to generate a new PDF document from an HTML URL.
     * @method generatePDFFromHtmlURL
     * @memberof Processor
     * @param { GeneratePDFConfiguration } configuration The configuration to generate a new PDF document.
     * @param { string } url The origin URL from which the document should be generated.
     * @returns { Promise<GeneratePDFResult> } A promise containing the path to the newly generated document.
     * @example
     * const fileName = 'newDocument.pdf';
     * const { tempDir } = await Processor.getTemporaryDirectory();
     * const documentPath = `${tempDir}/${fileName}`;
  
     * const url = `https://www.nutrient.io`;
     * const configuration = {
     *    documentPath: documentPath,
     *    override: true,
     *  };
     * const { fileURL } = await Processor.generatePDFFromHtmlURL(configuration, url);
     */
    generatePDFFromHtmlURL: (configuration: GeneratePDFConfiguration, url: string) => Promise<GeneratePDFResult>;
    /**
     * Used to generate a new PDF document from a template.
     * @method generatePDFFromTemplate
     * @memberof Processor
     * @param { TemplatePDFConfiguration } configuration The configuration to generate a new PDF document.
     * @returns { Promise<GeneratePDFResult> } A promise containing the path to the newly generated document.
     * @example
     * const configuration = {
     *    filePath: fileURL,
     *    override: true,
     *     templates: [
     *       {
     *         pageSize: { width: 540, height: 846 },
     *         backgroundColor: 'rgba(0.871, 0.188, 0.643, 0.5)',
     *         template: 'lines7mm',
     *         rotation: 90,
     *         pageMargins: { top: 10, left: 10, right: 10, bottom: 10 },
     *       },
     *       {
     *         pageSize: { width: 540, height: 846 },
     *         backgroundColor: 'yellow',
     *         template: 'dot5mm',
     *       },
     *     ],
     *   };
     * const { fileURL } = await Processor.generatePDFFromTemplate(configuration);
     */
    generatePDFFromTemplate: (configuration: TemplatePDFConfiguration) => Promise<GeneratePDFResult>;
    /**
     * Used to generate a new PDF document from images.
     * @method generatePDFFromImages
     * @memberof Processor
     * @param { ImagePDFConfiguration } configuration The configuration to generate a new PDF document.
     * @returns { Promise<GeneratePDFResult> } A promise containing the path to the newly generated document.
     * @example
     * export const exampleImage = 'PSPDFKit_Image_Example.jpg';
     * export const exampleImagePath =
     * Platform.OS === 'ios' ? 'PDFs/' + exampleImage : 'file:///android_asset/' + exampleImage;
     *
     * // Helper method to get iOS bundlePath
     * let globalPath = getMainBundlePath(exampleImagePath.toString());
     * const configuration = {
     *     name: 'newDocument.pdf',
     *     images: [
     *       {
     *         imageUri: Platform.OS === 'ios' ? globalPath : exampleImagePath,
     *         position: 'center',
     *       },
     *     ],
     *     override: true,
     *   };
     * const { fileURL } = await Processor.generatePDFFromImages(configuration);
     */
    generatePDFFromImages: (configuration: ImagePDFConfiguration) => Promise<GeneratePDFResult>;
    /**
     * Used to generate a new PDF document from existing PDF documents.
     * @method generatePDFFromDocuments
     * @memberof Processor
     * @param { DocumentPDFConfiguration } configuration The configuration to generate a new PDF document.
     * @returns { Promise<GeneratePDFResult> } A promise containing the path to the newly generated document.
     * @example
     * const fileName = 'newDocument.pdf';
     * const { tempDir } = await Processor.getTemporaryDirectory();
     * const documentPath = `${tempDir}/${fileName}`;
     *
     * const exampleDocument = 'PSPDFKit_Image_Example.jpg';
     * const exampleDocumentPath =
     * Platform.OS === 'ios' ? 'PDFs/' + exampleImage : 'file:///android_asset/' + exampleDocument;
     *
     * // Helper method to get iOS bundlePath
     * let globalPath = getMainBundlePath(exampleDocumentPath.toString());
     *
     * const configuration = {
     *     filePath: documentPath,
     *     name: fileName,
     *     documents: [
     *       {
     *         documentPath:
     *           Platform.OS === 'ios' ? globalPath : exampleDocumentPath,
     *         pageIndex: 5,
     *       },
     *       {
     *         documentPath:
     *           Platform.OS === 'ios' ? globalPath : exampleDocumentPath,
     *         pageIndex: 8,
     *       },
     *     ],
     *     override: true,
     *   };
     * const { fileURL } = await Processor.generatePDFFromDocuments(configuration);
     */
    generatePDFFromDocuments: (configuration: DocumentPDFConfiguration) => Promise<GeneratePDFResult>;
    /**
     * A helper method to get a temporary directory where the document can be written to.
     * @method getTemporaryDirectory
     * @memberof Processor
     * @returns { Promise<any> } A promise containing the path to the temporary directory that can be used for output.
     * @example
     * const { fileURL } = await Processor.getTemporaryDirectory();
     */
    getTemporaryDirectory: () => Promise<any>;
}
export type Props = {
    /**
     * The path to the PDF file that should be displayed.
     */
    document: string;
    /**
     * Configuration object to customize the appearance and behavior of Nutrient. See {@link https://nutrient.io/api/react-native/PDFConfiguration.html} for available options.
     */
    configuration?: PDFConfiguration;
    /**
     * Toolbar object to customize the toolbar appearance and behaviour.
     */
    toolbar?: Toolbar;
    /**
     * Object to customize the menu shown when selecting an annotation.
     */
    annotationContextualMenu?: AnnotationContextualMenu;
    /**
     * Page index of the document that will be shown. Starts at 0.
     */
    pageIndex?: number;
    /**
     * Controls whether a navigation bar is created and shown or not. Navigation bar is shown by default (```false```).
     */
    hideNavigationBar?: boolean;
    /**
     * Specifies whether the close button should be shown in the navigation bar. Disabled by default (```false```). Only applies when the ```NutrientView``` is presented modally. Will call ```onCloseButtonPressed``` when tapped if a callback was provided. If ```onCloseButtonPressed``` wasn't provided, ```NutrientView``` will automatically be dismissed when modally presented.
     */
    showCloseButton?: boolean;
    /**
     * Controls whether or not the default action for tapped annotations is processed. Defaults to processing the action (```false```).
     */
    disableDefaultActionForTappedAnnotations?: boolean;
    /**
     * Controls whether or not the document will automatically be saved. Defaults to automatically saving (```false```). Deprecated since Nutrient React Native SDK 4.0. Use ```disableDocumentEditing``` on the ```PDFConfiguration``` object instead.
     */
    disableAutomaticSaving?: boolean;
    /**
     * Controls the author name that's set for new annotations. If not set and the user hasn't specified it before, the user will be asked and the result will be saved. The value set here will be persisted and the user won't be asked, even if this isn't set the next time.
     */
    annotationAuthorName?: string;
    /**
     * Specifies what is written back to the original image URL when the receiver is saved. If this property is ```flattenAndEmbed```, then this allows for changes made to the image to be saved as metadata in the original file. If the same file is reopened, all previous changes made will remain editable. If this property is ```flatten```, the changes are simply written to the image, and will not be editable when reopened. Available options are: ```flatten``` or ```flattenAndEmbed```.
     */
    imageSaveMode?: string;
    /**
     * Callback that's called when the user tapped the close button. If you provide this function, you need to handle dismissal yourself. If you don't provide this function, ```NutrientView``` will be automatically dismissed. Only applies when the ```NutrientView``` is presented modally.
     */
    onCloseButtonPressed?: Function;
    /**
     * Callback that's called when the document is loaded in the ```NutrientView```.
     */
    onDocumentLoaded?: Function;
    /**
     * Callback that's called when the ```NutrientView``` is ready. Use this callback start interacting with the ```PDFDocument``` object. Does not indicate a successful document load - use ```NotificationCenter.DocumentEvent.LOADED``` to monitor this.
     */
    onReady?: Function;
    /**
     * Callback that's called when the document failed to load.
     */
    onDocumentLoadFailed?: Function;
    /**
     * Callback that's called when the document is saved.
     */
    onDocumentSaved?: Function;
    /**
     * Callback that's called when the document fails to save.
     */
    onDocumentSaveFailed?: Function;
    /**
     * Callback that's called when an annotation is tapped.
     */
    onAnnotationTapped?: Function;
    /**
     * Callback that's called when an annotation is added, changed, or removed.
     */
    onAnnotationsChanged?: Function;
    /**
     * Callback that's called when the state of the ```NutrientView``` changes.
     */
    onStateChanged?: Function;
    /**
     * Callback that's called when a custom toolbar button is tapped.
     */
    onCustomToolbarButtonTapped?: Function;
    /**
     * Callback that's called when a custom annotation menu item is tapped.
     */
    onCustomAnnotationContextualMenuItemTapped?: Function;
    /**
     * The tag used to identify a single PdfFragment in the view hierarchy. This needs to be unique in the view hierarchy.
     */
    fragmentTag?: string;
    /**
     * Used to specify a custom grouping for the menu items in the annotation creation toolbar.
     */
    menuItemGrouping?: any[];
    /**
     * Sets the left bar button items. Note: The same button item cannot be added to both the left and right bar button items simultaneously. See {@link https://github.com/PSPDFKit/react-native/blob/master/ios/Converters/RCTConvert+UIBarButtonItem.m} for supported button items.
     */
    leftBarButtonItems?: Array<string>;
    /**
     * Sets the right bar button items. Note: The same button item cannot be added to both the left and right bar button items simultaneously. See {@link https://github.com/PSPDFKit/react-native/blob/master/ios/Converters/RCTConvert+UIBarButtonItem.m} for supported button items.
     */
    rightBarButtonItems?: Array<string>;
    /**
     * Used to specify a custom toolbar title on iOS by setting the ```title``` property of the ```PSPDFViewController```. Note: You need to set ```documentLabelEnabled```, ```useParentNavigationBar```, and ```allowToolbarTitleChange``` to ```false``` in your configuration before setting the custom title. Deprecated since Nutrient React Native SDK 4.0. Use ```toolbarTitle``` on the ```PDFConfiguration``` object instead.
     */
    toolbarTitle?: string;
    /**
     * Used to customize the toolbar menu items for Android. See {@link https://github.com/PSPDFKit/react-native/blob/master/android/src/main/java/com/pspdfkit/react/ToolbarMenuItemsAdapter.java} for supported toolbar menu items.
     */
    toolbarMenuItems?: Array<string>;
    /**
     * When set to ```true```, the toolbar integrated into the ```NutrientView``` will display a back button in the top-left corner. Android only.
     */
    showNavigationButtonInToolbar?: boolean;
    /**
     * If ```showNavigationButtonInToolbar``` is set to ```true```, this callback will notify you when the back button is tapped.
     */
    onNavigationButtonClicked?: Function;
    /**
     * Used to specify the available font names in the font picker. Note on iOS: You need to set the desired font family names as ```UIFontDescriptor```. See {@link https://developer.apple.com/documentation/uikit/uifontdescriptor?language=objc} for more information. See {@link https://github.com/PSPDFKit/react-native/blob/master/samples/Catalog/examples/CustomFontPicker.tsx}
     */
    availableFontNames?: Array<string>;
    /**
     * Used to specify the current selected font in the font picker. Note on iOS: You need to set the desired font family names as ```UIFontDescriptor```. See {@link https://developer.apple.com/documentation/uikit/uifontdescriptor?language=objc} for more information. See {@link https://github.com/PSPDFKit/react-native/blob/master/samples/Catalog/examples/CustomFontPicker.tsx}
     */
    selectedFontName?: string;
    /**
     * Used to show or hide the downloadable fonts section in the font picker. Defaults to ```true```, showing the downloadable fonts. See {@link https://developer.apple.com/documentation/uikit/uifontdescriptor?language=objc} for more information. See {@link https://github.com/PSPDFKit/react-native/blob/master/samples/Catalog/examples/CustomFontPicker.tsx}
     */
    showDownloadableFonts?: boolean;
    /**
     * The annotation preset configuration. See {@link https://nutrient.io/api/react-native/Annotation.html#.AnnotationPresetConfiguration} for available options.
     */
    annotationPresets?: AnnotationPresetConfiguration;
    /**
     * Used to show or hide the main toolbar on Android.
     */
    hideDefaultToolbar?: boolean;
    /**
     * Used to style the React Native component.
     */
    style?: any;
};
export type InstantDocumentData = {
    /**
     * The JWT received as part of the web response.
     */
    jwt: string;
    /**
     * The server URL received as part of the web response.
     */
    serverUrl: string;
};
export type InstantConfiguration = {
    /**
     * Specifies whether adding comment annotations is allowed.
     */
    enableInstantComments: boolean;
    /**
     * Automatically listen for and sync changes from the server.
     */
    listenToServerChanges: boolean;
    /**
     * Delay in seconds before kicking off automatic sync after local changes are made to the ```editableDocument```'s annotations.
     */
    delay: number;
    /**
     * Specifies whether added annotations are automatically synced to the server.
     */
    syncAnnotations: boolean;
};
export type PDFDocumentProperties = {
    /**
     * The document ID.
     */
    documentId: string;
    /**
     * The number of pages in the document.
     */
    pageCount: number;
    /**
     * Indicates if the PDF document is encrypted (password protected).
     */
    isEncrypted: boolean;
};
export type BlankPDFConfiguration = {
    /**
     * The name of the new document.
     */
    name?: string;
    /**
     * The directory where the new document should be stored.
     */
    filePath?: string;
    /**
     * The width of the new document.
     */
    width: number;
    /**
     * The height of the new document.
     */
    height: number;
    /**
     * If ```true```, will override existing document with the same name.
     */
    override: boolean;
};
export type PDFTemplatePageSize = {
    /**
     * The width of the page.
     */
    width: number;
    /**
     * The height of the page.
     */
    height: number;
};
export type PDFTemplatePageMargins = {
    /**
     * The top margin.
     */
    top: number;
    /**
     * The left margin.
     */
    left: number;
    /**
     * The right margin.
     */
    right: number;
    /**
     * The bottom margin.
     */
    bottom: number;
};
export type PDFTemplate = {
    /**
     * The size of the page.
     */
    pageSize: PDFTemplatePageSize;
    /**
     * The background color of the page. Can be either a rgba string, for example: rgba(0.871, 0.188, 0.643, 0.5), or standard colors such as ```blue``` or ```yellow```.
     */
    backgroundColor?: string;
    /**
     * Which template to use. Options are: ```blank```, ```dot5mm```, ```grid5mm```, ```lines5mm``` and ```lines7mm```.
     */
    template?: string;
    /**
     * The page rotation, in degrees.
     */
    rotation?: number;
    /**
     * The page margins.
     */
    pageMargins?: PDFTemplatePageMargins;
};
export type TemplatePDFConfiguration = {
    /**
     * The name of the new document.
     */
    name?: string;
    /**
     * The directory where the new document should be stored.
     */
    filePath?: string;
    /**
     * An array of the templates that should be used to construct the new document.
     */
    templates: Array<PDFTemplate>;
    /**
     * If ```true```, will override existing document with the same name.
     */
    override: boolean;
};
export type PDFImage = {
    /**
     * The URI to the image file.
     */
    imageUri: string;
    /**
     * The image position on the PDF page. Options are: ```top```, ```bottom```, ```left```, ```right```, ```center```.
     */
    position?: string;
    /**
     * The page rotation, in degrees.
     */
    rotation?: number;
    /**
     * The page margins.
     */
    pageMargins?: PDFTemplatePageMargins;
    /**
     * The size of the page.
     */
    pageSize?: PDFTemplatePageSize;
};
export type ImagePDFConfiguration = {
    /**
     * The name of the new document.
     */
    name?: string;
    /**
     * The directory where the new document should be stored.
     */
    filePath?: string;
    /**
     * An array of the images that should be used to construct the new document.
     */
    images: Array<PDFImage>;
    /**
     * If ```true```, will override existing document with the same name.
     */
    override: boolean;
};
export type PDFDocumentConfiguration = {
    /**
     * The URI to the existing document.
     */
    documentPath: string;
    /**
     * The index of the page that should be used from the document. Starts at 0. If not specified, the entire document will be used.
     */
    pageIndex?: number;
};
export type DocumentPDFConfiguration = {
    /**
     * The name of the new document.
     */
    name?: string;
    /**
     * The directory where the new document should be stored.
     */
    filePath?: string;
    /**
     * An array of the documents that should be used to construct the new document.
     */
    documents: Array<PDFDocumentConfiguration>;
    /**
     * If ```true```, will override existing document with the same name.
     */
    override: boolean;
};
export type GeneratePDFConfiguration = {
    /**
     * The name of the new document.
     */
    name?: string;
    /**
     * The directory where the new document should be stored.
     */
    filePath?: string;
    /**
     * If ```true```, will override existing document with the same name.
     */
    override: boolean;
};
export type GeneratePDFResult = {
    /**
     * The path on the filesystem where the new document is stored.
     */
    fileURL: string;
};
/**
 * NutrientView is a React Native component used to view PDF documents on iOS and Android.
 * @augments {React.Component<Props, *>}
 * @hideconstructor
 * @example
 * <NutrientView
 *      document={DOCUMENT_PATH}
 *      configuration={{
 *        showThumbnailBar: PDFConfiguration.ShowThumbnailBar.SCROLLABLE,
 *        pageTransition: PDFConfiguration.PageTransition.SCROLL_CONTINUOUS,
 *        scrollDirection: PDFConfiguration.ScrollDirection.VERTICAL,
 *      }}
 *      ref={this.pdfRef}
 *      fragmentTag="PDF1"
 *      style={{ flex: 1 }}
 *    />
 */
declare class NutrientView extends React.Component<Props, any, any> {
    static _isNewArchitecture: any;
    static _FabricComponent: any;
    static _getArchitectureInfo(): {
        isNewArchitecture: any;
        FabricComponent: any;
    };
    constructor(props: Props);
    constructor(props: Props, context: any);
    /**
     * @ignore
     */
    refs: any;
    /**
     * @ignore
     */
    _nextRequestId: number;
    /**
     * @ignore
     */
    _requestMap: Map<any, any>;
    /**
     * @ignore
     */
    _pdfDocument: any;
    /**
     * @ignore
     */
    _notificationCenter: any;
    /**
     * @ignore
     */
    _componentRef: React.RefObject<any>;
    _fabricRef: React.RefObject<any>;
    render(): React.JSX.Element;
    /**
     * @ignore
     */
    _onStateChanged: (event: any) => void;
    /**
     * @ignore
     */
    _onDocumentLoaded: (event: any) => void;
    /**
     * @ignore
     */
    _onDocumentSaved: (event: any) => void;
    /**
     * @ignore
     */
    _onDocumentSaveFailed: (event: any) => void;
    /**
     * @ignore
     */
    _onDocumentLoadFailed: (event: any) => void;
    /**
     * @ignore
     */
    _onAnnotationTapped: (event: any) => void;
    /**
     * @ignore
     */
    _onAnnotationsChanged: (event: any) => void;
    /**
     * @ignore
     */
    _onNavigationButtonClicked: (event: any) => void;
    /**
     * @ignore
     */
    _onDataReturned: (event: any) => void;
    /**
     * @ignore
     */
    _onCustomToolbarButtonTapped: (event: any) => void;
    /**
     * @ignore
     */
    _onCustomAnnotationContextualMenuItemTapped: (event: any) => void;
    /**
     * @ignore
     */
    _onReady: (event: any) => void;
    /**
     * Enters annotation creation mode, showing the annotation creation toolbar.
     * @method enterAnnotationCreationMode
     * @param { Annotation.Type } [annotationType] The annotation type that should be pre-selected when entering annotation creation mode.
     * @example
     * this.pdfRef.current.enterAnnotationCreationMode();
     * @memberof NutrientView
     */
    enterAnnotationCreationMode: (annotationType?: Annotation.Type) => any;
    /**
     * Exits the currently active mode, hiding all toolbars.
     * @method exitCurrentlyActiveMode
     * @example
     * this.pdfRef.current.exitCurrentlyActiveMode();
     * @memberof NutrientView
     */
    exitCurrentlyActiveMode: () => any;
    /**
     * Saves the document that's currently open.
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().save()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.save|save()}.
     * @method saveCurrentDocument
     * @memberof NutrientView
     * @example
     * const result = await this.pdfRef.current.saveCurrentDocument();
     *
     * @returns { Promise<boolean> } A promise resolving to ```true``` if the document was saved, and ```false``` if not.
     */
    saveCurrentDocument: () => Promise<boolean>;
    /**
     * Get the current PDF document.
     * @method getDocument
     * @example
     * const document = this.pdfRef.current?.getDocument();
     * @see {@link https://nutrient.io/api/react-native/PDFDocument.html} for available methods.
     * @memberof NutrientView
     * @returns { PDFDocument } A reference to the document that is currently loaded in the NutrientView component.
     */
    getDocument(): PDFDocument;
    /**
     * Get the current Notification Center.
     * @method getNotificationCenter
     * @example
     * const document = this.pdfRef.current?.getNotificationCenter();
     * @see {@link https://nutrient.io/api/react-native/NotificationCenter.html} for available methods.
     * @memberof NutrientView
     * @returns { NotificationCenter } A reference to the Notification Center that can be used to subscribe and unsubscribe from events.
     */
    getNotificationCenter(): NotificationCenter;
    /**
     * @method clearSelectedAnnotations
     * @memberof NutrientView
     * @description Clears all currently selected Annotations.
     * @example
     * const result = await this.pdfRef.current?.clearSelectedAnnotations();
     * @returns { Promise<any> } A promise containing the result of the operation. ```true``` if the annotations selection were cleared, ```false``` otherwise.
     */
    clearSelectedAnnotations: () => Promise<any>;
    /**
     * @method selectAnnotations
     * @memberof NutrientView
     * @param { object } annotations An array of the annotations to select in Instant JSON format.
     * @param { boolean } [showContextualMenu] Whether the annotation contextual menu should be shown after selection.
     * @description Select one or more annotations.
     * @example
     * const result = await this.pdfRef.current?.selectAnnotations(annotations);
     * @returns { Promise<boolean> } A promise containing the result of the operation. ```true``` if the annotations were selected, ```false``` otherwise.
     */
    selectAnnotations: (annotations: object, showContextualMenu?: boolean) => Promise<boolean>;
    /**
     * Gets all annotations of the given type from the specified page.
     *
     * @method getAnnotations
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().getAnnotations()``` or ```getAnnotationsForPage()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.getAnnotations|getAnnotations()} and {@link https://nutrient.io/api/react-native/PDFDocument.html#.getAnnotationsForPage|getAnnotationsForPage()}.
     * @memberof NutrientView
     * @param { number } pageIndex The page index to get the annotations for, starting at 0.
     * @param { string } [type] The type of annotations to get. If not specified or ```null```, all annotation types will be returned.
     * @example
     * const result = await this.pdfRef.current.getAnnotations(3, 'pspdfkit/ink');
     * @see {@link https://nutrient.io/guides/web/json/schema/annotations/} for supported types.
     *
     * @returns { Promise } A promise containing an object with an array of InstantJSON objects.
     */
    getAnnotations: (pageIndex: number, type?: string) => Promise<any>;
    /**
     * Adds a new annotation to the current document.
     *
     * @method addAnnotation
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().addAnnotations()``` instead.
     * @memberof NutrientView
     * @param { object } annotation The InstantJSON of the annotation to add.
     * @example
     * const result = await this.pdfRef.current.addAnnotation(annotationJSON);
     * @see {@link https://nutrient.io/guides/web/json/schema/annotations/} for document JSON structure.
     *
     * @returns { Promise<boolean> } A promise resolving to ```true``` if the annotation was added successfully, and ```false``` if an error occurred.
     */
    addAnnotation: (annotation: object) => Promise<boolean>;
    /**
     * Removes an existing annotation from the current document.
     *
     * @method removeAnnotation
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().removeAnnotations()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.removeAnnotations|removeAnnotations()}.
     * @memberof NutrientView
     * @param { object } annotation The InstantJSON of the annotation to remove.
     * @example
     * const result = await this.pdfRef.current.removeAnnotation(instantJSON);
     *
     * @returns { Promise } A promise resolving to ```true``` if the annotation was removed successfully, and ```false``` if the annotation couldn't be found or an error occurred.
     */
    removeAnnotation: (annotation: object) => Promise<any>;
    /**
     * Removes the supplied document InstantJSON from the current document.
     *
     * @method removeAnnotations
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().removeAnnotations()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.removeAnnotations|removeAnnotations()}.
     * @memberof NutrientView
     * @param { object } annotation The InstantJSON of the annotations to remove.
     * @example
     * const result = await this.pdfRef.current.removeAnnotations(instantJSON);
     *
     * @returns { Promise } A promise resolving to ```true``` if the annotations were removed successfully, and ```false``` if the annotations couldn't be found or an error occurred.
     */
    removeAnnotations: (annotations: any) => Promise<any>;
    /**
     * Gets all unsaved changes to annotations.
     *
     * @method getAllUnsavedAnnotations
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().getAllUnsavedAnnotations()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.getAllUnsavedAnnotations|getAllUnsavedAnnotations()}.
     * @memberof NutrientView
     * @returns { Promise } A promise containing document InstantJSON.
     * @see {@link https://nutrient.io/guides/android/current/importing-exporting/instant-json/#instant-document-json-api-a56628} for more information.
     */
    getAllUnsavedAnnotations: () => Promise<any>;
    /**
     * Gets all annotations of the given type.
     *
     * @method getAllAnnotations
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().getAnnotations()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.getAnnotations|getAnnotations()}.
     * @memberof NutrientView
     * @param { string } [type] The type of annotations to get. If not specified or ```null```, all annotation types will be returned.
     * @see {@link https://nutrient.io/guides/web/json/schema/annotations/} for supported types.
     * @example
     * const result = await this.pdfRef.current.getAllAnnotations('all');
     * // result: {'annotations' : [instantJson]}
     *
     * @returns { Promise } A promise containing an object with an array of InstantJSON objects.
     */
    getAllAnnotations: (type?: string) => Promise<any>;
    /**
     * Applies the supplied document InstantJSON to the current document.
     *
     * @method addAnnotations
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().addAnnotations()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.addAnnotations|addAnnotations()}.
     * @memberof NutrientView
     * @param { object } annotations The document InstantJSON to apply to the current document.
     * @example
     * const result = await this.pdfRef.current.addAnnotations(annotationsJSON);
     * @see {@link https://nutrient.io/guides/web/json/schema/annotations/} for document JSON structure.
     *
     * @returns { Promise<boolean> } A promise resolving to ```true``` if the annotations were added successfully, and ```false``` if an error occurred.
     */
    addAnnotations: (annotations: object) => Promise<boolean>;
    /**
     * Sets the flags of the specified annotation.
     *
     * @method setAnnotationFlags
     * @memberof NutrientView
     * @param { string } uuid The UUID of the annotation to update.
     * @param { Annotation.Flags[] } flags The flags to apply to the annotation.
     * @deprecated Since Nutrient React Native SDK 4.0. Use ```this.pdfRef.current?.getDocument().setAnnotationFlags()``` instead.
     * @example
     * const result = await this.pdfRef.current.setAnnotationFlags('bb61b1bf-eacd-4227-a5bf-db205e591f5a', ['locked', 'hidden']);
     *
     * @returns { Promise<boolean> } A promise resolving to ```true``` if the annotations were added successfully, and ```false``` if an error occurred.
     */
    setAnnotationFlags: (uuid: string, flags: Annotation.Flags[]) => Promise<boolean>;
    /**
     * Gets the flags for the specified annotation.
     *
     * @method getAnnotationFlags
     * @memberof NutrientView
     * @param { string } uuid The UUID of the annotation to query.
     * @deprecated Since Nutrient React Native SDK 4.0. Use ```this.pdfRef.current?.getDocument().getAnnotationFlags()``` instead.
     * @example
     * const flags = await this.pdfRef.current.getAnnotationFlags('bb61b1bf-eacd-4227-a5bf-db205e591f5a');
     *
     * @returns { Promise<Annotation.Flags[]> } A promise containing the flags of the specified annotation.
     */
    getAnnotationFlags: (uuid: string) => Promise<Annotation.Flags[]>;
    /**
     * Imports the supplied XFDF file into the current document.
     *
     * @method importXFDF
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().importXFDF()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.importXFDF|importXFDF()}.
     * @memberof NutrientView
     * @param { string } filePath The path to the XFDF file to import.
     * @example
     * const result = await this.pdfRef.current.importXFDF('path/to/XFDF.xfdf');
     *
     * @returns { Promise<any> } A promise containing an object with the result. ```true``` if the xfdf file was imported successfully, and ```false``` if an error occurred.
     */
    importXFDF: (filePath: string) => Promise<any>;
    /**
     * Exports the annotations from the current document to a XFDF file.
     *
     * @method exportXFDF
     * @deprecated Since Nutrient React Native SDK 2.12. Use ```this.pdfRef.current?.getDocument().exportXFDF()``` instead.
     * See {@link https://nutrient.io/api/react-native/PDFDocument.html#.exportXFDF|exportXFDF()}.
     * @memberof NutrientView
     * @param { string } filePath The path where the XFDF file should be exported to.
     * @example
     * const result = await this.pdfRef.current.exportXFDF('path/to/XFDF.xfdf');
     *
     * @returns { Promise<any> } A promise containing an object with the exported file path and result. ```true``` if the xfdf file was exported successfully, and ```false``` if an error occurred.
     */
    exportXFDF: (filePath: string) => Promise<any>;
    /**
     * @typedef FormFieldResult
     * @property { string } [formElement] The form field value
     * @prop