[Color Palette] Deprecate euiPaletteComplimentary; Add `euiPaletteC…

…omplementary` (#6992) Co-authored-by: Cee Chen <[email protected]>
elastic · Jul 26, 2023 · 4cd2803 · 4cd2803
1 parent e316e17
commit 4cd2803
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 9 deletions.
diff --git a/src-docs/src/views/color_palette/color_palette_quantitative.js b/src-docs/src/views/color_palette/color_palette_quantitative.js
@@ -11,7 +11,7 @@ import {
 import { ColorPaletteFlexItem, ColorPaletteCopyCode } from './shared';
 
 import {
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteForStatus,
   euiPaletteForTemperature,
   euiPaletteCool,
@@ -23,7 +23,7 @@ import {
 const paletteData = {
   euiPaletteForStatus,
   euiPaletteForTemperature,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteNegative,
   euiPalettePositive,
   euiPaletteCool,

diff --git a/src-docs/src/views/color_picker/color_palette_display.js b/src-docs/src/views/color_picker/color_palette_display.js
@@ -3,7 +3,7 @@ import {
   euiPaletteColorBlind,
   euiPaletteForStatus,
   euiPaletteForTemperature,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteNegative,
   euiPalettePositive,
   euiPaletteCool,
@@ -49,7 +49,7 @@ const paletteWithStops = [
 const paletteData = {
   euiPaletteForStatus,
   euiPaletteForTemperature,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteNegative,
   euiPalettePositive,
   euiPaletteCool,

diff --git a/src-docs/src/views/elastic_charts/theming.js b/src-docs/src/views/elastic_charts/theming.js
@@ -23,7 +23,7 @@ import {
 
 import {
   euiPaletteColorBlind,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteForStatus,
   euiPaletteForTemperature,
   euiPaletteCool,
@@ -38,7 +38,7 @@ const paletteData = {
   euiPaletteColorBlind,
   euiPaletteForStatus,
   euiPaletteForTemperature,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteNegative,
   euiPalettePositive,
   euiPaletteCool,

diff --git a/src-docs/src/views/markdown_editor/markdown_editor_with_plugins.js b/src-docs/src/views/markdown_editor/markdown_editor_with_plugins.js
@@ -37,7 +37,7 @@ import {
 
 import {
   useEuiTheme,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteCool,
   euiPaletteForStatus,
   euiPaletteForTemperature,
@@ -51,7 +51,7 @@ import { getDefaultEuiMarkdownUiPlugins } from '../../../../src/components/markd
 const paletteData = {
   euiPaletteForStatus,
   euiPaletteForTemperature,
-  euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteNegative,
   euiPalettePositive,
   euiPaletteCool,

diff --git a/src/services/color/eui_palettes.ts b/src/services/color/eui_palettes.ts
@@ -184,7 +184,7 @@ export const euiPaletteForTemperature = function (steps: number): EuiPalette {
   return euiPalette([...cools, ...warms], steps, true);
 };
 
-export const euiPaletteComplimentary = function (steps: number): EuiPalette {
+export const euiPaletteComplementary = function (steps: number): EuiPalette {
   if (steps === 1) {
     return [euiPaletteColorBlind()[1]];
   }
@@ -196,6 +196,12 @@ export const euiPaletteComplimentary = function (steps: number): EuiPalette {
   );
 };
 
+/**
+ * The old typo'd name for this palette remains exported until the end of its deprecation period
+ * @deprecated Use euiPaletteComplementary instead
+ */
+export const euiPaletteComplimentary = euiPaletteComplementary;
+
 export const euiPaletteNegative = function (steps: number): EuiPalette {
   if (steps === 1) {
     return [lightNegativeColor];

diff --git a/src/services/color/index.ts b/src/services/color/index.ts
@@ -31,6 +31,7 @@ export {
   euiPaletteForStatus,
   euiPaletteForTemperature,
   euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteNegative,
   euiPalettePositive,
   euiPaletteCool,

diff --git a/src/services/index.ts b/src/services/index.ts
@@ -37,6 +37,7 @@ export {
   euiPaletteColorBlind,
   euiPaletteColorBlindBehindText,
   euiPaletteComplimentary,
+  euiPaletteComplementary,
   euiPaletteCool,
   euiPaletteForDarkBackground,
   euiPaletteForLightBackground,

diff --git a/upcoming_changelogs/6992.md b/upcoming_changelogs/6992.md
@@ -0,0 +1,4 @@
+**Deprecations**
+
+- Deprecated `euiPaletteComplimentary`; Use `euiPaletteComplementary` instead.
+