RTE CKEditor Image

Extension key: rte_ckeditor_image
Package name: netresearch/rte-ckeditor-image
Version: 13.0.x
Language: en
Author: Netresearch DTT GmbH
License: This document is published under the Creative Commons BY 4.0 license.
Rendered: Fri, 17 Oct 2025 23:35:01 +0000

Image support in CKEditor for the TYPO3 ecosystem.

📘 Introduction

The RTE CKEditor Image extension provides comprehensive image handling capabilities for TYPO3's CKEditor Rich Text Editor with full FAL integration.

⚡ Quick Start

Get up and running quickly with installation instructions and basic configuration examples.

⚙️ Configuration

Learn how to configure custom image styles, processing options, and frontend rendering setup.

🏗️ Architecture

Understand the extension's architecture, design patterns, and how components interact.

🔧 Developer API

Explore the PHP and JavaScript APIs for extending and customizing the extension.

🐛 Troubleshooting

Find solutions to common issues and learn debugging techniques.

Introduction

The RTE CKEditor Image extension provides comprehensive image handling capabilities for TYPO3's CKEditor Rich Text Editor. This extension enables editors to insert, configure, and style images directly within the CKEditor interface, with full integration into TYPO3's File Abstraction Layer (FAL).

Key Features

Native CKEditor 5 plugin integration
Full TYPO3 FAL support with file browser integration
Advanced image processing (magic images, cropping, scaling)
Custom image style configuration
Responsive image support
Lazy loading and performance optimization
Event-driven architecture for extensibility

Version Information

Version: 13.0.x for TYPO3 13.4+
License: AGPL-3.0-or-later
Repository: github.com/netresearch/t3x-rte_ckeditor_image

Requirements

System Requirements

TYPO3: 13.4 or later
PHP: 8.2, 8.3, or 8.4
Extensions: cms-rte-ckeditor (included in TYPO3 core)

Critical Dependencies

New in version 13.0.0

The CKEditor plugin now requires StyleUtils and GeneralHtmlSupport dependencies for style functionality. Previous versions did not have this requirement.

The CKEditor plugin requires these dependencies for style functionality:

static get requires() {
    return ['StyleUtils', 'GeneralHtmlSupport'];
}

Important

Missing either plugin will disable the style dropdown for images. See Style Integration for details.

Quick Start

Installation

Install via Composer:

composer require netresearch/rte-ckeditor-image

Activate the extension in the TYPO3 Extension Manager or via CLI:

vendor/bin/typo3 extension:activate rte_ckeditor_image

Basic Configuration

Add the image button to your RTE configuration:

editor:
  config:
    toolbar:
      items:
        - heading
        - '|'
        - typo3image
        - link
        - '|'
        - bold
        - italic

For complete configuration options, see Configuration Guide.

Quick Navigation by Role

Role	Start Here	Then Read	Advanced
Integrator	Configuration Guide	Examples	Troubleshooting
PHP Dev	Architecture	API Reference	Data Handling
JS Dev	CKEditor Plugin	Style Integration	Conversions
Contributor	Architecture	API Documentation	Examples

Documentation Use Cases

For Integrators

Add custom image styles → Configuration Guide
Configure image processing → Configuration Guide
Set up frontend rendering → Configuration Guide
Enable lazy loading → Examples: Lazy Loading

For Developers

PHP Backend Development

Understand the architecture → Architecture Overview
Controller APIs → Controllers API
Customize image processing → Data Handling API
Listen to extension events → Event Listeners

JavaScript/CKEditor Development

Extend the CKEditor plugin → Plugin Development
Style system integration → Style Integration
Custom model element → Model Element
Conversion system → Conversions

For Troubleshooters

Images not appearing → Frontend Rendering Issues
Style dropdown disabled → Style Drop-down Not Working
File browser not opening → File Browser Issues
Performance problems → Common Issues

Support & Contributing

Get Help

Contribute

Report bugs or request features via GitHub Issues
Submit pull requests for code improvements
Improve documentation via pull requests
Follow TYPO3 Contribution Guidelines

License

This extension is licensed under AGPL-3.0-or-later.

Credits

Development & Maintenance

Netresearch DTT GmbH
Sebastian Koschel
Sebastian Mendel
Rico Sonntag

Community Contributors

See GitHub Contributors

Additional Resources

TYPO3 Extension Repository: extensions.typo3.org/extension/rte_ckeditor_image
Packagist: packagist.org/packages/netresearch/rte-ckeditor-image
TYPO3 CKEditor Documentation: docs.typo3.org - RTE CKEditor
CKEditor 5 Documentation: ckeditor.com/docs/ckeditor5