-
Notifications
You must be signed in to change notification settings - Fork 841
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
Add component
prop to EuiTextColor
.
#1011
Conversation
- Fix bug: `EuiDescribedFormGroup` renders its `description` inside of a `div` instead of a `span`.
@@ -32,7 +32,7 @@ export const EuiText = ({ size, color, grow, textAlign, children, className, ... | |||
let optionallyAlteredText; | |||
if (color) { | |||
optionallyAlteredText = ( | |||
<EuiTextColor color={color}> | |||
<EuiTextColor color={color} component="div"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think I'd expect EuiText to render as a div, this seems like it would have much wider implications.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean EuiTextColor
, not EuiText
? Since the parent element is a div, rendering another div inside of it seems OK to me... what implications do you foresee?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I didn't notice that the parent element here is a div
. Really didn't expect that :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this makes sense and I'm trying to think of any scenarios where previous implementations might break because of this change, but can't really do so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, pulled and tested docs
I'm confused. Mainly I'm just trying to understand what the bug was. I see in |
Ah sorry! Here's a PR with a screenshot that illustrates the buggy scenario: elastic/kibana#20744. In Kibana's Advanced Settings, we pass block-level elements to the |
Ahh it's when you're trying to pass multiple different types of elements to the description. Ok. |
@@ -32,7 +32,7 @@ export const EuiText = ({ size, color, grow, textAlign, children, className, ... | |||
let optionallyAlteredText; | |||
if (color) { | |||
optionallyAlteredText = ( | |||
<EuiTextColor color={color}> | |||
<EuiTextColor color={color} component="div"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this makes sense and I'm trying to think of any scenarios where previous implementations might break because of this change, but can't really do so.
src/components/text/text_color.js
Outdated
); | ||
}; | ||
|
||
EuiTextColor.propTypes = { | ||
children: PropTypes.node, | ||
className: PropTypes.string, | ||
color: PropTypes.oneOf(COLORS), | ||
component: PropTypes.oneOf(['div', 'span']), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A comment here would be nice.
This fixes a bug, so that now
EuiDescribedFormGroup
renders itsdescription
inside of adiv
instead of aspan
. The original behavior caused issues in advanced settings because divs would end up rendered inside the span.