From 7cc470fd70b65cb3d17bf8439b852a153d355b1b Mon Sep 17 00:00:00 2001
From: Greg Thompson <thompsongl@users.noreply.github.com>
Date: Wed, 4 Sep 2019 11:36:21 -0500
Subject: [PATCH] TS button `onClick` clean up (#2282)

* button onclick clean up

* clickable generics

* CL
---
 CHANGELOG.md                                  |  3 +-
 src/components/button/button.tsx              | 28 +++++++++-------
 .../button/button_empty/button_empty.tsx      | 24 ++++++++++----
 .../button/button_icon/button_icon.tsx        | 28 +++++++++-------
 src/components/common.ts                      | 32 ++++++++++++++++++-
 src/components/filter_group/index.d.ts        | 20 +++++++++---
 .../pagination/pagination_button.tsx          | 19 ++++++++---
 7 files changed, 114 insertions(+), 40 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3f2a266259d..8632524c7f7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,7 +2,8 @@
 
 **Bug fixes**
 
-- Removed extra right side margin in 'EuiSuperDatePicker' ([#2236](https://github.com/elastic/eui/pull/2236))
+- Removed extra right side margin in `EuiSuperDatePicker` ([#2236](https://github.com/elastic/eui/pull/2236))
+- Fix incorrect `onClick` type for `EuiButtonEmpty` ([#2282](https://github.com/elastic/eui/pull/2282))
 
 ## [`13.7.0`](https://github.com/elastic/eui/tree/v13.7.0)
 
diff --git a/src/components/button/button.tsx b/src/components/button/button.tsx
index 3fac06d3d08..ff77079e055 100644
--- a/src/components/button/button.tsx
+++ b/src/components/button/button.tsx
@@ -3,12 +3,17 @@ import React, {
   ButtonHTMLAttributes,
   FunctionComponent,
   HTMLAttributes,
-  MouseEventHandler,
   Ref,
 } from 'react';
 import classNames from 'classnames';
 
-import { CommonProps, ExclusiveUnion, keysOf } from '../common';
+import {
+  CommonProps,
+  ExclusiveUnion,
+  PropsForAnchor,
+  PropsForButton,
+  keysOf,
+} from '../common';
 import { EuiLoadingSpinner } from '../loading';
 
 import { getSecureRelForTarget } from '../../services';
@@ -65,18 +70,19 @@ export interface EuiButtonProps extends CommonProps {
   textProps?: HTMLAttributes<HTMLSpanElement>;
 }
 
-type EuiButtonPropsForAnchor = EuiButtonProps &
-  AnchorHTMLAttributes<HTMLAnchorElement> & {
-    href?: string;
-    onClick?: MouseEventHandler<HTMLAnchorElement>;
+type EuiButtonPropsForAnchor = PropsForAnchor<
+  EuiButtonProps,
+  {
     buttonRef?: Ref<HTMLAnchorElement>;
-  };
+  }
+>;
 
-type EuiButtonPropsForButton = EuiButtonProps &
-  ButtonHTMLAttributes<HTMLButtonElement> & {
-    onClick?: MouseEventHandler<HTMLButtonElement>;
+type EuiButtonPropsForButton = PropsForButton<
+  EuiButtonProps,
+  {
     buttonRef?: Ref<HTMLButtonElement>;
-  };
+  }
+>;
 
 export type Props = ExclusiveUnion<
   EuiButtonPropsForAnchor,
diff --git a/src/components/button/button_empty/button_empty.tsx b/src/components/button/button_empty/button_empty.tsx
index bd5615c7103..557c08f2c8d 100644
--- a/src/components/button/button_empty/button_empty.tsx
+++ b/src/components/button/button_empty/button_empty.tsx
@@ -1,7 +1,13 @@
 import React, { FunctionComponent, HTMLAttributes } from 'react';
 import classNames from 'classnames';
 
-import { CommonProps, keysOf, NoArgCallback } from '../../common';
+import {
+  CommonProps,
+  ExclusiveUnion,
+  PropsForAnchor,
+  PropsForButton,
+  keysOf,
+} from '../../common';
 import { EuiLoadingSpinner } from '../../loading';
 import { getSecureRelForTarget } from '../../../services';
 import { IconType, EuiIcon } from '../../icon';
@@ -38,7 +44,7 @@ const flushTypeToClassNameMap = {
 
 export const FLUSH_TYPES = keysOf(flushTypeToClassNameMap);
 
-export interface EuiButtonEmptyProps {
+export interface EuiButtonEmptyProps extends CommonProps {
   iconType?: IconType;
   iconSide?: keyof typeof iconSideToClassNameMap;
   color?: keyof typeof colorToClassNameMap;
@@ -48,7 +54,6 @@ export interface EuiButtonEmptyProps {
   href?: string;
   target?: string;
   rel?: string;
-  onClick?: NoArgCallback<void>;
 
   /**
    * Adds/swaps for loading spinner & disables
@@ -68,7 +73,14 @@ export interface EuiButtonEmptyProps {
   textProps?: Partial<HTMLAttributes<HTMLSpanElement>>;
 }
 
-type Props = CommonProps & EuiButtonEmptyProps;
+type EuiButtonEmptyPropsForAnchor = PropsForAnchor<EuiButtonEmptyProps>;
+
+type EuiButtonEmptyPropsForButton = PropsForButton<EuiButtonEmptyProps>;
+
+type Props = ExclusiveUnion<
+  EuiButtonEmptyPropsForAnchor,
+  EuiButtonEmptyPropsForButton
+>;
 
 export const EuiButtonEmpty: FunctionComponent<Props> = ({
   children,
@@ -148,7 +160,7 @@ export const EuiButtonEmpty: FunctionComponent<Props> = ({
         target={target}
         rel={secureRel}
         ref={buttonRef}
-        {...rest}>
+        {...rest as EuiButtonEmptyPropsForAnchor}>
         {innerNode}
       </a>
     );
@@ -160,7 +172,7 @@ export const EuiButtonEmpty: FunctionComponent<Props> = ({
       className={classes}
       type={type}
       ref={buttonRef}
-      {...rest}>
+      {...rest as EuiButtonEmptyPropsForButton}>
       {innerNode}
     </button>
   );
diff --git a/src/components/button/button_icon/button_icon.tsx b/src/components/button/button_icon/button_icon.tsx
index ec7379c6cdc..300a7746735 100644
--- a/src/components/button/button_icon/button_icon.tsx
+++ b/src/components/button/button_icon/button_icon.tsx
@@ -2,13 +2,18 @@ import React, {
   AnchorHTMLAttributes,
   ButtonHTMLAttributes,
   FunctionComponent,
-  MouseEventHandler,
   Ref,
 } from 'react';
 import classNames from 'classnames';
 
 import { getSecureRelForTarget } from '../../../services';
-import { CommonProps, ExclusiveUnion, keysOf } from '../../common';
+import {
+  CommonProps,
+  ExclusiveUnion,
+  PropsForAnchor,
+  PropsForButton,
+  keysOf,
+} from '../../common';
 
 import { IconType, IconSize, EuiIcon } from '../../icon';
 
@@ -34,18 +39,19 @@ export interface EuiButtonIconProps extends CommonProps {
   iconSize?: IconSize;
 }
 
-type EuiButtonIconPropsForAnchor = EuiButtonIconProps &
-  AnchorHTMLAttributes<HTMLAnchorElement> & {
-    href: string;
-    onClick?: MouseEventHandler<HTMLAnchorElement>;
+type EuiButtonIconPropsForAnchor = PropsForAnchor<
+  EuiButtonIconProps,
+  {
     buttonRef?: Ref<HTMLAnchorElement>;
-  };
+  }
+>;
 
-export type EuiButtonIconPropsForButton = EuiButtonIconProps &
-  ButtonHTMLAttributes<HTMLButtonElement> & {
-    onClick?: MouseEventHandler<HTMLButtonElement>;
+export type EuiButtonIconPropsForButton = PropsForButton<
+  EuiButtonIconProps,
+  {
     buttonRef?: Ref<HTMLButtonElement>;
-  };
+  }
+>;
 
 type Props = ExclusiveUnion<
   EuiButtonIconPropsForAnchor,
diff --git a/src/components/common.ts b/src/components/common.ts
index 9fe52d6fc47..804f03d8256 100644
--- a/src/components/common.ts
+++ b/src/components/common.ts
@@ -1,4 +1,11 @@
-import { Component, FunctionComponent, SFC } from 'react';
+import {
+  AnchorHTMLAttributes,
+  ButtonHTMLAttributes,
+  Component,
+  FunctionComponent,
+  MouseEventHandler,
+  SFC,
+} from 'react';
 
 export interface CommonProps {
   className?: string;
@@ -110,3 +117,26 @@ export type DisambiguateSet<T, U> = {
 export type ExclusiveUnion<T, U> = (T | U) extends object // if there are any shared keys between T and U
   ? (DisambiguateSet<T, U> & U) | (DisambiguateSet<U, T> & T) // otherwise the TS union is already unique
   : T | U;
+
+/**
+ * For components that conditionally render <button> or <a>
+ * Convenience types for extending base props (T) and
+ * element-specific props (P) with standard clickable properties
+ *
+ * These will likely be used together, along with `ExclusiveUnion`:
+ *
+ * type AnchorLike = PropsForAnchor<BaseProps>
+ * type ButtonLike = PropsForButton<BaseProps>
+ * type ComponentProps = ExlcusiveUnion<AnchorLike, ButtonLike>
+ * const Component: FunctionComponent<ComponentProps> ...
+ */
+export type PropsForAnchor<T, P = {}> = T &
+  AnchorHTMLAttributes<HTMLAnchorElement> & {
+    href?: string;
+    onClick?: MouseEventHandler<HTMLAnchorElement>;
+  } & P;
+
+export type PropsForButton<T, P = {}> = T &
+  ButtonHTMLAttributes<HTMLButtonElement> & {
+    onClick?: MouseEventHandler<HTMLButtonElement>;
+  } & P;
diff --git a/src/components/filter_group/index.d.ts b/src/components/filter_group/index.d.ts
index 0b6a9091b55..a99eb43e45f 100644
--- a/src/components/filter_group/index.d.ts
+++ b/src/components/filter_group/index.d.ts
@@ -1,6 +1,11 @@
 import { Component, FunctionComponent, ButtonHTMLAttributes } from 'react';
 
-import { CommonProps } from '../common';
+import {
+  CommonProps,
+  ExclusiveUnion,
+  PropsForAnchor,
+  PropsForButton,
+} from '../common';
 import { EuiButtonEmptyProps } from '../button';
 import { EuiFilterGroupProps } from './filter_group';
 
@@ -11,13 +16,12 @@ declare module '@elastic/eui' {
    * @see './filter_button.js'
    */
 
-  export interface EuiFilterButtonProps {
+  export interface EuiFilterButtonProps extends EuiButtonEmptyProps {
     numFilters?: number;
     numActiveFilters?: number;
     hasActiveFilters?: boolean;
     isSelected?: boolean;
     isDisabled?: boolean;
-    type?: string;
     grow?: boolean;
     withNext?: boolean;
     /**
@@ -25,9 +29,15 @@ declare module '@elastic/eui' {
      */
     noDivider?: boolean;
   }
-  export const EuiFilterButton: FunctionComponent<
-    EuiButtonEmptyProps & EuiFilterButtonProps
+  type EuiFilterButtonPropsForAnchor = PropsForAnchor<EuiFilterButtonProps>;
+
+  type EuiFilterButtonPropsForButton = PropsForButton<EuiFilterButtonProps>;
+
+  type Props = ExclusiveUnion<
+    EuiFilterButtonPropsForAnchor,
+    EuiFilterButtonPropsForButton
   >;
+  export const EuiFilterButton: FunctionComponent<Props>;
 
   /**
    * Filter group type defs
diff --git a/src/components/pagination/pagination_button.tsx b/src/components/pagination/pagination_button.tsx
index ada0ead8899..4ce174e0e06 100644
--- a/src/components/pagination/pagination_button.tsx
+++ b/src/components/pagination/pagination_button.tsx
@@ -1,10 +1,10 @@
 import React, { FunctionComponent } from 'react';
 import classNames from 'classnames';
 
-import { CommonProps, Omit } from '../common';
+import { ExclusiveUnion, PropsForAnchor, PropsForButton } from '../common';
 import { EuiButtonEmpty, EuiButtonEmptyProps } from '../button';
 
-export interface EuiPaginationButtonProps {
+export interface EuiPaginationButtonProps extends EuiButtonEmptyProps {
   isActive?: boolean;
   /**
    * For ellipsis or other non-clickable buttons.
@@ -13,9 +13,18 @@ export interface EuiPaginationButtonProps {
   hideOnMobile?: boolean;
 }
 
-type Props = CommonProps &
-  Omit<EuiButtonEmptyProps, 'size' | 'color'> &
-  EuiPaginationButtonProps;
+type EuiPaginationButtonPropsForAnchor = PropsForAnchor<
+  EuiPaginationButtonProps
+>;
+
+type EuiPaginationButtonPropsForButton = PropsForButton<
+  EuiPaginationButtonProps
+>;
+
+type Props = ExclusiveUnion<
+  EuiPaginationButtonPropsForAnchor,
+  EuiPaginationButtonPropsForButton
+>;
 
 export const EuiPaginationButton: FunctionComponent<Props> = ({
   children,