Referencia

#Referencia

`<MarkpdfProvider>`

import { MarkpdfProvider } from "@markpdf/react";

<MarkpdfProvider apiKey="YOUR_API_KEY" baseUrl="https://api.markpdf.tech">
  {children}
</MarkpdfProvider>

string

requerido

Tu tecla API. Se pasa tal cual a new MarkpdfClient().

string

predeterminado:"https://api.markpdf.tech"

URL base de API.

ReactNode

requerido

Árbol de componentes con acceso al cliente mediante useMarkpdf()/useConvertFile().

El cliente se memoriza con useMemo según apiKey/baseUrl, por lo que no se recrea en cada renderizado.

`useMarkpdf()`

function useMarkpdf(): MarkpdfClient

Devuelve el recurso compartido MarkpdfClient creado por MarkpdfProvider. Lanza un Error si se llama fuera de un <MarkpdfProvider>. Expone todos los métodos documentados en la referencia de Node.js/TypeScript SDK: convertFile, convertFromUrl, convertStream, pdfIndex, getJob.

`useConvertFile()`

function useConvertFile(): {
  convert: (file: File, options?: ConvertOptions) => Promise<ConvertResult | undefined>;
  reset: () => void;
  status: "idle" | "uploading" | "converting" | "success" | "error";
  progress: number;      // 0-100, solo vávavalid durante "uploading"
  markdown: string | null;
  json: JsonResult | null;
  error: MarkpdfError | null;
}

Enganche para cargar un File/Blob con progreso, respaldado por XMLHttpRequest contra POST /convert (multiparte). Debe usarse dentro de <MarkpdfProvider>.

`convert(file, options)`

File

requerido

Archivo seleccionado por el usuario (de <input type=\"file\">, arrastrar y soltar, etc.).

ConvertOptions

Devuelve una promesa que se resuelve en Markdown (string) o el objeto JsonResult (si responseFormat: "json").

`status` máquina de estado

Estado	SIGNIFICADO
`"idle"`	No hay conversión en curso.
`"uploading"`	Subiendo el archivo; `progress` está actualizado.
`"converting"`	Carga completa (100%), el servidor está procesando.
`"success"`	Conversión completa; `markdown` o `json` están completos.
`"error"`	Fallido; `error` está lleno.

`reset()`

Devuelve el estado a "idle" y borra markdown, json y error. Útil para permitir una nueva carga sin desmontar el componente.

Tipos

@markpdf/react reexporta los tipos relevantes de @markpdf/sdk:

import type { ConvertOptions, ConvertResult, JsonResult } from "@markpdf/sdk";
import type { UseConvertFileResult, UseConvertFileState, ConvertStatus } from "@markpdf/react";

Consulte tipos base SDK completos para JsonResult y JobStatus.

Python

Node.js / TypeScript

C++

Next.js

Angular

React

React Native

Svelte

Bun

Flutter

Java

Kotlin

`<MarkpdfProvider>`

`useMarkpdf()`

`useConvertFile()`

`convert(file, options)`

`status` máquina de estado

`reset()`

Tipos

​<MarkpdfProvider>

​useMarkpdf()

​useConvertFile()

​convert(file, options)

​status máquina de estado

​reset()

​Tipos

`<MarkpdfProvider>`

`useMarkpdf()`

`useConvertFile()`

`convert(file, options)`

`status` máquina de estado

`reset()`

Tipos