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

[Emotion] Convert EuiSelectableTemplateSitewide #7944

Merged
merged 11 commits into from
Aug 6, 2024

Conversation

cee-chen
Copy link
Member

@cee-chen cee-chen commented Aug 5, 2024

Summary

Follow up to #7940

EuiSelectableTemplateSitewide has some weirdness where the options file doesn't actually contain any React components, so some extra shenanigans with passing around styles is needed. As always, I recommend following along by commit.

QA

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
    • Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA
    • Updated example that was using classNames directly
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately.
      - [ ] If applicable, added the breaking change issue label (and filled out the breaking change checklist)
  • Designer checklist - N/A
Emotion checklist

General

  • Output CSS matches the previous CSS (works as expected in all browsers)
  • Rendered className(s) read as expected in snapshots and browsers
  • [ ] Checked component playground

Unit tests

  • [ ] shouldRenderCustomStyles() test was added and passes with parent component and any nested childProps (e.g. tooltipProps) - already done previously
  • [ ] Converted Enzyme to RTL - already RTL

Sass/Emotion conversion process

  • Removed component from src/components/index.scss
  • Converted all global Sass vars/mixins to JS (e.g. $euiSize to euiTheme.size.base)
  • Listed var/mixin removals in changelog
  • [ ] Added an @warn deprecation message within the global_styling/mixins/{component}.scss file
  • [ ] Removed or converted component-specific Sass vars/mixins to exported JS versions
  • [ ] Ran yarn compile-scss to update var/mixin JSON files
  • [ ] Simplified calc() to mathWithUnits if possible (if mixing different unit types, this may not be possible)
  • [ ] Deleted any src/amsterdam/overrides/{component}.scss files (styles within should have been converted to the baseline Emotion styles)

CSS tech debt

  • [ ] Wrapped all animations or transitions in euiCanAnimate
  • [ ] Used gap property to add margin between items if using flex
  • Converted side specific padding, margin, and position to -inline and -block logical properties (check inline styles as well as CSS)

DOM Cleanup

  • Did NOT remove any block/element classNames (e.g. euiComponent, euiComponent__child)
  • [ ] SEARCH KIBANA FIRST: Deleted any modifier classNames or maps if not being used in Kibana. - no modifiers removed

Kibana due diligence

  • Search Kibana's codebase for {euiComponent}- (case sensitive) to check for usage of modifier classes
    • [ ] If usage exists, consider converting to a data attribute so that consumers still have something to hook into
  • Pre-emptively check how your conversion will impact the next Kibana upgrade. This entails searching/grepping through Kibana (excluding **/target, **/*.snap, **/*.storyshot for less noise) for eui{Component} (case sensitive) to find:
  • [ ] Any test/query selectors that will need to be updated
  • [ ] Any Sass or CSS that will need to be updated, particularly if a component Sass var was deleted
  • Any direct className usages that will need to be refactored (e.g. someone calling the euiBadge class on a div instead of simply using the EuiBadge component)

Extras/nice-to-have

  • [ ] Reduced specificity where possible (usually by reducing nesting and class name chaining)
  • [ ] Optional component/code cleanup: consider splitting up the component into multiple children if it's overly verbose or difficult to reason about
  • [ ] Documentation pass
  • [ ] Check for issues in the backlog that could be a quick fix for that component

2 Kibana direct className usages that need to be checked:

- this requires passing the styles obj to the `euiSelectableTemplateSitewideFormatOptions` function, which isn't actually a react component :|

+ remove unnecessary `!important`

+ fix import order/unnecessary extra dir
- Ignore `$euiSelectableTemplateFocusBackgroundLight/Dark` - we can't meaningfully use this background in our chroma.js calculations as chroma can't calculate contrast w/ alpha transparency. Using the default body background color should suffice / generates the same output colors
- again, these files aren't React components so we have to continuously pass the memoized style obj around, and use `RenderWithEuiStylesMemoizer` :T

- [syntax] convert `renderOptionMeta` to obj arg notation for easier DX and fallbacks
- render functions don't snapshot well, so we should just render the DOM

+ update the `searchValue` test to be marginally more useful/pointed
- not a lot we can for `__listItem`, but we can at least dogfood `euiSelectableTemplateSitewideRenderOptions` children
- doesn't appear to be needed anymore, not totally sure why tho
+ add a vrt-only one to allow for snapshotting options
@cee-chen cee-chen marked this pull request as ready for review August 5, 2024 23:32
@cee-chen cee-chen requested a review from a team as a code owner August 5, 2024 23:32
Copy link
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

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

Overall looking great! I noticed one small regression on content position, not sure if it's intended?

Screen.Recording.2024-08-06.at.17.22.18.mov

@cee-chen
Copy link
Member Author

cee-chen commented Aug 6, 2024

Overall looking great! I noticed one small regression on content position, not sure if it's intended?

I think it's intended and it's due to the line-height changes/reductions Caroline implemented as part of the Emotion conversion. Also, it looks better and more balanced this way (just my 2 cents!)

@mgadewoll
Copy link
Contributor

Overall looking great! I noticed one small regression on content position, not sure if it's intended?

I think it's intended and it's due to the line-height changes/reductions Caroline implemented as part of the Emotion conversion. Also, it looks better and more balanced this way (just my 2 cents!)

Yeah I'm fine with it too, I just didn't understand where it came from, so I figured better confirm. 👍

Copy link
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

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

🚢 🐈‍⬛ Thanks for the additional explanation; looking good to me! 🚀

@cee-chen cee-chen enabled auto-merge (squash) August 6, 2024 16:38
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

@cee-chen cee-chen merged commit 5a3b036 into elastic:main Aug 6, 2024
5 checks passed
@cee-chen cee-chen deleted the emotion/selectable-template-sitewide branch August 6, 2024 16:58
cee-chen added a commit to elastic/kibana that referenced this pull request Aug 14, 2024
`v95.6.0` ⏩ `v95.7.0`

_[Questions? Please see our Kibana upgrade
FAQ.](https://github.com/elastic/eui/blob/main/wiki/eui-team-processes/upgrading-kibana.md#faq-for-kibana-teams)_

---

## [`v95.7.0`](https://github.com/elastic/eui/releases/v95.7.0)

**CSS-in-JS conversions**

- Converted `EuiSelectable` to Emotion
([#7940](elastic/eui#7940))
  - Removed `$euiSelectableListItemBorder`
  - Removed `$euiSelectableListItemPadding`
- Converted `EuiSelectableTemplateSitewide` to Emotion
([#7944](elastic/eui#7944))
  - Removed `$euiSelectableTemplateFocusBackgroundLight`
  - Removed `$euiSelectableTemplateFocusBackgroundDark`
  - Removed `$euiSelectableTemplateSitewideTypes`
- Converted `EuiComboBox` to Emotion
([#7950](elastic/eui#7950))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants