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

[EuiCommentEvent] Restore child classNames removed in Emotion conversion #6089

Merged
merged 7 commits into from
Aug 1, 2022

Conversation

cee-chen
Copy link
Member

@cee-chen cee-chen commented Jul 28, 2022

Summary

Several Kibana tests and CSS overrides were targeting these classNames: elastic/kibana@1bdae6b

After some team discussion on Slack, we've decided that for the Emotion conversion, we're generally opting to not remove __child classNames (especially on DOM elements that aren't customizable via consumers/props). They serve as useful hooks/markers for consumers to use.

Modifier -- classNames, especially maps, are fair game to be removed especially if replaced by a data- attribute (I've added one here for event types), but should be checked in Kibana first for usage.

Notes

While I was here I did some minor code cleanup. The first 2 commits (+ snapshots) are the only required changes

Checklist

  • A changelog entry exists and is marked appropriately

- currently used in Kibana for CSS hooks/test selectors
- in favor of just calling headerStyles children directly (since there are no concatenated styles)
…ng a separate const

- I'm not seeing a super strong reason for the separate const personally
@cee-chen cee-chen marked this pull request as ready for review July 28, 2022 17:05
@cee-chen
Copy link
Member Author

I need to duck out for a few hours for an appointment but once I'm back I will be updating the migration guidelines (#5685 (comment)) with these recommendations!

@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_6089/

Copy link
Contributor

@miukimiu miukimiu left a comment

Choose a reason for hiding this comment

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

Thanks, @constancecchen. LGTM! 🎉

@cee-chen cee-chen merged commit e557957 into elastic:main Aug 1, 2022
@cee-chen cee-chen deleted the comment-event-css branch August 1, 2022 21:54
cee-chen pushed a commit that referenced this pull request Aug 2, 2022
…ion (#6089)

* Restore `__` child classNames to EuiCommentEvent

- currently used in Kibana for CSS hooks/test selectors

* Add `data` attribute to replace old modifier classes

* [cleanup] Remove emotion CSS with no styles, move modifiers above children

* [cleanup] Remove unnecessary const declarations

- in favor of just calling headerStyles children directly (since there are no concatenated styles)

* [opinionated] move eventHeader into final JSX directly instead of being a separate const

- I'm not seeing a super strong reason for the separate const personally

* Update EuiComment snapshots

* Changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants