/** * Drop caps in body paragraphs (#623): reading the settings a paragraph * style or a heading level (or style) carries, and the `{dropcap}` * attribute of a `:::paragraphs` fence or a heading line. Settings are * kept as written (`resolve*` passes them through); the layout reads them * through {@link readDropCap}, which fills the defaults and drops values * it cannot use (`collectConfigWarnings` names them). */ import type { Dimension, DropCapPunctuation, DropCapShortParagraph, ParagraphDropCap } from '../types.js'; export declare const DROP_CAP_PUNCTUATION: readonly DropCapPunctuation[]; export declare const DROP_CAP_SHORT_PARAGRAPH: readonly DropCapShortParagraph[]; /** The default number of lines a drop cap spans and sinks. */ export declare const DEFAULT_DROP_CAP_LINES = 3; /** The default space between the initial and the text, in em of the text. */ export declare const DEFAULT_DROP_CAP_GAP: Dimension; /** A drop cap's settings with the defaults filled in (see * {@link ParagraphDropCap}). */ export interface DropCapSettings { lines: number; sink: number; characters: number; fontFamily?: string; fontWeight?: number; italic: boolean; fontSize?: Dimension; color?: ParagraphDropCap['color']; gap: Dimension; punctuation: DropCapPunctuation; leadIn?: { words: number | 'line'; smallCaps: boolean; uppercase: boolean; }; shortParagraph: DropCapShortParagraph; each: boolean; } /** A drop cap setting as the config writes it: an object (a heading * style's `false` and anything else read as none). */ export declare function isDropCap(value: unknown): value is ParagraphDropCap; /** `cap` with the defaults filled in; `lines` replaces its lines (a * `{dropcap=N}` attribute), and its sink with them unless the setting * raises the initial (a sink under its lines keeps the difference). */ export declare function readDropCap(cap: ParagraphDropCap, lines?: number): DropCapSettings; /** What a `{dropcap}` attribute says (on a `:::paragraphs` fence or a * heading line): `'off'` for `false`, `no` or `0`; a number of lines for * `{dropcap=N}`; `'on'` for the bare flag or `true`; undefined when it is * absent (or reads as nothing). */ export declare function dropCapAttr(attrs: Readonly> | undefined): 'on' | 'off' | number | undefined; //# sourceMappingURL=dropCap.d.ts.map