type-tester-tdf 2.0.0

package/dist/typeTester-CtFcaLf7.d.ts

@@ -0,0 +1,173 @@
+/** A four-character OpenType GSUB/GPOS feature tag. */
+type FeatureTag = string;
+/** Logical grouping used to organise features in a control UI. */
+type FeatureGroup = "Ligatures" | "Letter Case" | "Figures" | "Fractions" | "Alternates" | "Position" | "Stylistic Sets";
+/** Definition of a single OpenType feature exposed by the tester. */
+interface FeatureDef {
+    /** The OpenType feature tag, e.g. "smcp". */
+    tag: FeatureTag;
+    /** Human-readable, unambiguous label. */
+    label: string;
+    /** Group the feature belongs to. */
+    group: FeatureGroup;
+}
+/**
+ * The default, ordered list of supported OpenType features. Labels are unique
+ * and follow the Microsoft OpenType feature registry naming.
+ */
+declare const FEATURES: readonly FeatureDef[];
+/** Lookup map from tag to its definition. */
+declare const FEATURE_BY_TAG: ReadonlyMap<FeatureTag, FeatureDef>;
+/** Returns the label for a tag, falling back to the upper-cased tag itself. */
+declare function featureLabel(tag: FeatureTag): string;
+/** True if the tag is a known, supported OpenType feature. */
+declare function isKnownFeature(tag: string): boolean;
+/**
+ * Builds a CSS `font-feature-settings` value from a set of active tags so that
+ * multiple features compose (e.g. small caps + oldstyle figures) instead of
+ * each selection overwriting the others. Returns "normal" when none are active.
+ */
+declare function featureSettings(active: Iterable<FeatureTag>): string;
+
+/** Text alignment values supported by the tester. */
+type Align = "left" | "center" | "right";
+/** Size can be a fixed pixel value or "fit" to auto-fit the container width. */
+type Size = number | "fit";
+/** Numeric range with optional step, used to configure slider controls. */
+interface Range {
+    /** Minimum value (inclusive). */
+    min: number;
+    /** Maximum value (inclusive). */
+    max: number;
+    /** Step granularity. Defaults are control-specific. */
+    step?: number;
+}
+/**
+ * Which interactive controls to render, and optional range overrides. A boolean
+ * toggles a control on/off with default ranges; an object enables it with a
+ * custom range.
+ */
+interface ControlsConfig {
+    /** Font-size slider (px). Default range 8–300. */
+    size?: boolean | Range;
+    /** Letter-spacing slider (em). Default range -0.1–0.5. */
+    tracking?: boolean | Range;
+    /** Font-weight slider. Default range 100–900 step 100 (or the variable axis). */
+    weight?: boolean | Range;
+    /** Italic toggle button. */
+    italic?: boolean;
+    /** Alignment control. */
+    align?: boolean;
+    /** Line-wrap toggle button. */
+    wrap?: boolean;
+    /**
+     * OpenType feature controls. `true` exposes the full default feature list;
+     * an array restricts the offered features to the given tags.
+     */
+    features?: boolean | FeatureTag[];
+}
+/** Optional variable-font axis configuration. */
+interface VariableConfig {
+    /** `wght` axis range; when set, weight is driven via font-variation-settings. */
+    wght?: Range;
+}
+/** Options accepted by {@link TypeTester}. All fields are optional. */
+interface TypeTesterOptions {
+    /** Initial sample text. */
+    text?: string;
+    /** Primary font-family name to test. */
+    fontFamily?: string;
+    /** Fallback font stack appended after the tested family. */
+    fallback?: string;
+    /** Initial size in px, or "fit" for auto-fit. */
+    size?: Size;
+    /** Initial letter-spacing in em. */
+    tracking?: number;
+    /** Initial font weight. */
+    weight?: number;
+    /** Initial italic state. */
+    italic?: boolean;
+    /** Initial alignment. */
+    align?: Align;
+    /** Whether text wraps (multi-line) or stays on a single line. */
+    wrap?: boolean;
+    /** Initially active OpenType feature tags. */
+    features?: FeatureTag[];
+    /** Whether the sample text is user-editable. */
+    editable?: boolean;
+    /** Placeholder shown when the editable area is empty. */
+    placeholder?: string;
+    /** Which controls to render. Omit to show none (display-only). */
+    controls?: ControlsConfig;
+    /** Variable-font axis configuration. */
+    variable?: VariableConfig;
+    /** Accessible label for the editable region. */
+    ariaLabel?: string;
+    /** Called whenever the typographic state changes. */
+    onChange?: (state: TypeTesterState) => void;
+}
+/** The live typographic state of a tester instance. */
+interface TypeTesterState {
+    /** Current text content. */
+    text: string;
+    /** Resolved size in px (the fitted size when in "fit" mode). */
+    size: number;
+    /** Whether the tester is auto-fitting. */
+    fit: boolean;
+    /** Letter-spacing in em. */
+    tracking: number;
+    /** Font weight. */
+    weight: number;
+    /** Italic state. */
+    italic: boolean;
+    /** Alignment. */
+    align: Align;
+    /** Whether text wraps. */
+    wrap: boolean;
+    /** Active OpenType feature tags. */
+    features: FeatureTag[];
+}
+
+/** A type tester instance bound to a host element. */
+declare class TypeTester {
+    private readonly host;
+    private readonly options;
+    private readonly controls;
+    private readonly state;
+    private readonly activeFeatures;
+    private readonly cleanups;
+    private typeEl;
+    private textEl;
+    private liveEl;
+    private sizeOutput;
+    private fitter;
+    /**
+     * @param host Element to render the tester into.
+     * @param options Configuration; all fields optional.
+     */
+    constructor(host: HTMLElement, options?: TypeTesterOptions);
+    /** Returns a snapshot of the current state. */
+    getState(): TypeTesterState;
+    /** Removes all DOM, listeners and observers created by this instance. */
+    destroy(): void;
+    private render;
+    private buildControls;
+    private buildSlider;
+    private buildSize;
+    private buildTracking;
+    private buildWeight;
+    private buildToggle;
+    private buildItalic;
+    private buildWrap;
+    private buildAlign;
+    private buildFeatures;
+    private toggleFeature;
+    private wireEditable;
+    private setupFit;
+    /** Applies the full typographic state to the type element via element.style. */
+    private applyStyles;
+    private announce;
+    private emitChange;
+}
+
+export { type Align as A, type ControlsConfig as C, FEATURES as F, type Range as R, type Size as S, TypeTester as T, type VariableConfig as V, FEATURE_BY_TAG as a, type FeatureDef as b, type FeatureGroup as c, type FeatureTag as d, type TypeTesterOptions as e, type TypeTesterState as f, featureLabel as g, featureSettings as h, isKnownFeature as i };

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "type-tester-tdf",
+  "version": "2.0.0",
+  "description": "Accessible, dependency-free type tester for the web — a vanilla JS core with an optional React wrapper. Composable OpenType features, variable-font axes, and auto-fit sizing.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "typography",
+    "type-tester",
+    "font",
+    "opentype",
+    "variable-fonts",
+    "font-feature-settings",
+    "react",
+    "accessibility"
+  ],
+  "author": "Quinn Keaveney",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quitequinn/TypeTester_TDF.git"
+  },
+  "homepage": "https://github.com/quitequinn/TypeTester_TDF#readme",
+  "bugs": {
+    "url": "https://github.com/quitequinn/TypeTester_TDF/issues"
+  },
+  "peerDependencies": {
+    "react": ">=17",
+    "react-dom": ">=17"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.0",
+    "jsdom": "^25.0.0",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  }
+}