@zsnout/ithkuil/script/secondary/index.d.ts

A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.

import { type DiacriticName } from "../other/diacritic.js";
import { type CoreName } from "./core.js";
import { type ExtensionName } from "./extension.js";
/** Information about a secondary character. */
export interface SecondaryCharacter {
    /** Whether this character is handwritten. */
    readonly handwritten?: boolean | undefined;
    /** The top extension of the character. */
    readonly top?: ExtensionName | undefined;
    /**
     * The core shape of the character.
     *
     * @default "STANDARD_PLACEHOLDER"
     */
    readonly core?: CoreName | undefined;
    /** Whether the core shape should be rotated. */
    readonly rotated?: boolean | undefined;
    /** The bottom extension of the character. */
    readonly bottom?: ExtensionName | undefined;
    /** The diacritic superposed above the character. */
    readonly superposed?: DiacriticName | undefined;
    /** The diacritic posed to the right of the character. */
    readonly right?: DiacriticName | undefined;
    /** The diacritic underposed below the character. */
    readonly underposed?: DiacriticName | undefined;
}
/**
 * Assembles a secondary character as an group of SVG paths.
 *
 * @param secondary Properties that modify the character.
 * @returns An `SVGGElement` containing the character.
 */
export declare function Secondary(secondary: SecondaryCharacter): SVGGElement;