@skvggor/pharos 1.0.0

package/dist/src/components/PixelText.d.ts

@@ -0,0 +1,21 @@
+import { PixelShape } from '../../domain/index';
+import { HTMLAttributes } from 'react';
+export interface PixelTextProps extends Omit<HTMLAttributes<HTMLSpanElement>, "children"> {
+    text: string;
+    pixelSize?: number | string;
+    gap?: number | string;
+    letterSpacing?: number | string;
+    color?: string;
+    offColor?: string;
+    pixelShape?: PixelShape;
+    smartCorners?: boolean;
+    smoothness?: number;
+    proportional?: boolean;
+    spaceWidth?: number;
+    renderOff?: boolean;
+    fluid?: boolean;
+    gapRatio?: number;
+    letterSpacingRatio?: number;
+    "aria-label"?: string;
+}
+export declare function PixelText({ text, pixelSize, gap, letterSpacing, color, offColor, pixelShape, smartCorners, smoothness, proportional, spaceWidth, renderOff, fluid, gapRatio, letterSpacingRatio, className, style, ...rest }: PixelTextProps): import("react").JSX.Element;

package/dist/src/domain/index.d.ts

@@ -0,0 +1,19 @@
+export type Cell = "off" | "on" | "tl" | "tr" | "bl" | "br";
+export type PixelRow = Cell[];
+export type PixelMatrix = PixelRow[];
+export type GlyphSource = readonly string[];
+export type PixelShape = "square" | "squircle" | "dot" | "diamond" | "ring";
+export interface RenderedGlyph {
+    character: string;
+    matrix: PixelMatrix;
+    isFallback: boolean;
+}
+export interface CanvasMetrics {
+    width: number;
+    height: number;
+    accentTop: number;
+    capTop: number;
+    xHeight: number;
+    baseline: number;
+    descenderBottom: number;
+}

package/dist/src/engine/metrics.d.ts

@@ -0,0 +1,9 @@
+import { Cell, CanvasMetrics } from '../../domain/index';
+/**
+ * Glyph source markers. `#` full pixel, `.` empty. Numpad-mnemonic corner
+ * triangles smooth diagonals and curves: 7=top-left, 9=top-right,
+ * 1=bottom-left, 3=bottom-right (the corner each triangle fills).
+ */
+export declare const CELL_MARKERS: Record<string, Cell>;
+export declare const METRICS: CanvasMetrics;
+export declare function isLit(cell: Cell): boolean;

package/dist/src/engine/parse-glyph.d.ts

@@ -0,0 +1,3 @@
+import { GlyphSource, PixelMatrix } from '../../domain/index';
+export declare function parseGlyph(source: GlyphSource): PixelMatrix;
+export declare function emptyMatrix(): PixelMatrix;

package/dist/src/engine/render-text.d.ts

@@ -0,0 +1,10 @@
+import { GlyphSource, PixelMatrix, RenderedGlyph } from '../../domain/index';
+/**
+ * Register (or override) a glyph at runtime. The source is validated against
+ * the canvas metrics and the parsed matrix cache is invalidated.
+ */
+export declare function registerGlyph(character: string, source: GlyphSource): void;
+export declare function getCharacters(): string[];
+export declare function getGlyphMatrix(character: string): PixelMatrix | undefined;
+export declare function hasGlyph(character: string): boolean;
+export declare function renderText(text: string): RenderedGlyph[];

package/dist/src/engine/spacing.d.ts

@@ -0,0 +1,10 @@
+import { PixelMatrix } from '../../domain/index';
+export interface GlyphBounds {
+    start: number;
+    end: number;
+}
+/**
+ * Horizontal ink bounds of a glyph (inclusive column range that contains any
+ * lit pixel). Returns null for empty glyphs such as the space character.
+ */
+export declare function glyphBounds(matrix: PixelMatrix): GlyphBounds | null;

package/dist/src/glyphs/registry.d.ts

@@ -0,0 +1,8 @@
+import { GlyphSource } from '../../domain/index';
+/**
+ * Pilot serif glyph set on the 12x18 canvas.
+ * `#` full pixel, `.` empty, 7/9/1/3 corner triangles (numpad-mnemonic).
+ * Vertical zones: rows 0-2 accent, 3-13 cap body, 6-13 x-height, 14-17 descender.
+ */
+export declare const GLYPHS: Record<string, GlyphSource>;
+export declare const FALLBACK_CHARACTER = " ";

package/dist/src/index.d.ts

@@ -0,0 +1,8 @@
+export { PixelText } from '../components/PixelText';
+export type { PixelTextProps } from '../components/PixelText';
+export { METRICS, isLit } from '../engine/metrics';
+export { renderText, getGlyphMatrix, hasGlyph, registerGlyph, getCharacters, } from '../engine/render-text';
+export { glyphBounds } from '../engine/spacing';
+export type { GlyphBounds } from '../engine/spacing';
+export { GLYPHS } from '../glyphs/registry';
+export type { CanvasMetrics, Cell, GlyphSource, PixelMatrix, PixelRow, PixelShape, RenderedGlyph, } from '../domain/index';

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@skvggor/pharos",
+  "version": "1.0.0",
+  "description": "A serif pixel display font for React — text as a configurable grid of pixels.",
+  "type": "module",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Marcos Lima (https://skvggor.dev)",
+  "homepage": "https://skvggor.github.io/pharos/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skvggor/pharos.git"
+  },
+  "bugs": {
+    "url": "https://github.com/skvggor/pharos/issues"
+  },
+  "keywords": [
+    "react",
+    "pixel-font",
+    "display-font",
+    "dot-matrix",
+    "led",
+    "bitmap-font",
+    "serif",
+    "css"
+  ],
+  "main": "./dist/pharos.cjs",
+  "module": "./dist/pharos.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/pharos.js",
+      "require": "./dist/pharos.cjs"
+    },
+    "./styles.css": "./dist/pharos.css"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc --noEmit && vite build",
+    "build:demo": "vite build --mode demo",
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "prepack": "npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "@phosphor-icons/react": "^2.1.10",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/node": "^25.9.1",
+    "@types/react": "^19.2.16",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.2",
+    "@vitest/coverage-v8": "^4.1.8",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.16",
+    "vite-plugin-dts": "^5.0.2",
+    "vitest": "^4.1.8"
+  }
+}