Skip to content

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

Merged
cee-chen merged 7 commits intoelastic:mainfrom
cee-chen:comment-event-css
Aug 1, 2022
Merged

[EuiCommentEvent] Restore child classNames removed in Emotion conversion#6089
cee-chen merged 7 commits intoelastic:mainfrom
cee-chen:comment-event-css

Conversation

@cee-chen
Copy link
Copy Markdown
Contributor

@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

cee-chen added 6 commits July 28, 2022 09:56
- 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
Copy Markdown
Contributor 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
Copy Markdown

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

Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev 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