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 EuiDatePicker #7937

Merged
merged 21 commits into from
Aug 2, 2024

Conversation

cee-chen
Copy link
Member

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

Summary

This PR converts EuiDatePicker and the underlying react-datepicker theme/custom styles to Emotion. For the latter, it heavily relies on nested 3rd party selectors - I consider modifying react-datepicker directly to use Emotion to be out of scope / unnecessary for now.

This is a fairly hefty PR and contains a ton of cleanup (there was a lot of unused CSS), so I strongly recommend following along by commit and relying primarily on QA.

QA

The below components should generally look the same as production:

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 - N/A
  • Code quality checklist
    - [ ] Added or updated jest and cypress tests
  • 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)
  • Converted Enzyme to RTL

Sass/Emotion conversion process

  • Removed component from src/components/index.scss
  • Deleted any src/amsterdam/overrides/{component}.scss files (styles within should have been converted to the baseline Emotion styles)
  • 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)

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 euiDatePicker-- usages

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

- `.react-datepicker__screenReaderOnly` - doesn't exist in DOM, plus we already have EuiScreenReaderOnly
- `.react-datepicker__header` - isn't doing anything, children are absolutely positioned
- `.react-datepicker-time__header` - is being `display: none`'d elsewhere so why are we truncating it
- `.react-datepicker__month` - individual days are already centered, there's no other styling so border-radius isn't necessary
`.react-datepicker__header--time` only has screen reader text in it and does not need to be `display: none`'d
- allows us to use `className` instead of HOCs for the underlying components

+ delete variable with only one usage
…lements to Emotion

+ handle time select responsive stacking
+ add new stories for testing + quick VRT demos of converted CSS

+ fix incorrect horizontal cut-off of background on prod - use `margin auto` instead of `width: 100%`

+ tweak inline datepicker range to not change time select padding, and adjust container query accordingly
+ write a bunch of stories for VRT / QA to test things got converted propertly
+ remove unnecessary overflow/flex workaround by changing react-datepicker code to sort earliest first in the array
- it's only being used in one place, so I guess just inline it? No idea where the width even came from
@cee-chen cee-chen marked this pull request as ready for review August 1, 2024 02:48
@cee-chen cee-chen requested a review from a team as a code owner August 1, 2024 02:48
cee-chen and others added 5 commits August 1, 2024 10:10
- the `.react-datepicker__header--time` was what was messing with the flex behavior - applying absolute positioning to it fixes the issue via EuiScreenReaderOnly

+ remove unnecessary inline `height` behavior - flex handles everything for us

+ bonus - decrease gapSize on mobile, it's a little too large now (opinion)
…on on mount

- via `scrollIntoView` rather than a manual calc
- the `window.scroll` workaround feels worth the tradeoff

+ remove now-unnecessary refs
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

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.

🚢 🐈‍⬛ Awesome work on the conversion and thanks for the fixes!

@cee-chen
Copy link
Member Author

cee-chen commented Aug 2, 2024

Thanks as always for the amazing review Lene!! 🔥

@cee-chen cee-chen merged commit 978b18d into elastic:main Aug 2, 2024
5 checks passed
@cee-chen cee-chen deleted the emotion/react-date-picker branch August 2, 2024 15:23
cee-chen added a commit to elastic/kibana that referenced this pull request Aug 5, 2024
`v95.5.0` ⏩ `v95.6.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.6.0`](https://github.com/elastic/eui/releases/v95.6.0)

- Updated `EuiIcon` with a new `crossInCircle` glyph
([#7924](elastic/eui#7924))

**Bug fixes**

- Fixed `EuiEmptyPrompt` to correctly collapse and expand responsively
when used with custom breakpoints larger than the default `xl`
breakpoint ([#7935](elastic/eui#7935))

**Accessibility**

- Improved the experience of `EuiModal` by ensuring nested `EuiPopover`
closes on `Escape` keypress instead of the modal
([#7939](elastic/eui#7939))

**CSS-in-JS conversions**

- Converted `EuiDatePicker` to Emotion
([#7937](elastic/eui#7937))
  - Removed `$euiDatePickerCalendarWidth`
  - Removed `$euiDatePickerPadding`
  - Removed `$euiDatePickerGap`
  - Removed `$euiDatePickerCalendarColumns`
  - Removed `$euiDatePickerButtonSize`
  - Removed `$euiDatePickerMinControlWidth`
  - Removed `$euiDatePickerMaxControlWidth`
  - Removed `@mixin datePickerCaret`
  - Removed `@mixin datePickerArrow`
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