{"id":29170337,"url":"https://github.com/mendixlabs/ckeditorformendix","last_synced_at":"2025-07-01T12:39:54.356Z","repository":{"id":25853505,"uuid":"29293227","full_name":"mendixlabs/CKEditorForMendix","owner":"mendixlabs","description":"A new WYSIWYG editor for Mendix that also has the ability to create \"MicroFlow\" links in your HTML output.","archived":false,"fork":false,"pushed_at":"2022-12-02T02:46:22.000Z","size":61190,"stargazers_count":2,"open_issues_count":33,"forks_count":21,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-04-13T17:55:34.555Z","etag":null,"topics":["javascript","mendix-widget"],"latest_commit_sha":null,"homepage":"https://appstore.home.mendix.com/link/app/1715/Mendix/CKEditor-For-Mendix","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mendixlabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-15T10:55:01.000Z","updated_at":"2022-03-17T09:11:17.000Z","dependencies_parsed_at":"2022-08-23T16:31:26.667Z","dependency_job_id":null,"html_url":"https://github.com/mendixlabs/CKEditorForMendix","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/mendixlabs/CKEditorForMendix","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mendixlabs%2FCKEditorForMendix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mendixlabs%2FCKEditorForMendix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mendixlabs%2FCKEditorForMendix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mendixlabs%2FCKEditorForMendix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mendixlabs","download_url":"https://codeload.github.com/mendixlabs/CKEditorForMendix/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mendixlabs%2FCKEditorForMendix/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262964074,"owners_count":23391949,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","mendix-widget"],"created_at":"2025-07-01T12:39:45.384Z","updated_at":"2025-07-01T12:39:54.317Z","avatar_url":"https://github.com/mendixlabs.png","language":"JavaScript","readme":"# CKEditor for Mendix [![Support](https://img.shields.io/badge/Mendix%20Support%3A-Community-green.svg)](https://docs.mendix.com/appstore/general/app-store-content-support#community-category)\n\nThis [widget](https://appstore.home.mendix.com/link/app/1715/Mendix/CKEditor-For-Mendix) gives you a full version of the CKEditor with an extra button that allows you to create microflow links inside your HTML output.\n\n![test](https://github.com/mendix/CKEditorForMendix/raw/master/assets/mendix_button.png)\n\nCurrent [CKEditor version](http://ckeditor.com/whatsnew): 4.10.0\n\n## Contributing\n\nFor more information on contributing to this repository visit [Contributing to a GitHub repository](https://world.mendix.com/display/howto50/Contributing+to+a+GitHub+repository)!\n\n## Typical usage scenario\n\nUse this widget to add a full WYSIWYG editor for your entity attributes. This version has the ability to add links to HTML that can run microflows when clicked uppon.\n\n## Description\n\nThe CKEditor widget comes with the CKEditor viewer. This viewer will enable the posibility to reformat links to microflow links.\n\n- The viewer needs an entity and attribute where it can get the HTML code.\n- You can style the link as a button or just text.\n- Within the CKEditor widget configure labels that can be placed with the mendix link button.\n- These labels can be configured in the viewer to execute a microflow.\n- The microflow will get the entity from the viewer widget.\n\n### Example of the entire editor\n\n![test](https://github.com/mendix/CKEditorForMendix/raw/master/assets/ckeditor.png)\n\n### Example of the end result in mendix.\n\n![test](https://github.com/mendix/CKEditorForMendix/raw/master/assets/example_result.png)\n\n### Example of someone clicking the button.\n\n![test](https://github.com/mendix/CKEditorForMendix/raw/master/assets/microflow_executed.png)\n\n## Images\n\nThe CKEditor comes with two modes to handle images:\n\n- Paste them as a base64 string ([Inline images](https://en.wikipedia.org/wiki/Data_URI_scheme))\n- Upload them to Mendix\n\nYou can set this mode using the 'Images' tab in your widget configuration in the Modeler\n\n![images](https://github.com/mendix/CKEditorForMendix/raw/master/assets/images.png)\n\n### Mode 'Upload'\n\n- Make sure the Entity is inherited from System.Image. You can use a reference, in that case the context will set references to the uploaded images.\n- You can set an XPath constraint on the images in the Image browser that you can reach in the CKEditor by clicking ![imagebrowser](https://github.com/mendix/CKEditorForMendix/raw/master/assets/imagebrowser.png). This Image browser is only enabled when you have set Mode to 'Upload' and added an Entity\n- Upload only works when you drag an image from your explorer (for example Windows Explorer) directly in the editor (so Copy + Paste does not work due to browser inconsistensies)\n\n## Behaviour\n\nThe widget has a few options that you can set as default behaviour in the CKEditor\n\n![behaviour](https://github.com/mendix/CKEditorForMendix/raw/master/assets/behaviour.png)\n\n- Entermode: Default behaviour for the editor when pressing Enter. This is Paragraph by default\n- Shift-Entermode: Default behaviour for the editor when pressing Shift + Enter. For example, in Word, when you are working in a list and you want to add an extra rule to your list-item, you use Shift+Enter. By default this should be BR.\n- Autoparagraph: It is recommended to leave this to true. In the CKEditor you can turn it off, but it is not recommended.\n\n## Embedding\n\nThe widget supports embedding of video's. This can be used by clicking ![imagebrowser](https://github.com/mendix/CKEditorForMendix/raw/master/assets/oembed.png). It will automatically create an embed code when you enter the url of the a video (for example YouTube or Vimeo). For more details on what is supported, please see the [plugin page](http://ckeditor.com/addon/oembed)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmendixlabs%2Fckeditorformendix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmendixlabs%2Fckeditorformendix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmendixlabs%2Fckeditorformendix/lists"}