open-agreements
Version:
Open-source legal template filling CLI and library
29 lines • 1.35 kB
TypeScript
/**
* Section-properties emitter.
*
* Shipped: page size/margins, page numbering, section break type, title-page
* switch, and header/footer references. The reference rIds come from the
* header/footer part allocation pass (emit/header-footer-part.ts), which runs
* before the document part so the sectPr can bind them.
*/
import type { SectionSpec } from '../types.js';
/** Header/footer part references for one section, allocated by the parts pass. */
export type SectionHeaderFooterRefs = {
headers: Partial<Record<'default' | 'first' | 'even', string>>;
footers: Partial<Record<'default' | 'first' | 'even', string>>;
};
/**
* Build the w:sectPr element for a section.
*
* Width/height are always emitted explicitly (never reader defaults); a
* landscape request swaps the dimensions and sets w:orient. Header/footer
* references lead the child sequence; w:titlePg is implied whenever a
* first-page header or footer is present.
*
* @conformance ECMA-376 edition 5, Part 1 § 17.6.13
* @conformance ECMA-376 edition 5, Part 1 § 17.6.12
* @conformance ECMA-376 edition 5, Part 1 § 17.10.6
*/
export declare function buildSectPr(doc: Document, section: SectionSpec, refs?: SectionHeaderFooterRefs): Element;
export declare function titlePgImplied(section: SectionSpec): boolean;
//# sourceMappingURL=section.d.ts.map