@zsnout/ithkuil
Version:
A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.
27 lines (26 loc) • 1.24 kB
TypeScript
import { type ExtensionName } from "../index.js";
import { type DiacriticName } from "../other/diacritic.js";
/** Information about an advanced alphabetic character. */
export interface AdvancedAlphabeticCharacter {
/** Whether this character is handwritten. */
readonly handwritten?: boolean | undefined;
/** The top extension of the character. */
readonly top?: ExtensionName | undefined;
/** The bottom extension of the character. */
readonly bottom?: ExtensionName | undefined;
/** The diacritic superposed above the character. */
readonly superposed?: DiacriticName | undefined;
/** The diacritic underposed below the character. */
readonly underposed?: DiacriticName | undefined;
/** The diacritic posed to the left of the character. */
readonly left?: DiacriticName | undefined;
/** The diacritic posed to the right of the character. */
readonly right?: DiacriticName | undefined;
}
/**
* Assembles an advanced alphabetic character as an group of SVG paths.
*
* @param alphabetic Properties that modify the character.
* @returns An `SVGGElement` containing the character.
*/
export declare function AdvancedAlphabetic(alphabetic: AdvancedAlphabeticCharacter): SVGGElement;