Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Slightly improved propsTable layout #2425 #2426

Merged
merged 1 commit into from
Dec 8, 2015

Conversation

frankf-cgn
Copy link

Because styling a table in markdown is not directly supported, I have reverted to a pure css solution and wrapped the <MarkdownElement> in <PropTypeDescription> with a div.

Fix #2425

@alitaheri
Copy link
Member

@frankf-cgn This looks good. thank you. Only one issue, please make deafults more contrast, it's a bit hard to read

@@ -51,7 +53,9 @@ const PropTypeDescription = React.createClass({
}

return (
<MarkdownElement text={text} />
<div className={'propsTable'}>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't className="propsTable" be better?

@alitaheri
Copy link
Member

Awesome 👍 👍 Please do a rebase and we'll merge this.

@frankf-cgn
Copy link
Author

@oliviertassinari Let me rebase if you are ok with the code.

@@ -51,7 +53,9 @@ const PropTypeDescription = React.createClass({
}

return (
<MarkdownElement text={text} />
<div className="propsTable">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm gonna be rude, but I think that PropTypeDescription or in lower case would be a more explicit className. Though ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm gonna do it, but I think that way too verbose. propTypeTable maybe? But one is good as another, I think ;-)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think propsTable is the balance between verbosity and explicitness. 👍 for propsTable 😁

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then we should rename the component to PropsTable?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, let me rename the className, ok?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oliviertassinari 😱 I see your point. PropTypeDescription 👍

@frankf-cgn
Copy link
Author

Fixed the classname and rebased.

@oliviertassinari
Copy link
Member

@frankf-cgn Thanks. Should we rename docs/src/app/components/props-table.css too 😁?

@frankf-cgn
Copy link
Author

@oliviertassinari You are right. Done.

@oliviertassinari
Copy link
Member

@frankf-cgn Awesome, thanks!

oliviertassinari added a commit that referenced this pull request Dec 8, 2015
[Doc] Slightly improved propsTable layout #2425
@oliviertassinari oliviertassinari merged commit d26fd93 into mui:master Dec 8, 2015
@alitaheri
Copy link
Member

@frankf-cgn The props look awesome thanks a bunch 👍 🎉

@zannager zannager added docs Improvements or additions to the documentation component: table This is the name of the generic UI component, not the React module! labels Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: table This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Proposal: Alternative propsTableLayout
4 participants