Skip to content

jamesg31/retool-wysiwyg-editor

Repository files navigation

Retool WYSIWYG Editor

This is a custom component library for Retool that provides a WYSIWYG editor powered by CKEditor 5 in React.

Installation

Requirements:

  1. Node.js v20 or later installed in your development environment.
  2. Git installed in your development environment.
  3. Admin permissions in Retool.
  4. [Optional] If you are running self-hosted Retool, setting the ALLOW_SAME_ORIGIN_OPTION, and SANDBOX_DOMAIN environment variables is recommended.

Steps:

  1. Run git clone https://github.com/jamesg31/retool-wysiwyg-editor.git
  2. Run npm install
  3. Run npx retool-ccl login
  4. Run npx retool-ccl publish

Usage

To use the editor in your Retool project, simply add the HtmlEditor or MarkdownEditor component to your canvas.

Access the components current value by using the value property. Set the value in the components Default value field within the components settings.

You can also set the Placeholder property in the components settings to customize the placeholder text. NOTE: you will need to refresh the page for the placeholder to update.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

About

WYSIWYG Markdown and HTML Editor for Retool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •