Add TS definitions for step components, and tweak checkbox definition

CHANGELOG.md

@@ -6,6 +6,7 @@
 **Bug fixes**
 
 - Added TypeScript definitions for `EuiToolTip`'s `delay` prop. ([#1284](https://github.com/elastic/eui/pull/1284))
+- Added TypeScript definitions for step components, and some checkbox definition fixes ([#1263](https://github.com/elastic/eui/pull/1263))
 
 **Framer X**
 

src/components/form/checkbox/checkbox.js

@@ -98,7 +98,7 @@ export class EuiCheckbox extends Component {
 EuiCheckbox.propTypes = {
   className: PropTypes.string,
   id: PropTypes.string.isRequired,
-  checked: PropTypes.bool.isRequired,
+  checked: PropTypes.bool,
   label: PropTypes.node,
   onChange: PropTypes.func.isRequired,
   type: PropTypes.oneOf(TYPES),

src/components/form/checkbox/index.d.ts

@@ -13,7 +13,7 @@ declare module '@elastic/eui' {
 
   export interface EuiCheckboxProps {
     id: string;
-    checked: boolean;
+    checked?: boolean;
     onChange: ChangeEventHandler<HTMLInputElement>; // overriding to make it required
     label?: ReactNode;
     type?: EuiCheckboxType;

src/components/index.d.ts

@@ -1,35 +1,36 @@
-/// <reference path="./common.d.ts" />
 /// <reference path="./accordion/index.d.ts" />
 /// <reference path="./avatar/index.d.ts" />
+/// <reference path="./badge/index.d.ts" />
 /// <reference path="./button/index.d.ts" />
+/// <reference path="./call_out/index.d.ts" />
+/// <reference path="./code/index.d.ts" />
+/// <reference path="./combo_box/index.d.ts" />
 /// <reference path="./combo_box/index.d.ts" />
+/// <reference path="./common.d.ts" />
 /// <reference path="./context_menu/index.d.ts" />
 /// <reference path="./description_list/index.d.ts" />
+/// <reference path="./empty_prompt/index.d.ts" />
 /// <reference path="./flex/index.d.ts" />
+/// <reference path="./flyout/index.d.ts" />
+/// <reference path="./form/index.d.ts" />
 /// <reference path="./health/index.d.ts" />
+/// <reference path="./horizontal_rule/index.d.ts" />
 /// <reference path="./icon/index.d.ts" />
-/// <reference path="./panel/index.d.ts" />
-/// <reference path="./popover/index.d.ts" />
-/// <reference path="./form/index.d.ts" />
-/// <reference path="./table/index.d.ts" />
-/// <reference path="./spacer/index.d.ts" />
-/// <reference path="./pagination/index.d.ts" />
+/// <reference path="./key_pad_menu/index.d.ts" />
 /// <reference path="./link/index.d.ts" />
 /// <reference path="./loading/index.d.ts" />
-/// <reference path="./progress/index.d.ts" />
-/// <reference path="./portal/index.d.ts" />
-/// <reference path="./title/index.d.ts" />
-/// <reference path="./text/index.d.ts" />
 /// <reference path="./modal/index.d.ts" />
 /// <reference path="./overlay_mask/index.d.ts" />
-/// <reference path="./horizontal_rule/index.d.ts" />
 /// <reference path="./page/index.d.ts" />
-/// <reference path="./flyout/index.d.ts" />
-/// <reference path="./empty_prompt/index.d.ts" />
-/// <reference path="./code/index.d.ts" />
-/// <reference path="./call_out/index.d.ts" />
-/// <reference path="./badge/index.d.ts" />
+/// <reference path="./pagination/index.d.ts" />
+/// <reference path="./panel/index.d.ts" />
+/// <reference path="./popover/index.d.ts" />
+/// <reference path="./portal/index.d.ts" />
+/// <reference path="./progress/index.d.ts" />
+/// <reference path="./spacer/index.d.ts" />
+/// <reference path="./steps/index.d.ts" />
+/// <reference path="./table/index.d.ts" />
+/// <reference path="./text/index.d.ts" />
+/// <reference path="./title/index.d.ts" />
 /// <reference path="./toast/index.d.ts" />
 /// <reference path="./tool_tip/index.d.ts" />
-/// <reference path="./combo_box/index.d.ts" />
-/// <reference path="./key_pad_menu/index.d.ts" />

src/components/steps/index.d.ts

@@ -0,0 +1,77 @@
+/// <reference path="../common.d.ts" />
+
+declare module '@elastic/eui' {
+  import { SFC, ReactNode, HTMLAttributes, MouseEventHandler } from 'react';
+
+  export type EuiStepStatus = 'complete' | 'incomplete' | 'warning' | 'danger' | 'disabled'
+
+  /**
+   * @see './step.js'
+   */
+
+  export interface EuiStepProps {
+    children: ReactNode, // required
+    status?: EuiStepStatus,
+    step: number,
+    title: string,
+    headingElement?: string,
+  }
+
+  type StandaloneEuiStepProps =
+    CommonProps & HTMLAttributes<HTMLDivElement> & EuiStepProps
+
+  export const EuiStep: SFC<StandaloneEuiStepProps>;
+
+  /**
+   * @see './steps.js'
+   */
+
+  export type EuiContainedStepProps = Omit<StandaloneEuiStepProps, 'step'>;
+
+  export interface EuiStepsProps {
+    firstStepNumber?: number,
+    headingElement?: string,
+    steps: Array<EuiContainedStepProps>,
+  }
+
+  export const EuiSteps: SFC<
+    CommonProps & HTMLAttributes<HTMLDivElement> & EuiStepsProps
+  >;
+
+  /**
+   * @see './sub_steps.js'
+   */
+
+  export interface EuiSubStepsProps {
+  }
+
+  export const EuiSubSteps: SFC<
+    CommonProps & HTMLAttributes<HTMLDivElement> & EuiSubStepsProps
+  >;
+
+  /**
+   * @see './steps_horizontal.js'
+   */
+
+  // EuiStepHorizontal is not exported by EUI
+  type EuiStepHorizontalProp = CommonProps & HTMLAttributes<HTMLDivElement> & {
+    isSelected?: boolean,
+    isComplete?: boolean,
+    onClick: MouseEventHandler<HTMLDivElement>, // required
+    step: number,
+    title: ReactNode,
+    disabled?: boolean,
+    status?: EuiStepStatus,
+  };
+
+  type ContainedEuiStepHorizontalProps = Omit<EuiStepHorizontalProp, 'step'>;
+
+  export interface EuiStepsHorizontalProps {
+    steps: Array<ContainedEuiStepHorizontalProps>,
+  }
+
+  export const EuiStepsHorizontal: SFC<
+    CommonProps & HTMLAttributes<HTMLDivElement> & EuiStepsHorizontalProps
+  >;
+}
+