Recipedia API Documentationv2.28.5
GitHub
    Preparing search index...

    Interface UseRecipeOCRReturn

    Return value of the useRecipeOCR hook.

    Provides OCR state management, modal controls, image handling, and field extraction functionality.

    interface UseRecipeOCRReturn {
        modalField: undefined | recipeColumnsNames;
        isProcessingOcrExtraction: boolean;
        openModalForField: (field: recipeColumnsNames) => void;
        closeModal: () => void;
        fillOneField: (uri: string, field: recipeColumnsNames) => Promise<void>;
        addImageUri: (uri: string) => void;
    }
    Index

    Properties

    modalField isProcessingOcrExtraction openModalForField closeModal fillOneField addImageUri

    Properties

    modalField: undefined | recipeColumnsNames

    Currently active recipe field for OCR modal, or undefined if modal is closed

    isProcessingOcrExtraction: boolean

    Whether OCR extraction is currently in progress

    openModalForField: (field: recipeColumnsNames) => void

    Opens the OCR modal for a specific recipe field

    closeModal: () => void

    Closes the OCR modal

    fillOneField: (uri: string, field: recipeColumnsNames) => Promise<void>

    Extracts data from an image for a specific recipe field and updates recipe state

    addImageUri: (uri: string) => void

    Adds a new image URI to the available OCR images

    Settings
    Member Visibility
    On This Page
    PropertiesmodalFieldisProcessingOcrExtractionopenModalForFieldcloseModalfillOneFieldaddImageUri