Skip to content

on-CodeMerge Plugins

on-CodeMerge provides a rich ecosystem of plugins to extend editor functionality. Each plugin can be used independently or in combination with others.

Plugin Overview

On-Codemerge comes with a comprehensive set of plugins that extend its functionality. Each plugin adds unique features to the editor, making it a powerful tool for web content creation and editing.

Core Plugins

Essential Plugins

PluginDescriptionDocumentation
ToolbarPluginAdds a customizable toolbar for quick access to editor features.View Details
ToolbarDividerPluginAdds visual dividers in the toolbar for better organization.View Details

Text Formatting Plugins

PluginDescriptionDocumentation
FontPluginProvides options to change font family, size, and style.View Details
TypographyPluginAdds advanced typography options like line height, letter spacing, etc.View Details
ColorPluginProvides options to change text and background colors.View Details
AlignmentPluginAllows alignment of text (left, center, right, justify).View Details
BlockStylePluginClass and style editor for custom styling.View Details

Content Creation Plugins

PluginDescriptionDocumentation
BlockPluginAdds support for block-level elements like paragraphs, headings, etc.View Details
ListsPluginEnables creation of ordered and unordered lists.View Details
TablePluginEnables creation and editing of tables.View Details
TemplatesPluginProvides pre-designed templates for quick content creation.View Details

Media Plugins

PluginDescriptionDocumentation
ImagePluginAllows inserting and managing images in the editor.View Details
VideoPluginEnables embedding and managing video files.View Details
YouTubeVideoPluginAllows embedding YouTube videos directly into the editor.View Details
FileUploadPluginProvides functionality to upload and manage files.View Details

Code and Technical Plugins

PluginDescriptionDocumentation
CodeBlockPluginAdds syntax-highlighted code blocks for programming languages.View Details
MathPluginEnables mathematical expressions and equations.View Details
HTMLViewerPluginDisplays the raw HTML content of the editor.View Details

Interactive Plugins

PluginDescriptionDocumentation
LinkPluginAllows inserting and managing hyperlinks.View Details
ChartsPluginAllows embedding and editing charts in the editor.View Details
FormBuilderPluginForm builder plugin for creating interactive forms.View Details

Collaboration and Communication Plugins

PluginDescriptionDocumentation
CollaborationPluginEnables real-time collaborative editing with multiple users.View Details
CommentsPluginAdds support for comments and annotations in the editor.View Details
FootnotesPluginAllows adding footnotes to the content.View Details

Utility Plugins

PluginDescriptionDocumentation
HistoryPluginAdds undo/redo functionality for tracking changes.View Details
ExportPluginEnables exporting editor content to various formats (e.g., HTML, PDF).View Details
ShortcutsPluginAdds keyboard shortcuts for faster editing.View Details
ResponsivePluginEnsures the editor content is responsive across devices.View Details
LanguagePluginProvides language switching capabilities.View Details
SpellCheckerPluginProvides spell-checking functionality.View Details

AI and Advanced Plugins

PluginDescriptionDocumentation
AIAssistantPluginAI-powered assistant for content creation and editing.View Details
FooterPluginAdds a footer section to the editor.View Details

Plugin Configuration

Basic Plugin Usage

javascript
import { HTMLEditor, ToolbarPlugin, AlignmentPlugin } from 'on-codemerge';

const editor = new HTMLEditor(container);

// Register plugins
editor.use(new ToolbarPlugin());
editor.use(new AlignmentPlugin());

Plugin Configuration Examples

javascript
// Configure plugins with options
editor.use(new FileUploadPlugin({
  maxFileSize: 20 * 1024 * 1024, // 20MB
  allowedTypes: ['image/jpeg', 'image/png', 'application/pdf'],
  endpoints: {
    upload: '/api/upload',
    download: '/api/download',
  }
}));

editor.use(new CollaborationPlugin({
  serverUrl: 'ws://your-websocket-server.com',
  autoStart: true,
}));

Plugin Dependencies

Some plugins may have dependencies on other plugins. For example:

  • ToolbarPlugin is required for most other plugins to function properly
  • BlockPlugin is often required for content manipulation plugins
  • HistoryPlugin is recommended for undo/redo functionality

Performance Considerations

  • Load only the plugins you need to minimize bundle size
  • Some plugins (like SpellCheckerPlugin) may require additional configuration
  • CollaborationPlugin requires a WebSocket server for full functionality
  • AIAssistantPlugin may require API keys for external AI services

Browser Support

All plugins support the following browsers:

  • Chrome 60+
  • Firefox 55+
  • Safari 12+
  • Edge 79+

Getting Help

If you encounter issues with any plugin:

  1. Check the plugin's documentation page
  2. Verify plugin dependencies are met
  3. Check browser console for errors
  4. Ensure proper initialization order
  5. Review plugin configuration options

Released under the MIT License.