@compa11y/core 0.1.0

package/dist/types-DDSPmE8m.d.cts

@@ -0,0 +1,52 @@
+/**
+ * Core types used across compa11y
+ */
+type AriaRole = 'alert' | 'alertdialog' | 'application' | 'article' | 'banner' | 'button' | 'cell' | 'checkbox' | 'columnheader' | 'combobox' | 'complementary' | 'contentinfo' | 'definition' | 'dialog' | 'directory' | 'document' | 'feed' | 'figure' | 'form' | 'grid' | 'gridcell' | 'group' | 'heading' | 'img' | 'link' | 'list' | 'listbox' | 'listitem' | 'log' | 'main' | 'marquee' | 'math' | 'menu' | 'menubar' | 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'navigation' | 'none' | 'note' | 'option' | 'presentation' | 'progressbar' | 'radio' | 'radiogroup' | 'region' | 'row' | 'rowgroup' | 'rowheader' | 'scrollbar' | 'search' | 'searchbox' | 'separator' | 'slider' | 'spinbutton' | 'status' | 'switch' | 'tab' | 'table' | 'tablist' | 'tabpanel' | 'term' | 'textbox' | 'timer' | 'toolbar' | 'tooltip' | 'tree' | 'treegrid' | 'treeitem';
+type AriaLivePoliteness = 'off' | 'polite' | 'assertive';
+interface FocusableElement extends HTMLElement {
+    focus(options?: FocusOptions): void;
+}
+interface KeyboardNavigationOptions {
+    /** Whether navigation wraps around at boundaries */
+    wrap?: boolean;
+    /** Orientation of the navigation */
+    orientation?: 'horizontal' | 'vertical' | 'both';
+    /** Whether to focus on hover */
+    focusOnHover?: boolean;
+    /** Custom key handlers */
+    keyHandlers?: Record<string, (event: KeyboardEvent) => void>;
+}
+interface FocusTrapOptions {
+    /** Element to focus when trap activates */
+    initialFocus?: HTMLElement | string | (() => HTMLElement | null);
+    /** Element to focus when trap deactivates */
+    returnFocus?: HTMLElement | boolean;
+    /** Whether clicking outside deactivates the trap */
+    clickOutsideDeactivates?: boolean;
+    /** Whether pressing Escape deactivates the trap */
+    escapeDeactivates?: boolean;
+    /** Callback when trap is deactivated */
+    onDeactivate?: () => void;
+    /** Callback when focus escapes (for portals) */
+    onEscapeFocus?: (element: Element) => void;
+}
+interface AnnouncerOptions {
+    /** Politeness level for the announcement */
+    politeness?: AriaLivePoliteness;
+    /** Delay before announcement in ms */
+    delay?: number;
+    /** Clear previous announcements */
+    clearPrevious?: boolean;
+    /** Timeout for announcement visibility */
+    timeout?: number;
+}
+interface DevWarning {
+    type: 'error' | 'warning' | 'info';
+    component: string;
+    message: string;
+    suggestion?: string;
+    element?: Element;
+}
+type DevWarningHandler = (warning: DevWarning) => void;
+
+export type { AnnouncerOptions as A, DevWarningHandler as D, FocusTrapOptions as F, KeyboardNavigationOptions as K, DevWarning as a, AriaLivePoliteness as b, AriaRole as c, FocusableElement as d };

package/dist/types-DDSPmE8m.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Core types used across compa11y
+ */
+type AriaRole = 'alert' | 'alertdialog' | 'application' | 'article' | 'banner' | 'button' | 'cell' | 'checkbox' | 'columnheader' | 'combobox' | 'complementary' | 'contentinfo' | 'definition' | 'dialog' | 'directory' | 'document' | 'feed' | 'figure' | 'form' | 'grid' | 'gridcell' | 'group' | 'heading' | 'img' | 'link' | 'list' | 'listbox' | 'listitem' | 'log' | 'main' | 'marquee' | 'math' | 'menu' | 'menubar' | 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'navigation' | 'none' | 'note' | 'option' | 'presentation' | 'progressbar' | 'radio' | 'radiogroup' | 'region' | 'row' | 'rowgroup' | 'rowheader' | 'scrollbar' | 'search' | 'searchbox' | 'separator' | 'slider' | 'spinbutton' | 'status' | 'switch' | 'tab' | 'table' | 'tablist' | 'tabpanel' | 'term' | 'textbox' | 'timer' | 'toolbar' | 'tooltip' | 'tree' | 'treegrid' | 'treeitem';
+type AriaLivePoliteness = 'off' | 'polite' | 'assertive';
+interface FocusableElement extends HTMLElement {
+    focus(options?: FocusOptions): void;
+}
+interface KeyboardNavigationOptions {
+    /** Whether navigation wraps around at boundaries */
+    wrap?: boolean;
+    /** Orientation of the navigation */
+    orientation?: 'horizontal' | 'vertical' | 'both';
+    /** Whether to focus on hover */
+    focusOnHover?: boolean;
+    /** Custom key handlers */
+    keyHandlers?: Record<string, (event: KeyboardEvent) => void>;
+}
+interface FocusTrapOptions {
+    /** Element to focus when trap activates */
+    initialFocus?: HTMLElement | string | (() => HTMLElement | null);
+    /** Element to focus when trap deactivates */
+    returnFocus?: HTMLElement | boolean;
+    /** Whether clicking outside deactivates the trap */
+    clickOutsideDeactivates?: boolean;
+    /** Whether pressing Escape deactivates the trap */
+    escapeDeactivates?: boolean;
+    /** Callback when trap is deactivated */
+    onDeactivate?: () => void;
+    /** Callback when focus escapes (for portals) */
+    onEscapeFocus?: (element: Element) => void;
+}
+interface AnnouncerOptions {
+    /** Politeness level for the announcement */
+    politeness?: AriaLivePoliteness;
+    /** Delay before announcement in ms */
+    delay?: number;
+    /** Clear previous announcements */
+    clearPrevious?: boolean;
+    /** Timeout for announcement visibility */
+    timeout?: number;
+}
+interface DevWarning {
+    type: 'error' | 'warning' | 'info';
+    component: string;
+    message: string;
+    suggestion?: string;
+    element?: Element;
+}
+type DevWarningHandler = (warning: DevWarning) => void;
+
+export type { AnnouncerOptions as A, DevWarningHandler as D, FocusTrapOptions as F, KeyboardNavigationOptions as K, DevWarning as a, AriaLivePoliteness as b, AriaRole as c, FocusableElement as d };

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@compa11y/core",
+  "version": "0.1.0",
+  "description": "Framework-agnostic accessibility primitives",
+  "author": "Ivan Trajkovski",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "homepage": "https://github.com/trajkovskiivan/compa11y#readme",
+  "bugs": {
+    "url": "https://github.com/trajkovskiivan/compa11y/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trajkovskiivan/compa11y.git",
+    "directory": "packages/core"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./focus": {
+      "types": "./dist/focus/index.d.ts",
+      "import": "./dist/focus/index.js",
+      "require": "./dist/focus/index.cjs"
+    },
+    "./keyboard": {
+      "types": "./dist/keyboard/index.d.ts",
+      "import": "./dist/keyboard/index.js",
+      "require": "./dist/keyboard/index.cjs"
+    },
+    "./announcer": {
+      "types": "./dist/announcer/index.d.ts",
+      "import": "./dist/announcer/index.js",
+      "require": "./dist/announcer/index.cjs"
+    },
+    "./aria": {
+      "types": "./dist/aria/index.d.ts",
+      "import": "./dist/aria/index.js",
+      "require": "./dist/aria/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.2.0"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "accessibility",
+    "a11y",
+    "focus",
+    "keyboard",
+    "aria",
+    "screen-reader"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist node_modules"
+  }
+}