Add ToastUi editor for markdown elements #1368
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MrSerth
added
enhancement
ruby
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1368 +/- ##
==========================================
+ Coverage 92.19% 92.26% +0.06%
==========================================
Files 101 102 +1
Lines 2397 2418 +21
==========================================
+ Hits 2210 2231 +21
Misses 187 187 ☔ View full report in Codecov by Sentry. |
3 tasks
Add styles to ensure the editor preview matches the final output. Co-authored-by: Julia Casamitjana <[email protected]>
The default ToastUI image insertion feature includes both URL and file upload options. However, file upload functionality isn't supported in the application. This commit addresses the issue by implementing custom code to hide the file upload button while preserving the URL insertion option. Co-authored-by: Julia Casamitjana <[email protected]>
The editor will now have a default height of 300px but a button will let the user expand the editor. It will expand it to fit all content (or up to 400px if the content was not exceeding 300px). In the expanded mode the editor will keep growing as the user types more content. Co-authored-by: Julia Casamitjana <[email protected]>
Manually inserting a codeblock adding three backticks and hitting enter is not functioning in the ToastUI editor due to an existing bug in the library. This commit implements a workaround to address the issue. Co-authored-by: Julia Casamitjana <[email protected]>
JuliaCasamitjana
approved these changes
Apr 26, 2024
Dome-GER
approved these changes
Apr 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
This PR integrates the ToastUi library and uses it in all forms where markdown editors are required (task descriptions and collection descriptions). Hence, this PR relates to #1114 and improves the editor experience for those attributes currently relying on Markdown. All code changes are based on the great work done by @JuliaCasamitjana with openHPI/codeocean#2242.
Note: There are three open bugs affecting the ToastUI preview:
referenceDefinitionto support such links breaks the preview functionality. It has to be disabled.Current behaviour with such bugs:
Decisions / Choices we made
markdown-it) and replacing the contents of the toastUi preview accordingly on the fly. We did not include this workaround, but implementing a similar solution here wouldn't require significant additional effort if we prefer to adopt this somewhat hacky approach.```. The last commit ef77c47 implements a workaround for this bug.