Allow Colon Characters in Period, Sections, and Event Text #5418
Conversation
1. Added function replaceEscapedColon() to replace all instances of 'ESC_COLON' with colons. 2. Added a call to this function within the drawText() function to replace any text that contains to a colon. 3. AUTHOR'S NOTE: These changes only apply for sections, periods, and event elements. This functionality does not work for timeline titles. Changes to timeline.md 1. Updated documentation to guide users on how to include colon characters in their text.
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I have not added the necessary tests for this change to the timeline diagram. I was hoping to get some pointers on how to create tests for this new functionality because the timeline diagram has no rendering tests like some other diagrams. The |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #5418 +/- ##
==========================================
- Coverage 5.74% 5.74% -0.01%
==========================================
Files 276 277 +1
Lines 41887 41908 +21
Branches 514 489 -25
==========================================
Hits 2407 2407
- Misses 39480 39501 +21
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
@FutzMonitor I see some rendering tests in |
Thank you, I'll take a look at it and add a test for my changes. |
1. Added test coverage to rendering changes where 'ESC_COLON' should be changed to a colon character and this change should not break rendering behavior.
1. Changes the test title because it was previously inaccurate
📑 Summary
This PR seeks to allow users to include colon characters in their period, section, and event element text.
Resolves #4175
📏 Design Decisions
replaceEscapedColon()which transformsESC_COLONinto a colon character.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch