@stll/folio-core 0.0.1-placeholder.0 → 0.1.0

package/dist/layout-painter/renderParagraph.d.ts

@@ -0,0 +1,93 @@
+import { MeasuredLine, ParagraphBlock, ParagraphBorders, ParagraphFragment, ParagraphMeasure, Run, TabStop } from "../layout-engine/types.js";
+import { RenderContext } from "./renderUtils.js";
+
+//#region src/layout-painter/renderParagraph.d.ts
+/**
+ * CSS class names for paragraph rendering
+ */
+declare const PARAGRAPH_CLASS_NAMES: {
+  fragment: string;
+  line: string;
+  run: string;
+  text: string;
+  tab: string;
+  image: string;
+  lineBreak: string;
+};
+/**
+ * Options for rendering a paragraph
+ */
+type RenderParagraphOptions = {
+  /** Document to create elements in */document?: Document; /** Fragment's Y position relative to content area (for per-line margin calculation) */
+  fragmentContentY?: number; /** Borders from the previous adjacent paragraph (for border grouping) */
+  prevBorders?: ParagraphBorders; /** Borders from the next adjacent paragraph (for border grouping) */
+  nextBorders?: ParagraphBorders; /** Inline image runs already rendered for this paragraph block */
+  renderedInlineImageKeys?: Set<string>;
+};
+/**
+ * Slice runs for a specific line
+ *
+ * @param block - The paragraph block
+ * @param line - The line measurement
+ * @returns Array of runs for this line
+ */
+declare function sliceRunsForLine(block: ParagraphBlock, line: MeasuredLine): Run[];
+/**
+ * Split each text run carrying an East-Asian font into per-script sub-runs, so
+ * CJK code points render with `eastAsiaFontFamily` and the rest with
+ * `fontFamily`. Each sub-run gets a contiguous, exact `pmStart`/`pmEnd` (the
+ * same offset math as `sliceRunsForLine`), keeping PM position mapping,
+ * selection rects, and click-to-caret correct. The measurer segments the same
+ * way, so the per-run advances sum to the measured run width. Non-text runs and
+ * runs without CJK pass through unchanged (the common path).
+ */
+declare function splitTextRunsByEastAsia(runs: Run[]): Run[];
+/**
+ * Options for rendering a line with justify support
+ */
+type RenderLineOptions = {
+  /** Available width for the line (content area width minus indentation) */availableWidth: number; /** Whether this is the last line of the paragraph */
+  isLastLine: boolean; /** Whether this is the first line of the paragraph */
+  isFirstLine: boolean; /** Whether the paragraph ends with a line break */
+  paragraphEndsWithLineBreak: boolean; /** Tab stops from paragraph attributes */
+  tabStops?: TabStop[]; /** Render context for field substitution */
+  context?: RenderContext; /** Left indent in pixels */
+  leftIndentPx?: number; /** First line indent in pixels (positive) or hanging indent (negative) */
+  firstLineIndentPx?: number; /** Line-specific floating image margins (calculated per-line based on Y overlap) */
+  floatingMargins?: {
+    leftMargin: number;
+    rightMargin: number;
+  }; /** Track inline image runs already rendered in this paragraph fragment to prevent duplicates */
+  renderedInlineImageKeys?: Set<string>;
+  /**
+   * Rightmost x where inline content may render, in content-area coords. Used
+   * by the right-tab anchor (TOC pattern); passed in directly rather than
+   * recomposed from `leftIndentPx + availableWidth` because availableWidth
+   * excludes the hung-out region for some inputs and would drift.
+   */
+  lineRightEdgePx?: number;
+};
+/**
+ * Render a single line
+ *
+ * @param block - The paragraph block
+ * @param line - The line measurement
+ * @param alignment - Text alignment
+ * @param doc - Document to create elements in
+ * @param options - Additional options for justify calculation
+ * @returns The line DOM element
+ */
+declare function renderLine(block: ParagraphBlock, line: MeasuredLine, alignment: "left" | "center" | "right" | "justify" | undefined, doc: Document, options?: RenderLineOptions): HTMLElement;
+/**
+ * Render a paragraph fragment
+ *
+ * @param fragment - The fragment to render
+ * @param block - The paragraph block
+ * @param measure - The paragraph measurement
+ * @param context - Rendering context
+ * @param options - Rendering options
+ * @returns The fragment DOM element
+ */
+declare function renderParagraphFragment(fragment: ParagraphFragment, block: ParagraphBlock, measure: ParagraphMeasure, context: RenderContext, options?: RenderParagraphOptions): HTMLElement;
+//#endregion
+export { PARAGRAPH_CLASS_NAMES, RenderParagraphOptions, renderLine, renderParagraphFragment, sliceRunsForLine, splitTextRunsByEastAsia };