guideui-core

Framework-agnostic engine behind GuideUI — tours, spotlight, coach marks, voice/TTS, command palette, and a streaming AI assistant. Zero dependencies, SSR-safe, tree-shakeable.

Most apps should use the framework bindings instead: guideui-react or guideui-vue. Use this package directly for vanilla JS, web components, or custom framework integrations.

Install

npm install guideui-core

Usage

import { TourEngine, Spotlight, VoiceManager, CommandPalette } from 'guideui-core';

// Guided tour (headless — render your own UI from events)
const tour = new TourEngine({
  steps: [
    { target: '#new-project', title: 'Create a project' },
    { target: '#invite', title: 'Invite your team' },
  ],
});
tour.on('step', (index, step) => renderMyCard(index, step));
tour.start();

// Spotlight
const spotlight = new Spotlight({ padding: 8, radius: 8 });
spotlight.show('#new-project');

// Voice (Web Speech by default; ElevenLabs/OpenAI TTS optional)
const voice = new VoiceManager();
voice.speak('Create a new project.', { speed: 1, language: 'en-US' });

// Command palette (headless fuzzy search + hotkey)
const palette = new CommandPalette({
  items: [{ id: 'new', label: 'Create project', perform: () => {} }],
  hotkey: 'mod+k',
});

Exports

TourEngine · Spotlight · CommandPalette · Assistant (streaming AI) · VoiceManager · WebSpeechProvider · ElevenLabsProvider · OpenAITTSProvider · ThemeManager · positioning and a11y utilities (computePosition, trapFocus, announce).

MIT © GuideUI