Referenz

Package-Entrypoints

Jeder importierbare Pfad und was dahintersteckt.

Das Paket liefert kompilierte Ausgabe mit Typdeklarationen. Jeder Entrypoint unten ist in exports deklariert, sie lösen sich also in Node und in Bundlern auf, ohne tief nach dist/ hineinzuimportieren.

docxcelerate

Die Hauptoberfläche: der Dokument-Builder, Artefakt-Helper, Deriver, Runtime-Typen und jeder Typ der Dokumentdomäne.

import {
  buildDocument,
  buildProjectPreviewDocument,
  cleanMinimalDocumentStyle,
  dataRef,
  derive,
  type DocumentModel,
  type ParagraphNode,
} from "docxcelerate";

docxcelerate/document

Definition eines Dokumentprojekts — der Entrypoint, den eine angelegte document.project.ts verwendet. Die CLI und die erzeugten Dateinamen sagen weiterhin document; die API nicht.

import { defineDocumentProject } from "docxcelerate/document";

docxcelerate/template

Die Autorenoberfläche: die Elemente, die Hooks und template selbst. Das ist, was eine Komponentendatei importiert.

import {
  Document,
  Graph,
  Image,
  Paragraph,
  Section,
  TableOfContents,
  template,
  useAvailableTokens,
  useFormat,
  usePlaceholderData,
  useSetPlaceholders,
  useSetPrompts,
  useShared,
  useState,
} from "docxcelerate/template";

Jeder Elementname ist zugleich ein Komponententyp, sodass const Greeting: Paragraph = () => <Paragraph … /> benennt, was eine Komponente liefert, und die falsche Art zurückzugeben abgelehnt wird.

Ihre JSX-Runtime liegt unter docxcelerate/template/jsx-runtime (und .../jsx-dev-runtime) — genau dorthin löst jsxImportSource auf.

docxcelerate/docx

DOCX-Konstruktion.

import { createDocxBlob, createDocxDocument, renderDocxBytes } from "docxcelerate/docx";

Es gibt einen Renderer, und er schreibt Word-Dateien. Um ein Dokument auf einem Bildschirm zu zeigen, packen Sie es und lesen die Datei mit einem DOCX-Betrachter wieder ein — genau das tut die Vorschau-App Ihres Workspace über docx-preview, und ebenso die Vorschauen auf dieser Site. Ein zweiter Renderer, der das Modell in HTML setzt, wäre eine zweite Antwort darauf, wie ein Dokument aussieht, und diejenige, die niemand in Word öffnet, driftet ab.

docxcelerate/scaffold und /cli

Der Workspace-Generator und sein Kommandozeilen-Frontend, um eigenes Tooling darauf aufzubauen.

import { scaffoldWorkspace } from "docxcelerate/scaffold";

Diese Seite auf GitHub bearbeiten ↗ Diese Seite als Markdown lesen