Helios Editor

Props API

Complete reference for all HeliosEditor props and their usage.

TypeScript Interface

interface HeliosEditorProps {
  value?: string;
  onChange?: (content: string) => void;
  toolbarOptions?: string[];
  placeholder?: string;
  readOnly?: boolean;
  height?: string;
  width?: string;
  toolbarPosition?: "top" | "bottom";
  stickyToolbar?: boolean;
  stickyOffset?: number;
  debounceTime?: number;
  customClasses?: CustomClasses;
  uploadConfig?: UploadConfig;
}

interface UploadConfig {
  uploadApiUrl?: string;
  clientId?: string;
  clientSecret?: string;
}

Core Props

PropTypeDefaultDescription
valuestring''HTML content of the editor
onChange(content: string) => void-Callback when content changes
toolbarOptionsstring[]All optionsArray of toolbar button names
placeholderstring'Start typing...'Placeholder text
readOnlybooleanfalseDisable editing
uploadConfigUploadConfigImage upload configuration

Layout Props

PropTypeDefaultDescription
heightstring'h-64'CSS height class
widthstring'w-full'CSS width class
toolbarPosition'top' | 'bottom''top'Toolbar position
stickyToolbarbooleanfalseEnable sticky toolbar
stickyOffsetnumber0Sticky toolbar offset

Performance Props

PropTypeDefaultDescription
debounceTimenumber300Debounce delay (ms)
customClassesCustomClassesOverride CSS classes

Related Documentation