@tobyt/expo-pdf-markup - v0.6.1
    Preparing search index...

    Type Alias ExpoPdfMarkupViewProps

    type ExpoPdfMarkupViewProps = {
        annotationColor?: string;
        annotationFontFamily?: string;
        annotationLineWidth?: number;
        annotationMode?: AnnotationMode;
        annotations?: string;
        backgroundColor?: string;
        onAnnotationsChanged?: (
            event: { nativeEvent: { annotations: string } },
        ) => void;
        onError?: (event: { nativeEvent: { message: string } }) => void;
        onLoadComplete?: (event: { nativeEvent: { pageCount: number } }) => void;
        onPageChanged?: (
            event: {
                nativeEvent: {
                    page: number;
                    pageCount: number;
                    pageHeight: number;
                    pageWidth: number;
                };
            },
        ) => void;
        onTextInputRequested?: (
            request: TextInputRequest,
        ) => Promise<string | null>;
        page?: number;
        source: string;
        style?: StyleProp<ViewStyle>;
    }
    Index

    Properties

    annotationColor? annotationFontFamily? annotationLineWidth? annotationMode? annotations? backgroundColor? onAnnotationsChanged? onError? onLoadComplete? onPageChanged? onTextInputRequested? page? source style?

    Properties

    annotationColor?: string

    Colour applied to new annotations, as a CSS colour string (e.g. '#FF0000').

    annotationFontFamily?: string

    Default font family for new text annotations. Platform-specific:

    • iOS: PostScript name ("Georgia", "Courier") or undefined for system font (San Francisco)
    • Android: React Native / Expo font family name ("Montserrat-Regular", "serif") or undefined for default sans-serif
    • Web: CSS font family ("Georgia, serif") or undefined for sans-serif
    annotationLineWidth?: number

    Stroke width in points applied to new ink annotations.

    annotationMode?: AnnotationMode

    Active annotation tool. Defaults to 'none' (view-only).

    annotations?: string

    Serialised AnnotationsData JSON string to load when the document opens.

    backgroundColor?: string

    Background colour shown behind the PDF pages.

    onAnnotationsChanged?: (event: { nativeEvent: { annotations: string } }) => void

    Fired after annotations are created or edited. annotations is a serialised AnnotationsData JSON string.

    onError?: (event: { nativeEvent: { message: string } }) => void

    Fired when the document fails to load.

    onLoadComplete?: (event: { nativeEvent: { pageCount: number } }) => void

    Fired once the document has finished loading.

    onPageChanged?: (
        event: {
            nativeEvent: {
                page: number;
                pageCount: number;
                pageHeight: number;
                pageWidth: number;
            };
        },
    ) => void

    Fired when the visible page changes.

    onTextInputRequested?: (request: TextInputRequest) => Promise<string | null>

    Optional async callback for the text annotation tool. When provided, this is called instead of the native platform dialog (UIAlertController / AlertDialog) when the user taps to place a text annotation. When editing an existing text annotation, request.currentText is populated and request.mode is 'edit'. Return the text string to create/update the annotation, or null to cancel.

    Optionalpage

    page?: number

    0-based page number to display. Can be used to restore scroll position on orientation change.

    source: string

    Absolute local file path of the PDF to display.

    style?: StyleProp<ViewStyle>

    Settings

    Member Visibility

    On This Page

    Properties