[Docs] GridList, IconButton, IconMenu, LeftNav, LinearPogress, List - Add title & description to examples #2967
Conversation
| <PropTypeDescription code={gridListCode}/> | ||
| <PropTypeDescription code={gridTileCode}/> | ||
| <PropTypeDescription header="### Grid List Properties" code={gridListCode}/> | ||
| <PropTypeDescription header="### Grid Tile Properties" code={gridTileCode}/> |
There was a problem hiding this comment.
What do you think about using the name of the component: ### GridTile Properties?
There was a problem hiding this comment.
Yes, I was undecided, since we use the feature name in some places, and the component name in others. It would be good to have clarity, and therefore consistency in when to use one or the other.
Also, for features with only one component, should it be "SomeComponent Properties", or just "Properties". Obviously where there are sub components, disbiguation is essential.
Similarly, should the example titles, for example: "Controlled example", "Controlled Left Nav", or "Controlled LeftNav".
There was a problem hiding this comment.
To clarify my point of view, I think that:
- For feature with only one component
Propertiesis enough. We are already in the context of this specific component. - For feature with more than one component, we need to specify the component name the properties are linked to. Hence, I think that the
component.displayNamewill be better. - For examples, I don't think that
Controlled exampleis better for the same reason that we should use:
/**
* The css class name of the root element.
*/
className: React.PropTypes.string,and not:
/**
* Applied to the app bar's root element.
*/
className: React.PropTypes.string,
|
I'll circle back and review previous PRs before we close #2927. |
oliviertassinari
changed the title
| simple: 'An Icon Button using an icon specified with the `iconClassName` property, and a `disabled` example.', | ||
| tooltip: 'Icon Buttons showing the available `tooltip` positions.', | ||
| touch: 'The `touch` property adjusts the tooltip size for better visibility on mobile devices.', | ||
| other: 'An Icon Button using a nested [Font Icon](http://localhost:3000/#/components/font-icon), ' + |
|
Should be good to go. |
| const GridListPage = () => ( | ||
| <div> | ||
| <MarkdownElement text={gridListReadmeText} /> | ||
| <CodeExample code={gridListExampleSimpleCode}> | ||
| <CodeExample | ||
| title="Simple Grid List" |
|
Or maybe not! 😁 |
|
🙏 |
[Docs] GridList, IconButton, IconMenu, LeftNav, LinearPogress, List - Add title & description to examples
|
🎬 |
For #2927.