Skip to content

Latest commit

 

History

History
124 lines (82 loc) · 4.98 KB

README.md

File metadata and controls

124 lines (82 loc) · 4.98 KB
Raw

Ace-Editor

The high performance code editor for REDAXO (Replacement for codemirror)

Screenshot aceeditor

Dieses AddOn bindet den Code-Editor Ace-Editor v1.35.2 im Backend ein. Die Einstellungen zum AddOn sind unter System->Ace-Editor zu finden.

Hinweis: Der Ace-Editor bietet nicht nur Syntax-Highlighting wie der codemirror, sondern zeigt auch gleich Syntax-Fehler in Echtzeit an (Siehe Screenshot).

Verwendet wird die src-min-noconflict Version v1.35.2 von https://github.com/ajaxorg/ace-builds/

https://github.com/ajaxorg/ace-builds/releases/tag/v1.35.2

Website: https://ace.c9.io/

Beispiel-Seite zum testen des Editors: https://ace.c9.io/build/kitchen-sink.html

Hinweis: Um den Ace-Editor in REDAXO zu verwenden muss der codemirror unter System->Customizer deaktiviert werden!

Tastatur Shortcuts

Eine Übersicht der Default-Shortcuts gibt es hier: https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts

Windows/Linux Mac Action
ESC Command Toggle Fullscreen-Modus
F11 F11 Toggle Fullscreen-Modus
F1 F1 Open command palette
Ctrl-F Command-F Find
Ctrl-H Command-Option-F Replace
Ctrl-, Command-, Show the settings menu
Ctrl-Alt-H Command-Alt-H Show shortcuts

Ace-Editor individuell verwenden

Ace-Editor über Textarea-Attribute anpassen

Für die Verwendung des Ace-Editors mit eigenen Optionen in Modulen oder AddOns sollte für Textareas die Klasse aceeditor verwendet werden.

Beispiel:

<textarea class="aceeditor" aceeditor-theme="eclipse" aceeditor-themedark="dracula" aceeditor-mode="php" aceeditor-options='{"showLineNumbers": true, "showGutter": true}'></textarea>

Hinweis: Die Default-Optionen aus den AddOn-Einstellungen werden immer angewendet!

Individuelle Optionen können über das Attribut aceeditor-options entsprechend gesetzt, oder die Default-Optionen überschrieben werden!

Über Attribute der Textarea kann das Verhalten und die Darstellung des Editors individuell angepasst werden.

Mögliche Attribute

Attribut Mögliche Werte
aceeditor-theme Name des Themes z.B. eclipse (ohne ace/theme)
aceeditor-themedark Name des Themes im Dark-Mode z.B. dracula (ohne ace/theme)
aceeditor-mode Sprache für das Syntax-Highlighting z.B. php, json, html, javascript, yaml, xml (ohne ace/mode)
aceeditor-options Weitere Optionen für den Ace-Editor.
Achtung: Die Optionen müssen im korrekten JSON-Format angegeben werden!
z.B. {"showLineNumbers": true, "showGutter": true}
aceeditor-width Breite des Editors, z.B. 800px, 100%
aceeditor-height Höhe des Editors, z.B. 500px
readonly Durch das Attribut readonly wird der ReadOnly-Modus gesetzt
cols Anzahl Spalten, wenn keine Breite (aceeditor-width) angegeben wird, wird die Breite anhand der FontSize errechnet
rows Anzahl Zeilen, wenn keine Höhe (aceeditor-height) angegeben wird, wird die Höhe anhand der FontSize errechnet
width Breite des Editors, z.B. 800, 100%
height Höhe des Editors, z.B. 500, 50%

Hinweis: Die Default-Optionen können über das Attribut aceeditor-options entsprechend überschrieben werden!

Hinweis: Wird keine Breite angegeben (aceeditor-width, width oder cols) wird 100% als Default verwendet. Wird keine Höhe angegeben (aceeditor-height, height oder rows) wird 200px als Default verwendet.

Ace-Editor in JavaScript

In eigenen Java-Scripten im Backend kann eine Textarea über die Function textAreaToAceEditor() in einen Ace-Editor umgewandelt werden.

Die Optionen aus den AddOn-Einstellungen werden automatisch angewendet.

Beispiel:

<script>
editor = textAreaToAceEditor($('textarea.themepreview')[0]);
</script>

Die Function liefert das editor-Objekt zurück und damit können noch weitere individuelle Optionen gesetzt werden.

Beispiel:

<script>
editor.setTheme('ace/theme/eclipse');
editor.session.setMode('ace/mode/javascript');
editor.setOptions(myoptions);
</script>

Hinweis: Weitere Informationen zum Ace-Editor gibt es hier: https://ace.c9.io/

Optionen für geladene Erweiterungen

Die folgenden Erweitertungen werden zusätzlich geladen:

beautify, keybinding_menu, language_tools, whitespace

Die Erweiterungen beautify, keybinding_menu, whitespace stellen Keyboard-Shortcuts zur Verfügung.

Die Erweiterung language_tools kann durch die folgenden Optionen konfiguriert werden.

"enableBasicAutocompletion": true|false
"enableSnippets": true|false
"enableLiveAutocompletion": true|false

sonstige nützliche Optionen

"customScrollbar": true|false

Hinweis: Der Ace-Editor kann auch im Frontend eingebunden werden: https://friendsofredaxo.github.io/tricks/snippets/aceeditor_im_frontend