1.0.2 โ€ข Published 6 months ago

@basslagter/aissistant v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

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