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] EuiMarkdownEditor #6402

Closed
16 tasks done
Tracked by #5685
daveyholler opened this issue Nov 18, 2022 · 1 comment · Fixed by #7738
Closed
16 tasks done
Tracked by #5685

[Emotion] EuiMarkdownEditor #6402

daveyholler opened this issue Nov 18, 2022 · 1 comment · Fixed by #7738
Assignees
Labels
emotion task A task associated with a larger issue, wouldn't prioritize it independently

Comments

@daveyholler
Copy link
Contributor

daveyholler commented Nov 18, 2022

Kibana usage

  • 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

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

  • Converted all global Sass vars/mixins to JS (e.g. $euiSize to euiTheme.size.base)
  • Removed or converted component-specific Sass vars/mixins to exported JS versions
  • Listed var~/mixin~ removals in changelog
  • [ ] 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) - No usages
  • [ ] Added an @warn deprecation message within the global_styling/mixins/{component}.scss file
  • 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)

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.

Kibana due diligence

See below checklist/details section


Extras/nice-to-have

  • [ ] Documentation pass:
  • Reduced specificity where possible (usually by reducing nesting and class name chaining) - NOTE: Made a moderate pass at this but overall did not completely attempt to remove nested selectors/!importants
  • [ ] Check for issues in the backlog that could be a quick fix for that component
  • [ ] Optional component/code cleanup: consider splitting up the component into multiple children if it's overly verbose or difficult to reason about
@github-actions
Copy link

👋 Hi there - this issue hasn't had any activity in 6 months. If the EUI team has not explicitly expressed that this is something on our roadmap, it's unlikely that we'll pick this issue up. We would sincerely appreciate a PR/community contribution if this is something that matters to you! If not, and there is no further activity on this issue for another 6 months (i.e. it's stale for over a year), the issue will be auto-closed.

@JasonStoltz JasonStoltz added task A task associated with a larger issue, wouldn't prioritize it independently and removed stale-issue labels May 22, 2023
@cee-chen cee-chen self-assigned this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
emotion task A task associated with a larger issue, wouldn't prioritize it independently
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants