SunEditor Type Definitions Guide

This document provides a comprehensive overview of all TypeScript types available in SunEditor.

---

Table of Contents

• Public API Types
  • SunEditor (Root)
  • SunEditor.Module
  • SunEditor.Hook
  • SunEditor.HookParams
• Internal/Advanced Types
  • SunEditor.Event
  • SunEditor.EventParams
  • SunEditor.UI
  • DOM & Window Aliases

---

Public API Types

SunEditor (Root)

Core types for editor initialization and usage.

---

SunEditor.Module

Cross-module public API types.

Controller

Figure

Browser

HueSlider

---

SunEditor.Hook

Hook method signatures for plugins and modules.

Event Hooks (Sync)

Event Hooks (Sync/Async)

Core Hooks

Component Hooks

Modal Hooks

Controller Hooks

Browser Hooks

ColorPicker Hooks

HueSlider Hooks

---

SunEditor.HookParams

Parameter types for hook methods.

---

Internal/Advanced Types

SunEditor.Event

Event system types for EventManager.

---

SunEditor.EventParams

Event callback parameter types.

---

SunEditor.UI

UI and toolbar configuration types.

ButtonSpecial Values

---

DOM & Window Aliases

DOM/window intersection types used across the editor and iframe-safe code.

---

Usage Examples

TypeScript

import type { SunEditor } from 'suneditor';

// Editor instance
const editor: SunEditor.Instance = suneditor.init({ ... });

// Options
const options: SunEditor.InitOptions = {
  width: '100%',
  height: '400px',
  buttonList: [['bold', 'italic', '|', 'underline']]
};

// Hook parameters
function onKeyDown(params: SunEditor.HookParams.KeyEvent): void {
  const { event, frameContext } = params;
  // ...
}

// Component info
function handleComponent(info: SunEditor.ComponentInfo): void {
  console.log(info.pluginName, info.target);
}

JSDoc

/**
 * @param {SunEditor.HookParams.MouseEvent} params
 */
function onMouseDown(params) {
	const { event, frameContext, target } = params;
	// ...
}

/**
 * @type {SunEditor.InitOptions}
 */
const options = {
	plugins: [image, video],
	buttonList: [['image', 'video']],
};