[docs] Grid docs should refer to Hidden component/demo #6963
Conversation
- Allow proptype descriptions to covert to component API links - Omit classes section for components that do not export a stylesheet - Strip carriage returns introduced from doc generation on windows
| @@ -188,7 +194,7 @@ section for more detail. | |||
|
|
|||
| If using the \`overrides\` key of the theme as documented | |||
| [here](/customization/themes#customizing-all-instances-of-a-component-type), | |||
| you need to use the following style sheet name: \`${styles.name}\`.`; | |||
| you need to use the following style sheet name: \`${styles.name}\`.` : ''; | |||
There was a problem hiding this comment.
I think that styles.name should always be defined. No need to be defensive.
There was a problem hiding this comment.
This is just the other side of the ternary that checks for styles.classes.length
| @@ -177,7 +183,7 @@ function generateProps(props) { | |||
| } | |||
|
|
|||
| function generateClasses(styles) { | |||
| return `## Classes | |||
| return styles.classes.length ? `## Classes | |||
src/Grid/Grid.js
Outdated
| @@ -190,7 +190,7 @@ type Props = { | |||
| */ | |||
| gutter?: 0 | 8 | 16 | 24 | 40, | |||
| /** | |||
| * If provided, will wrap with Hidden component and given properties. | |||
| * If provided, will wrap with [Hidden component] and given properties. | |||
There was a problem hiding this comment.
What about expliciting the Path? I'm not sure we need to be that smart.
/**
* If provided, will wrap with [Hidden](/component-api/Hidden) component and given properties.
*/There was a problem hiding this comment.
I thought about that and it was my original approach, but wasn't sure if it would add too much noise to the comments. I will go with this! 👍
|
Updated this PR, eliminating the functionality that would generate component links. Following recommendation from @oliviertassinari , links can be directly expressed in propType comments (e.g. Grid's hidden prop) |
|
@kgregory Thanks |
The Grid component API docs list a type of HiddenProps for the hidden prop, but this should really be a link to the Layout demo. I've modified markdown generation to look for this type specifically and return a link.
Added the ability to link to components from proptype descriptions. By including [Hidden component] in the description of Grid's hidden property, a link to the component API is generated when docs are built.Grid's hidden property includes a markdown link to the Hidden component's api docsI also made the following changes: