Fix types and defaults

- set Props "run" to be optional.
gilbarbara · Sep 9, 2024 · 568bafd · 568bafd
1 parent e813ebd
commit 568bafd
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/src/components/index.tsx b/src/components/index.tsx
@@ -35,7 +35,7 @@ class Joyride extends React.Component<Props, State> {
   constructor(props: Props) {
     super(props);
 
-    const { debug, getHelpers, run, stepIndex } = props;
+    const { debug, getHelpers, run = true, stepIndex } = props;
 
     this.store = createStore({
       ...props,

diff --git a/src/defaults.ts b/src/defaults.ts
@@ -1,8 +1,8 @@
 import { noop } from '~/modules/helpers';
 
-import { Locale } from '~/types';
+import { FloaterProps, Locale, Props, Step } from '~/types';
 
-export const defaultFloaterProps = {
+export const defaultFloaterProps: FloaterProps = {
   options: {
     preventOverflow: {
       boundariesElement: 'scrollParent',
@@ -43,7 +43,7 @@ export const defaultStep = {
   showSkipButton: false,
   spotlightClicks: false,
   spotlightPadding: 10,
-};
+} satisfies Omit<Step, 'content' | 'target'>;
 
 export const defaultProps = {
   continuous: false,
@@ -64,4 +64,4 @@ export const defaultProps = {
   spotlightClicks: false,
   spotlightPadding: 10,
   steps: [],
-};
+} satisfies Props;
diff --git a/src/types/components.ts b/src/types/components.ts
@@ -178,7 +178,7 @@ export type Props = Simplify<
      * Run/stop the tour.
      * @default true
      */
-    run: boolean;
+    run?: boolean;
     /**
      * The duration for scroll to element.
      * @default 300
@@ -378,3 +378,5 @@ export type TooltipRenderProps = Simplify<
     };
   }
 >;
+
+export type { Props as FloaterProps } from 'react-floater';