Type Alias TextRule

Consumer-supplied symbolic typography. Equal order values retain registration order.

type TextRule = {
    category: Exclude<FormattingCategory, "hyphenation">;
    defaults: TextRuleSettings;
    id: string;
    locales?: readonly string[];
    order: number;
    prepare: (settings: TextRuleSettings) => TextRuleHandler;
}

Properties

category: Exclude<FormattingCategory, "hyphenation">

Selectable symbolic capability; hyphenation uses its existing algorithm data.

Defaults and allowed setting names. Overrides must have matching primitive types.

id: string

Unique identifier, retaining the upstream ID for adapted reference rules.

locales?: readonly string[]

Omission applies the rule to every registered locale. No locale fallback is performed.

order: number

Finite processing priority; lower values run first.

Validates setting ranges and prepares service-owned state once. Throw for invalid settings.