Add ability to parse line breaks into <br/> for Docgen description in… #2053
Conversation
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`PropTable multiLineText should have 2 br tags for 3 lines of text 1`] = ` | ||
| Array [ |
There was a problem hiding this comment.
ESlint rules seem to prevent these from being one line each
There was a problem hiding this comment.
Eslint shouldn't do anything with js.snap files. Please check your editor settings
There was a problem hiding this comment.
It's actually this that ESlint doesn't want me to make a 1 liner. https://github.com/storybooks/storybook/pull/2053/files#diff-93c8453ec93a245a8bc84801b42540c7R96. That is causing this snapshot to be so big (not that that really matters)
dangreenisrael
force-pushed
the
addon-info-add-ability-new-line-in-description-#1311
branch
from
adfd81a
to
1fe6754
Compare
dangreenisrael
force-pushed
the
addon-info-add-ability-new-line-in-description-#1311
branch
from
1fe6754
to
6273258
Compare
Codecov Report
@@ Coverage Diff @@
## release/3.3 #2053 +/- ##
===============================================
+ Coverage 22.3% 22.33% +0.03%
===============================================
Files 326 326
Lines 6537 6555 +18
Branches 810 829 +19
===============================================
+ Hits 1458 1464 +6
+ Misses 4476 4474 -2
- Partials 603 617 +14
Continue to review full report at Codecov.
|
| @@ -82,6 +82,22 @@ const propsFromPropTypes = type => { | |||
| return props; | |||
| }; | |||
|
|
|||
| export const multiLineText = text => { | |||
| if (!text) return ''; | |||
There was a problem hiding this comment.
Does anyone have a preference here to return null and therefore render <td/> versus an empty string('') and <td></td>
There was a problem hiding this comment.
I think I'd prefer the short version
| @@ -82,6 +82,22 @@ const propsFromPropTypes = type => { | |||
| return props; | |||
| }; | |||
|
|
|||
| export const multiLineText = text => { | |||
| if (!text) return ''; | |||
| const arrayOfText = text.replace(/\r?\n|\r/g, '--newline--').split('--newline--'); | |||
There was a problem hiding this comment.
Why not just split on global regexp?
… rather than return an empty string
|
Please update test snapshot and merge as soon as CI jobs pass |
|
Will do when I get home tonight |
Hypnosphi
deleted the
addon-info-add-ability-new-line-in-description-#1311
branch
|
Awesome, great work @dangreenisrael !! 💪 |
Issue: #1311
What I did
Added automatic parsing of line breaks into
<br/>for the Docgen descriptions. I opted for this route over full blown parsing markdown to prevent any weird formatting issues with the table.How to test
Is this testable with jest or storyshots?
This is fully tested with jest
Does this need a new example in the kitchen sink apps?
The Docgen button was updated
Does this need an update to the documentation?
No