System settings

All settings are under System Settings, namespace tiptapeditor. They can be overridden in context, user group or user settings. Upgrades never reset their values.

TIP

This page is generated from the package sources (npm run docs:generate).

Interface

Key	Description	Default
tiptapeditor.toolbar	Toolbar Toolbar buttons separated by spaces, groups separated by "|". Example: undo redo | heading | bold italic | link image.	undo redo | heading | bold italic underline strike code | color highlight | superscript subscript | align | bulletList orderedList | blockquote horizontalRule | link modxLink anchor | image gallery file table embed | codeBlock | clearFormatting | source fullscreen
tiptapeditor.profiles	Profiles JSON object of named editor profiles, e.g. {"simple": {"toolbar": "bold italic link"}}. A profile overrides the toolbar and features.	(empty)
tiptapeditor.default_profile	Default profile Profile used when no other profile applies.	default
tiptapeditor.content_profile	Content profile Profile for the resource content field. Empty means the default profile.	(empty)
tiptapeditor.tv_profiles	TV profiles TV name → profile: a JSON object such as {"introtext": "simple"}, or name=profile pairs, one per line or comma separated.	(empty)
tiptapeditor.heading_levels	Heading levels Comma separated heading levels available in the editor.	1,2,3,4,5,6
tiptapeditor.bubble_menu	Bubble menu Show a formatting menu above selected text.	Yes
tiptapeditor.floating_menu	Floating menu Show an insert menu on an empty paragraph.	Yes
tiptapeditor.slash_commands	Slash commands Typing "/" on an empty line opens the block menu.	Yes
tiptapeditor.statusbar	Status bar Show word and character count and the current element path.	No
tiptapeditor.sticky_toolbar	Sticky toolbar Keep the toolbar visible while scrolling long content.	Yes
tiptapeditor.enable_fullscreen	Fullscreen Allow the fullscreen mode button (Esc exits).	Yes
tiptapeditor.min_height	Minimum height Minimum editor height in pixels.	200
tiptapeditor.max_height	Maximum height Maximum editor height in pixels when autogrow is on. 0 means unlimited.	700
tiptapeditor.default_height	Default height Editor height in pixels when autogrow is off.	300
tiptapeditor.autogrow	Autogrow Grow the editor with its content up to the maximum height.	Yes
tiptapeditor.content_css	Content CSS Comma separated list of site stylesheets applied to the content inside the editor, e.g. /assets/css/content.css,/assets/css/article.css.	(empty)

Content

Key	Description	Default
tiptapeditor.enable_tables	Tables Tables in the editor: table button, table toolbar. When off, content with tables stays in the plain text field.	Yes
tiptapeditor.enable_images	Images Enable images.	Yes
tiptapeditor.enable_iframe	Iframes and embeds Enable iframe and video embeds.	Yes
tiptapeditor.iframe_allowed_attributes	Allowed iframe attributes Comma separated whitelist of iframe attributes. Event handler attributes (on*) are always removed.	src,width,height,allow,allowfullscreen,loading,title,name,referrerpolicy,frameborder,class,id,style
tiptapeditor.iframe_allowed_hosts	Allowed iframe hosts Comma separated list of hosts allowed in iframe src. Empty allows any host.	(empty)
tiptapeditor.paste_as_text	Paste as text Paste clipboard content as plain text.	No
tiptapeditor.image_classes	Image class presets Classes offered for images: a JSON object {"css-class": "Label"} or a comma separated list of classes.	(empty)
tiptapeditor.enable_gallery	Galleries Enable the gallery button: several images with a template (grid, slider, …).	Yes
tiptapeditor.gallery_template	Gallery template Template of new galleries: grid, slider (Swiper markup), images, or a name from tiptapeditor.gallery_templates.	grid
tiptapeditor.gallery_templates	Own gallery templates JSON with more templates, e.g. {"cards": {"label": "Cards", "wrapper": "<ul class="cards">{items}</ul>", "item": "<li>{image}{caption}</li>"}}. {items} = the pictures, {image} = the image (with its link when "open larger" is on), {caption} = <figcaption> with the caption. Scripts and on* attributes are removed.	(empty)
tiptapeditor.lightbox	Open images larger on click New images and galleries get a link to the image around the picture (<figure><a href="…"><img></a></figure>) for a lightbox script on the site. Can be switched per image and gallery in the dialog.	No
tiptapeditor.lightbox_attribute	Lightbox attribute Attribute your lightbox script looks for, e.g. data-fancybox (Fancybox), data-lightbox, data-gallery. A single image gets it without a value, a gallery with its group name (data-fancybox="gallery-3fa9c1"). Empty: a plain link.	(empty)
tiptapeditor.lightbox_label	Lightbox link label aria-label of the link, {alt} = the alt text or caption. Empty: "Open image: {alt}" in the manager language.	(empty)
tiptapeditor.link_classes	Link class presets CSS classes offered in the link dialog: a JSON object {"css-class": "Label"} or a comma separated list of classes. Empty: free text field.	(empty)
tiptapeditor.paragraph_classes	Paragraph class presets Classes offered for paragraphs: a JSON object {"css-class": "Label"} or a comma separated list of classes.	(empty)
tiptapeditor.table_classes	Table class presets CSS classes offered in the table dialog: JSON object {"css-class": "Label"} (several classes per entry are allowed) or a comma separated list.	(empty)
tiptapeditor.preserve_style_attribute	Preserve style attributes Keep existing style attributes unchanged. Turn off to drop inline styles.	Yes

MODX integration

Key	Description	Default
tiptapeditor.protect_modx_syntax	Protect MODX tags Keep MODX tags like [[*pagetitle]] and [[!snippet? ...]] exactly as written: shown as protected badges, never escaped or split, also when the text around them is edited.	Yes
tiptapeditor.protect_fenom_syntax	Protect Fenom Keep Fenom constructs like {$var}, {if}...{/if} and {foreach} exactly as written: shown as protected badges or cards, never escaped. "{ " with a space stays text (CSS, JSON).	Yes
tiptapeditor.fenom_tags	Extra Fenom tags Comma separated names of your own Fenom tags or functions (myTag, other) to protect in addition to the built-in keywords (if, foreach, set, include, ...).	(empty)
tiptapeditor.modx_autocomplete	MODX autocomplete Suggest fields, snippets, chunks and settings while typing MODX tags.	Yes
tiptapeditor.fenom_autocomplete	Fenom autocomplete Suggest common Fenom variables while typing.	No
tiptapeditor.links_across_contexts	Links across contexts No (default): the MODX resource search in the link dialog finds resources in the context of the edited resource only. Yes: in all contexts the user may load (never mgr).	No
tiptapeditor.resource_link_format	Resource link format href written for a MODX resource chosen in the link dialog. {id} is the resource ID (required); {context} and {uri} are also replaced. Default: [[~{id}]].	[[~{id}]]
tiptapeditor.media_source	Media source Media source ID for the file browser. Empty uses the context default or the TV source.	(empty)
tiptapeditor.media_url_mode	Media URL mode "relative" (default) stores the URL exactly as the MODX Media Browser returns it, like the Image TV; "root" prefixes relative URLs with the site base URL (e.g. /assets/img/a.jpg). Absolute URLs (S3 and other remote sources) are always kept as they are.	relative
tiptapeditor.upload_enabled	Upload dropped and pasted images Upload images dropped or pasted into the editor into the field's Media Source, folder tiptapeditor.upload_path. Uploads go through the MODX file upload (permission file_upload, the source's policies, allowed file types and upload_maxsize apply). Images are never stored as base64.	No
tiptapeditor.upload_path	Upload folder Folder inside the field's Media Source for dropped and pasted images, e.g. assets/uploads/.	assets/uploads/

System

Key	Description	Default
tiptapeditor.external_config	External config Path to a JSON file with additional configuration, e.g. {core_path}config/tiptapeditor.json. Only data is read, no code is executed.	(empty)
tiptapeditor.debug	Debug mode Write diagnostic messages to the browser console and the MODX error log.	No