Export ODT from your editor

Use Tiptap's @tiptap-pro/extension-export-odt to export your editor's content as an .odt file. This extension integrates ODT export functionality into your editor by sending the document to the Tiptap convert service for conversion.

You can also use the REST API instead if you'd prefer to handle the conversion on your end.

Install the ODT Export extension

The Conversion extensions are published in Tiptap's private npm registry. Integrate the extensions by following the private registry guide.

Once done you can install and import the Export ODT extension package.

npm i @tiptap-pro/extension-export-odt

import { ExportOdt } from '@tiptap-pro/extension-export-odt'

Configuring the extension

The ExportOdt extension can be configured with an ExportOdtOptions (object) as an argument to the configure method with the following properties:

import { ExportOdt } from '@tiptap-pro/extension-export-odt'

const editor = new Editor({
  extensions: [
    // Other extensions ...
    ExportOdt.configure({
      endpoint: 'https://api.tiptap.dev/v2/convert',
      token: 'YOUR_TOKEN',
      appId: 'YOUR_APP_ID',
      styleOverrides: {},
      headers: {},
      footers: {},
      pageSize: { width: '21cm', height: '29.7cm' },
      pageMargins: { top: '1cm', bottom: '1cm', left: '1cm', right: '1cm' },
      customNodes: [],
      onCompleteExport: (result) => {
        // Handle the exported Blob
      },
    }),
    // Other extensions ...
  ],
})

HeaderConfig

FooterConfig

PageSize

PageMargins

Export an ODT file

With the extension installed, you can export your editor's content to .odt using the exportOdt command.

/**
 * Export the current document as an ODT file via the Tiptap convert service.
 *
 * @param options - All extension-level options can be overridden per-invocation
 * @example editor.commands.exportOdt({ onCompleteExport: (result) => {} })
 */
exportOdt: (options?: ExportOdtCommandOptions) => ReturnType

The ExportOdtCommandOptions interface extends ExportOdtOptions, so every configuration option can be overridden per-command invocation:

import { ExportOdt } from '@tiptap-pro/extension-export-odt'

const editor = new Editor({
  extensions: [
    // Other extensions ...
    ExportOdt.configure({
      token: 'YOUR_TOKEN',
      appId: 'YOUR_APP_ID',
      onCompleteExport(result) {
        // Download the ODT file
        const url = URL.createObjectURL(result)
        const a = document.createElement('a')

        a.href = url
        a.download = 'document.odt'
        a.click()

        URL.revokeObjectURL(url)
      },
    }),
    // Other extensions ...
  ],
})

// Use the extension-level callback
editor.chain().exportOdt().run()

// Or override options for a specific export
editor
  .chain()
  .exportOdt({
    pageSize: { width: '8.5in', height: '11in' },
    onCompleteExport(result) {
      // Custom handling for this specific export
      const url = URL.createObjectURL(result)
      window.open(url)
    },
  })
  .run()

How it works

When you call exportOdt, the extension sends the editor's document and any configured options (style overrides, page layout, headers, footers) to the Convert service, which returns the resulting .odt file as a binary blob. The onCompleteExport callback receives the blob directly. Errors are thrown as exceptions rather than passed through the callback.

What to expect

• Authentication required (token JWT and appId). Generate JWTs server-side. See the Conversion install guide.
• HTTP responses to handle: 401 (missing or invalid JWT), 403 (operation not permitted for your app — typically a format your plan doesn't include), 5xx (transient server-side error; retry with backoff).
• Each request is processed end-to-end before responding. Plan for longer round-trips on large documents.

What not to expect

• Round-trip identity with Word. ODT is the OpenDocument Text format used by LibreOffice and OpenOffice; some Word-specific header/footer features and styling quirks may not survive export.
• Pixel-perfect Word-to-ODT layout match. Use ODT when you want a portable open-format file; use DOCX when fidelity to Word is the priority.

Support & Limitations

For a detailed per-feature breakdown, see the Supported features matrix. Note that element overrides (paragraphOverrides, textRunOverrides, tableOverrides, tableCellOverrides, imageOverrides) available in the DOCX export extension are not passed through to the ODT conversion.