1.0.2 โข Published 6 months ago
@basslagter/aissistant v1.0.2
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