fix(Wizard): change labelClose to accept string only

kiwicom · May 24, 2023 · c866ab8 · c866ab8
1 parent 97a7115
commit c866ab8
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/packages/orbit-components/src/Wizard/README.md b/packages/orbit-components/src/Wizard/README.md
@@ -31,7 +31,7 @@ Then use `Wizard` as the container for multiple `WizardStep`s:
 | lockScrolling    | `boolean`                                                 | `true`    | Whether to prevent scrolling of the rest of the page while Modal is open. This is on by default to provide a better user experience. |
 | `direction`      | `row \| column`                                           | `row`     | Allows to use `column` direction on desktop                                                                                          |
 | `dataTest`       | `string`                                                  |           | Optional prop for testing purposes.                                                                                                  |
-| `labelClose`     | `React.Node`                                              | `"Close"` | Property for passing translation string to close Button title                                                                        |
+| `labelClose`     | `string`                                                  | `"Close"` | Property for passing translation string to close Button title                                                                        |
 | `labelProgress`  | `React.Node`                                              |           | Property for passing translation string to progress text                                                                             |
 
 ## WizardStep props

diff --git a/packages/orbit-components/src/Wizard/index.js.flow b/packages/orbit-components/src/Wizard/index.js.flow
@@ -11,7 +11,7 @@ export type Props = {|
   +lockScrolling?: boolean,
   +completedSteps: number,
   +activeStep: number,
-  +labelClose?: React.Node,
+  +labelClose?: string,
   +labelProgress?: React.Node,
   +onChangeStep?: (stepIndex: number) => void | Promise<any>,
   +children: React.ChildrenArray<React.Element<WizardStepComponent>>,

diff --git a/packages/orbit-components/src/Wizard/types.d.ts b/packages/orbit-components/src/Wizard/types.d.ts
@@ -7,7 +7,7 @@ export interface Props extends Common.Globals {
   readonly direction?: "row" | "column";
   readonly completedSteps: number;
   readonly activeStep: number;
-  readonly labelClose?: React.ReactNode;
+  readonly labelClose?: string;
   readonly labelProgress?: React.ReactNode;
   readonly lockScrolling?: boolean;
   readonly onChangeStep?: (stepIndex: number) => void | Promise<any>;