-
Notifications
You must be signed in to change notification settings - Fork 844
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
[Color Palette] Deprecate euiPaletteComplimentary
; Add euiPaletteComplementary
#6992
Conversation
…iPaletteComplimentary due to a spelling error.
… to the new euiPaletteColmplementary
Preview documentation changes for this PR: https://eui.elastic.co/pr_6992/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no need to copy and paste the same exact code twice. We just need to rename the existing palette and then re-export the old name pointing to the new one
Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com>
Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com>
@cee-chen Gotcha! Totally make sense. I need to go in and clean up the commit. I'll do that right after I run the release process |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM once CI passes.
Let's set a ~3 month deprecation period on this (i.e., beginning of November 2023). Can you update the meta issue accordingly?
Preview documentation changes for this PR: https://eui.elastic.co/pr_6992/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 LGTM!
Just updated it to November! |
`85.1.0` ➡️ `86.0.0`⚠️ The biggest change in this PR is migrating the `react-beautiful-dnd` dependency to it's open-source forked successor, `@hello-pangea/dnd`. This new fork has better typescript support and additionally supports both React 17 and React 18. ## [`86.0.0`](https://github.com/elastic/eui/tree/v86.0.0) - Added React 18 support (StrictMode not yet supported). ([#7012](elastic/eui#7012)) **Deprecations** - Deprecated `euiPaletteComplimentary`; Use `euiPaletteComplementary` instead. ([#6992](elastic/eui#6992)) **Breaking changes** - Replaced the underlying drag-and-drop library from `react-beautiful-dnd` to its fork `@hello-pangea/dnd` ([#7012](elastic/eui#7012)) ([#7012](elastic/eui#7012)) - No code updates are needed if using only `<EuiDragDropContext>`, `<EuiDroppable>` and `<EuiDraggable>` with no direct imports from `react-beautiful-dnd`. In case you were importing things from `react-beautiful-dnd` and using them together with EUI components, you need to switch to `@hello-pangea/dnd` which has cross-compatible API. --------- Co-authored-by: Tomasz Kajtoch <tomasz.kajtoch@elastic.co> Co-authored-by: Tomasz Kajtoch <tomek@kajto.ch> Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> Co-authored-by: Drew Tate <andrew.tate@elastic.co>
`85.1.0` ➡️ `86.0.0`⚠️ The biggest change in this PR is migrating the `react-beautiful-dnd` dependency to it's open-source forked successor, `@hello-pangea/dnd`. This new fork has better typescript support and additionally supports both React 17 and React 18. ## [`86.0.0`](https://github.com/elastic/eui/tree/v86.0.0) - Added React 18 support (StrictMode not yet supported). ([#7012](elastic/eui#7012)) **Deprecations** - Deprecated `euiPaletteComplimentary`; Use `euiPaletteComplementary` instead. ([#6992](elastic/eui#6992)) **Breaking changes** - Replaced the underlying drag-and-drop library from `react-beautiful-dnd` to its fork `@hello-pangea/dnd` ([#7012](elastic/eui#7012)) ([#7012](elastic/eui#7012)) - No code updates are needed if using only `<EuiDragDropContext>`, `<EuiDroppable>` and `<EuiDraggable>` with no direct imports from `react-beautiful-dnd`. In case you were importing things from `react-beautiful-dnd` and using them together with EUI components, you need to switch to `@hello-pangea/dnd` which has cross-compatible API. --------- Co-authored-by: Tomasz Kajtoch <tomasz.kajtoch@elastic.co> Co-authored-by: Tomasz Kajtoch <tomek@kajto.ch> Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> Co-authored-by: Drew Tate <andrew.tate@elastic.co>
closes #6901
Summary
It looks like we made a whoopsie a while ago and misspelled
complementary
when naming our color palettes. This PR:@deprecated
flag toeuiPaletteComplimentary
while continuing to export iteuiPaletteComplementary
and updates references in the docsI've added
euiPaletteComplimentary
to the Deprecations schedule. Kibana is only showing two usages at this moment, so this shouldn't be difficult to update during an upgrade.QA
References to the old color palette name have been updated in the docs. Each example should have no visual changes between staging and prod. The new name should also be displayed (
euiPaletteComplementary
).euiPaletteComplementary
in use.General checklist
@default
if default values are missing) and playground toggles