typo3-ckeditor5
Use when developing CKEditor 5 custom plugins for TYPO3 v12+ (v14.3 LTS bundles CKE5 v47; v13 shipped 41-42), configuring RTE presets, migrating from CKEditor 4, customizing toolbars, dark/light-mode context (on by default in v14, #106964), or fixing rich text editing issues. Triggers: CKE5, RTE config, YAML preset, editor plugin, jQuery removal, backend JS, CKEditor 47.
How do I install this agent skill?
npx skills add https://github.com/netresearch/typo3-ckeditor5-skill --skill typo3-ckeditor5Is this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides comprehensive guidance and verification tools for TYPO3 CKEditor 5 development. It promotes security best practices, including native DOM API usage to prevent XSS and the removal of jQuery from backend plugins. No malicious patterns were detected.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
TYPO3 CKEditor 5 Skill
CKEditor 5 integration patterns for TYPO3: custom plugins, configuration, and migration.
Expertise Areas
- Architecture: Plugin system, schema/conversion, commands, UI components
- TYPO3 Integration: YAML configuration, plugin registration, content elements
- Migration: CKEditor 4->5 complete rewrite (no compatibility layer exists)
Reference Files
references/ckeditor5-architecture.md- Gotchas: figcaption, view-vs-DOM elementsreferences/typo3-integration.md- TYPO3-specific patternsreferences/plugin-development.md- TYPO3 wiring, consumable API, jQuery-free dialogsreferences/migration-guide.md- CKEditor 4->5 migration
Quick Reference
Plugin Registration (ext_localconf.php)
$GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['my_preset'] = 'EXT:my_ext/Configuration/RTE/MyPreset.yaml';
$GLOBALS['TYPO3_CONF_VARS']['SYS']['ckeditor5']['plugins']['my-plugin'] = [
'entryPoint' => 'EXT:my_ext/Resources/Public/JavaScript/Ckeditor/my-plugin.js',
];
Plugin Structure (Editing/UI Split Required)
packages/my-plugin/src/
├── myplugin.js # Main: requires Editing + UI
├── mypluginediting.js # Schema, converters, commands
├── mypluginui.js # Toolbar buttons (ButtonView, componentFactory)
└── myplugincommand.js # Command: execute() + refresh()
Key Patterns
// Schema: always register with allowIn/allowAttributes
schema.register('myElement', { inheritAllFrom: '$block', allowAttributes: ['type'] });
// Converters: both upcast + downcast required
conversion.for('upcast').elementToElement({ view: { name: 'div', classes: 'my-el' }, model: 'myElement' });
conversion.for('downcast').elementToElement({ model: 'myElement', view: 'div' });
// Command: must implement execute() AND refresh()
class MyCommand extends Command {
refresh() { this.isEnabled = /* check model state */; }
execute() { this.editor.model.change(writer => { /* ... */ }); }
}
jQuery Removal (Critical)
TYPO3 backend JS is dropping jQuery without deprecation period. CKEditor 5 plugins must use native APIs only:
querySelector/querySelectorAllinstead of$()fetch()+async/awaitinstead of$.ajax/$.getJSONPromiseinstead of$.Deferred
Backend Integration
Property name mismatch is the #1 bug. Frontend JS must match exact backend response property names.
// Backend returns: { content: "...", model: "...", usage: {...} }
const text = result.content; // CORRECT (not result.completion)
Migration (CKE4 -> CKE5)
CKEditor 5 is a complete rewrite -- no compatibility layer. Migration requires full plugin rewrite:
- Audit CKE4 plugins, map features to CKE5 equivalents
- Convert
CKEDITOR.plugins.add()to class-basedextends Plugin - Replace
editor.widgets.add()with schema + converters + commands - Convert PageTSConfig to YAML preset (
Configuration/RTE/*.yaml) - Use ES6 modules (no AMD/CommonJS)
- Remove all jQuery dependencies
- Verify backend response property names match frontend usage
Verification
./scripts/verify-ckeditor5.sh /path/to/extension
Contributing: https://github.com/netresearch/typo3-ckeditor5-skill
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/netresearch/typo3-ckeditor5-skill/typo3-ckeditor5">View typo3-ckeditor5 on skillZs</a>