https://github.com/adapt-ux/neuro-ux-sdk
Adaptive UX toolkit for neurodivergent-friendly interfaces. Framework-agnostic, research-driven, and fully customizable.
https://github.com/adapt-ux/neuro-ux-sdk
a11y accessibility adaptive-ui adaptive-ux design-tokens framework-agnostic heuristics inclusive-design javascript lit neurodivergent neurodiversity scss signals typescript user-experience ux-patterns ux-research web-components
Last synced: 2 months ago
JSON representation
Adaptive UX toolkit for neurodivergent-friendly interfaces. Framework-agnostic, research-driven, and fully customizable.
- Host: GitHub
- URL: https://github.com/adapt-ux/neuro-ux-sdk
- Owner: adapt-ux
- License: mit
- Created: 2025-11-14T03:24:22.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-02-22T02:57:11.000Z (4 months ago)
- Last Synced: 2026-02-22T10:21:23.972Z (4 months ago)
- Topics: a11y, accessibility, adaptive-ui, adaptive-ux, design-tokens, framework-agnostic, heuristics, inclusive-design, javascript, lit, neurodivergent, neurodiversity, scss, signals, typescript, user-experience, ux-patterns, ux-research, web-components
- Language: TypeScript
- Homepage:
- Size: 567 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
- Roadmap: docs/roadmap/ROADMAP.md
Awesome Lists containing this project
README
# **NeuroUX SDK**
[](docs/roadmap/ROADMAP.md)
Adaptive User Experience Framework for Cognitive Diversity
---
## 🌐 Overview
**NeuroUX SDK** is an open, framework-agnostic toolkit designed to make digital experiences more adaptable, inclusive, and comfortable for people with diverse cognitive and sensory processing styles.
Instead of enforcing a one-size-fits-all interface, NeuroUX enables **dynamic UI adjustments** that respect attention patterns, reading styles, sensory thresholds, and cognitive load — without diagnosing, tracking, or labeling users.
Built with **TypeScript**, **Web Components**, and optional wrappers for React, Vue, Angular, Svelte, Next and vanilla JavaScript, the SDK can run anywhere: from enterprise platforms to static HTML pages.
---
## ✨ Key Features
### **🔸 Universal Compatibility**
Runs in:
* React
* Vue
* Svelte
* Angular
* HTML/vanilla JavaScript
* Next
* CMS platforms (WordPress, Shopify, etc.)
### **🔸 Evidence-Based Adaptive Engine**
Behavioral signals detect when users may benefit from:
* Reduced visual noise
* Increased focus
* Enhanced readability
* Lower cognitive load
* Simplified interactions
All adaptations are **optional**, **transparent**, and **opt-in**.
### **🔸 Web Components UI (NeuroAssist)**
A universal widget that allows users to adjust:
* Motion reduction
* Focus mode
* Typography tuning
* Contrast
* Spacing
* Reading aids
* Highlighting features
### **🔸 Framework Wrappers (Optional)**
Lightweight bindings for popular frameworks:
* `@adapt-ux/neuro-react` - React wrapper
* `@adapt-ux/neuro-vue` - Vue wrapper
* `@adapt-ux/neuro-angular` - Angular wrapper
* `@adapt-ux/neuro-svelte` - Svelte wrapper
* `@adapt-ux/neuro-js` - Vanilla JavaScript loader
* `@adapt-ux/neuro-next` - Next wrapper
### **🔸 Zero Diagnosis, Zero Tracking**
The SDK does **not**:
* infer medical conditions
* store cognitive profiles
* track identity
* require accounts
It only adapts based on **interaction patterns** and **user preference**.
---
## 📦 Packages
The monorepo contains:
```
libs/
core/ # @adapt-ux/neuro-core - Adaptive engine (TS)
assist/ # @adapt-ux/neuro-assist - Web Components UI
styles/ # @adapt-ux/neuro-styles - Tokens, themes, SCSS utilities
signals/ # @adapt-ux/neuro-signals - Behavioral detection logic
utils/ # @adapt-ux/neuro-utils - Shared utilities
neuro-react/ # @adapt-ux/neuro-react - React wrapper
neuro-vue/ # @adapt-ux/neuro-vue - Vue wrapper
neuro-angular/ # @adapt-ux/neuro-angular - Angular wrapper
neuro-svelte/ # @adapt-ux/neuro-svelte - Svelte wrapper
neuro-js/ # @adapt-ux/neuro-js - Vanilla JavaScript loader
neuro-next/ # @adapt-ux/neuro-next - Next wrapper
apps/
demo/ # Example app for testing
docs/ # Internal documentation
```
---
## 🚀 Getting Started
### **Install the universal SDK**
```bash
npm install @adapt-ux/neuro-core @adapt-ux/neuro-assist
```
### **Using the NeuroAssist Web Component (HTML/Vanilla JS)**
```html
```
Or install via npm:
```bash
npm install @adapt-ux/neuro-assist @adapt-ux/neuro-core
```
```javascript
import '@adapt-ux/neuro-assist';
```
---
## 🧩 Framework Examples
### **React**
```bash
npm install @adapt-ux/neuro-react
```
```tsx
import { NeuroAssist } from '@adapt-ux/neuro-react';
export default function Page() {
return ;
}
```
---
### **Next.js**
```bash
npm install @adapt-ux/neuro-next
```
**app/layout.tsx** (Root Layout):
```tsx
import { NeuroUXProvider } from '@adapt-ux/neuro-next';
export default function RootLayout({
children,
}: {
children: React.ReactNode;
}) {
return (
{children}
);
}
```
**app/page.tsx** (Client Component):
```tsx
'use client';
import { NeuroUXToggle } from '@adapt-ux/neuro-next';
export default function Page() {
return (
My Next.js App
);
}
```
---
### **Vue**
```bash
npm install @adapt-ux/neuro-vue
```
```vue
import '@adapt-ux/neuro-vue';
```
---
### **Angular**
```bash
npm install @adapt-ux/neuro-angular
```
```typescript
// app.module.ts or standalone component
import { Component } from '@angular/core';
import '@adapt-ux/neuro-assist';
@Component({
selector: 'app-root',
template: ''
})
export class AppComponent {}
```
---
### **Svelte**
```bash
npm install @adapt-ux/neuro-svelte
```
```svelte
import '@adapt-ux/neuro-svelte';
```
---
### **Vanilla JavaScript**
```bash
npm install @adapt-ux/neuro-js
```
```javascript
import '@adapt-ux/neuro-js';
// Or via CDN
//
// The component will be available as a custom element
document.body.innerHTML = '';
```
---
## 🛠 Development
### Run the demo app:
```bash
nx serve demo
```
### Build all packages:
```bash
nx run-many --target=build --all
```
### Test:
```bash
nx test core
nx test assist
nx test signals
nx test styles
nx test utils
```
### Build a specific package:
```bash
nx build core
nx build assist
nx build react
# ... etc
```
---
## 🗺️ Roadmap
Our development plans, research milestones, and long-term goals are documented in the roadmap.
👉 **[Open ROADMAP.md](docs/roadmap/ROADMAP.md)**
This document is frequently updated as the project evolves.
---
## 🔬 Vision & Philosophy
NeuroUX is guided by these principles:
* **Adaptation over standardization**
* **Inclusion without identification**
* **Respect by default**
* **Evidence-driven design**
* **Framework-agnostic architecture**
* **Developer-first ergonomics**
Our goal is simple:
### **Make the web more comfortable for everyone — without assumptions, labels, or friction.**
---
## 🤝 Contributing
We welcome contributions in:
* Accessibility research
* UI/UX behavior experiments
* New adaptive patterns
* Code improvements
* Documentation
* Testing & QA
Please open a discussion or pull request.
---
## 📜 License
MIT License — freely usable and modifiable for personal or commercial purposes.