AIssistant

A smart UI assistant with GPT-based context answering, element highlighting, and route-aware navigation

✨ Features

• 🧠 GPT integration for contextual UI help
• 🔦 Element highlighting and auto-scroll
• 🌐 i18n support with labelKey/descriptionKey
• 🧭 Route-aware navigation (with react-router)
• 🎙️ Optional speech-to-text input via Web Speech API

🚀 Install

npm install @basslagter/aissistant

📦 Usage

import { UIAssistant, registerUiElement } from 'aissistant';

<UIAssistant
  catalogPath="/generated/uiCatalog.json"
  translate={t} // optional, for i18n support
/>;

Registering UI elements:

registerUiElement('mainClock.setButton', {
  label: 'Instellen',
  description: 'Stel de huidige klok in als hoofdklok',
  parentId: 'menu.main',
});

📁 UI Catalog (Optional)

Use a custom Vite/Rollup plugin to extract UI metadata at build time. Store it in /generated/uiCatalog.json and pass the path to <UIAssistant />.

🧪 Dev

npm install
npm run dev

📦 Build

npm run build

🪪 License

MIT © Bas Slagter