API Index

Use this page to find any prop, callback, hook method, or config key fast. Each item links to its canonical section.

Component Props

• text (string) – Text to type → Component API
• speed (number) – Base ms per char → Component API
• mistakeFrequency (number) – Error probability → Component API
• keyboardMode ('mobile'|'desktop') – Platform behavior → Component API
• showCursor (boolean) – Show cursor → Component API
• cursorChar (string) – Cursor symbol → Component API
• cursorBlinkSpeed (number) – Blink interval → Component API
• autoStart (boolean) – Start on mount → Component API
• id (string) – Instance identifier → Component API
• className (string) – CSS class → Component API
• style (React.CSSProperties) – Inline styles → Component API
• config (Partial<HumanLikeConfig>) – Advanced config → Component API

Event Callbacks

• onStart – Typing started → Events
• onComplete – Typing finished → Events
• onChar – Character typed → Events
• onMistake – Mistake made → Events
• onBackspace – Backspace pressed → Events
• onPause – Typing paused → Events
• onResume – Typing resumed → Events
• onKey – Key pressed → Events
• onStateChange – State changed → Events
• onKeyboardReset – Keyboard reset → Events
• onError – Error occurred → Events

Hook Methods

• start() – Start typing → Hook API
• stop() – Stop typing → Hook API
• pause() – Pause typing → Hook API
• resume() – Resume typing → Hook API
• reset() – Reset to beginning → Hook API
• skip() – Skip to end → Hook API
• rewind() – Go to beginning → Hook API

Hook Return Values

Display State

• displayText (string) – Current typed text → Hook API
• isTyping (boolean) – Currently typing → Hook API
• isPaused (boolean) – Currently paused → Hook API
• isCompleted (boolean) – Finished typing → Hook API
• currentState (TypingState) – Detailed state → Hook API

Progress & Performance

• progress (number) – Progress 0-100 → Hook API
• currentWPM (number) – Words per minute → Hook API
• mistakeCount (number) – Total mistakes → Hook API
• totalDuration (number) – Time elapsed (ms) → Hook API

Cursor State & Control

• showCursor (boolean) – Cursor visibility → Hook API
• cursorChar (string) – Cursor character → Hook API
• cursorBlinkSpeed (number) – Blink speed → Hook API
• setCursorVisible (function) – Set cursor visibility → Hook API
• setCursorChar (function) – Set cursor character → Hook API
• setCursorBlinkSpeed (function) – Set blink speed → Hook API

Configuration Keys

Core Timing

• speed (number) – Base ms per char → Configuration
• speedVariation (number) – Random ±ms → Configuration
• minCharDelay (number) – Minimum delay → Configuration

Platform & Mistakes

• keyboardMode ('mobile'|'desktop') – Platform → Configuration
• mistakeFrequency (number) – Error probability → Configuration
• mistakeTypes (object) – Enabled mistake kinds → Configuration

Human Behavior

• fatigueEffect (boolean) – Gradual slowdown → Configuration
• concentrationLapses (boolean) – Random pauses → Configuration
• overcorrection (boolean) – Correction mistakes → Configuration

Advanced Timing

• sentencePause (number) – Pause after . ! ? → Configuration
• wordPause (number) – Pause between words → Configuration
• thinkingPause (number) – Pause before complex words → Configuration
• backspaceSpeed (number) – Correction speed → Configuration
• realizationDelay (number) – Time to notice mistakes → Configuration
• correctionPause (number) – Pause before retyping → Configuration

Development

• debug (boolean) – Enable console logging → Configuration

Constants & Utilities

Timing Constants

• TIMING_CONSTANTS.BASE_SPEED – Default typing speed → Constants
• TIMING_CONSTANTS.SPEED_VARIATION – Random variation → Constants
• TIMING_CONSTANTS.SENTENCE_PAUSE – Pause after sentences → Constants
• TIMING_CONSTANTS.WORD_SPACE – Pause between words → Constants
• TIMING_CONSTANTS.BACKSPACE_SPEED – Correction speed → Constants
• TIMING_CONSTANTS.THINKING_PAUSE – Complex word pauses → Constants

Behavior Constants

• BEHAVIOR_RATES.MISTAKE_FREQUENCY – Base mistake rate → Constants
• BEHAVIOR_RATES.CONCENTRATION_LAPSE – Random pause rate → Constants
• BEHAVIOR_RATES.BURST_TYPING – Rapid sequence rate → Constants
• BEHAVIOR_RATES.OVERCORRECTION_RATE – Correction mistake rate → Constants

Adjacent Key Maps

• DESKTOP_ADJACENT – QWERTY adjacent keys → Constants
• MOBILE_ADJACENT – Touch-optimized keys → Constants
• QWERTY_ADJACENT – Legacy desktop keys → Constants
• getAdjacentKeys(mode) – Get platform keys → Constants

Specialized Constants

• COMMON_TYPOS – Real-world typo mapping → Constants
• SPECIAL_CHARS – Special character set → Constants
• SHIFT_CHARS – Shift-requiring characters → Constants
• NUMBER_CHARS – Number character set → Constants
• DEFAULT_CONFIG – Complete default config → Constants

Keyboard Components

• MobileKeyboard – Touch keyboard component → Mobile Keyboard
• DesktopKeyboard – Physical keyboard component → Desktop Keyboard
• useKeyPressIndicator – Key press tracking hook → Key Press Indicator
• KeyboardSimulationDemo – Complete demo component → Keyboard Simulation Demo

TypeScript Types

Core Interfaces

• HumanLikeProps – Component props interface → Types
• HumanLikeHookOptions – Hook options interface → Types
• HumanLikeHookReturn – Hook return interface → Types
• HumanLikeConfig – Configuration interface → Types

Event & State Types

• MistakeInfo – Mistake event data → Types
• KeyInfo – Key press event data → Types
• StateChangeEvent – State transition data → Types
• ErrorEvent – Error event data → Types
• TypingState – Typing state enum → Types

Utility Types

• Platform – Platform detection type → Types
• KeyType – Key classification type → Types
• MistakeType – Mistake classification → Types
• KeyboardView – Keyboard view enum → Types
• ShiftState – Shift key state enum → Types

Type Guards

• isTypingState() – Type guard for states → Types
• isMistakeType() – Type guard for mistakes → Types
• isKeyType() – Type guard for key types → Types