Add exports for EuiColorPalettePicker types (#3542)

* Added exports for EuiColorPalettePicker types * Adding changelog
elastic · Jun 3, 2020 · 0e95b75 · 0e95b75
1 parent d0c497b
commit 0e95b75
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 - Added `theme` prop to `EuiHeader` ([#3524](https://github.com/elastic/eui/pull/3524))
 - Added `.euiHeaderLink-isActive` class to `EuiHeaderLink` when `isActive` ([#3524](https://github.com/elastic/eui/pull/3524))
 - Added `display`, `descriptionWidth`, `textWrap` and `isInvalid` props to `EuiExpression` ([#3467](https://github.com/elastic/eui/pull/3467))
+- Added more exports for `EuiColorPalettePicker` types ([#3542](https://github.com/elastic/eui/pull/3542))
 
 **Bug Fixes**
 

diff --git a/src-docs/src/views/color_picker/color_picker_example.js b/src-docs/src/views/color_picker/color_picker_example.js
@@ -12,7 +12,11 @@ import {
   EuiSpacer,
   EuiText,
 } from '../../../../src/components';
-import { EuiColorPalettePickerPalette } from './props';
+import {
+  EuiColorPalettePickerPaletteText,
+  EuiColorPalettePickerPaletteFixed,
+  EuiColorPalettePickerPaletteGradient,
+} from './props';
 
 import { ColorPicker } from './color_picker';
 const colorPickerSource = require('!!raw-loader!./color_picker');
@@ -341,7 +345,12 @@ export const ColorPickerExample = {
           code: colorPalettePickerHtml,
         },
       ],
-      props: { EuiColorPalettePicker, EuiColorPalettePickerPalette },
+      props: {
+        EuiColorPalettePicker,
+        EuiColorPalettePickerPaletteText,
+        EuiColorPalettePickerPaletteFixed,
+        EuiColorPalettePickerPaletteGradient,
+      },
       snippet: colorPalettePickerSnippet,
       demo: <ColorPalettePicker />,
     },

diff --git a/src-docs/src/views/color_picker/props.tsx b/src-docs/src/views/color_picker/props.tsx
@@ -1,7 +1,19 @@
 import React, { FunctionComponent } from 'react';
 
-import { EuiColorPalettePickerPaletteProps } from '../../../../src/components/color_picker/color_palette_picker';
+import {
+  EuiColorPalettePickerPaletteTextProps,
+  EuiColorPalettePickerPaletteFixedProps,
+  EuiColorPalettePickerPaletteGradientProps,
+} from '../../../../src/components/color_picker/color_palette_picker';
 
-export const EuiColorPalettePickerPalette: FunctionComponent<
-  EuiColorPalettePickerPaletteProps
+export const EuiColorPalettePickerPaletteText: FunctionComponent<
+  EuiColorPalettePickerPaletteTextProps
+> = () => <div />;
+
+export const EuiColorPalettePickerPaletteFixed: FunctionComponent<
+  EuiColorPalettePickerPaletteFixedProps
+> = () => <div />;
+
+export const EuiColorPalettePickerPaletteGradient: FunctionComponent<
+  EuiColorPalettePickerPaletteGradientProps
 > = () => <div />;
diff --git a/src/components/color_picker/color_palette_picker/color_palette_picker.tsx b/src/components/color_picker/color_palette_picker/color_palette_picker.tsx
@@ -28,7 +28,7 @@ import { ColorStop } from '../color_stops';
 
 import { EuiSuperSelectProps } from '../../form/super_select';
 
-interface EuiColorPalettePickerPaletteText {
+export interface EuiColorPalettePickerPaletteTextProps {
   /**
    *  For storing unique value of item
    */
@@ -48,7 +48,7 @@ interface EuiColorPalettePickerPaletteText {
   palette?: string[] | ColorStop[];
 }
 
-interface EuiColorPalettePickerPaletteFixed {
+export interface EuiColorPalettePickerPaletteFixedProps {
   /**
    *  For storing unique value of item
    */
@@ -67,7 +67,7 @@ interface EuiColorPalettePickerPaletteFixed {
   palette: string[];
 }
 
-interface EuiColorPalettePickerPaletteGradient {
+export interface EuiColorPalettePickerPaletteGradientProps {
   /**
    *  For storing unique value of item
    */
@@ -88,9 +88,9 @@ interface EuiColorPalettePickerPaletteGradient {
 }
 
 export type EuiColorPalettePickerPaletteProps =
-  | EuiColorPalettePickerPaletteText
-  | EuiColorPalettePickerPaletteFixed
-  | EuiColorPalettePickerPaletteGradient;
+  | EuiColorPalettePickerPaletteTextProps
+  | EuiColorPalettePickerPaletteFixedProps
+  | EuiColorPalettePickerPaletteGradientProps;
 
 export type EuiColorPalettePickerProps<T extends string> = CommonProps &
   Omit<
@@ -103,7 +103,7 @@ export type EuiColorPalettePickerProps<T extends string> = CommonProps &
     selectionDisplay?: 'palette' | 'title';
 
     /**
-     * An array of #EuiColorPalettePickerPalette objects
+     * An array of one of the following objects: #EuiColorPalettePickerPaletteText, #EuiColorPalettePickerPaletteFixed, #EuiColorPalettePickerPaletteGradient
      */
     palettes: EuiColorPalettePickerPaletteProps[];
   };
@@ -127,8 +127,8 @@ export const EuiColorPalettePicker: FunctionComponent<
 }) => {
   const getPalette = (
     item:
-      | EuiColorPalettePickerPaletteFixed
-      | EuiColorPalettePickerPaletteGradient
+      | EuiColorPalettePickerPaletteFixedProps
+      | EuiColorPalettePickerPaletteGradientProps
   ) => {
     const background =
       item.type === 'fixed'

diff --git a/src/components/color_picker/color_palette_picker/index.ts b/src/components/color_picker/color_palette_picker/index.ts
@@ -20,5 +20,8 @@
 export {
   EuiColorPalettePicker,
   EuiColorPalettePickerProps,
+  EuiColorPalettePickerPaletteTextProps,
+  EuiColorPalettePickerPaletteFixedProps,
+  EuiColorPalettePickerPaletteGradientProps,
   EuiColorPalettePickerPaletteProps,
 } from './color_palette_picker';