v-onboarding 2.8.0 → 2.8.1

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+import type { createPopper } from "@popperjs/core/lib/createPopper";
+import type { DefineComponent } from 'vue';
+declare const VOnboardingWrapper: DefineComponent<{
+    steps: StepEntity[];
+    options?: VOnboardingWrapperOptions;
+}>;
+declare const VOnboardingStep: DefineComponent;
+declare const useVOnboarding: (wrapperRef: any) => {
+    start(): void;
+    finish(): void;
+    goToStep: (newStepNumber: number | ((currentStepNumber: number) => number)) => void;
+};
+interface SvgOverlayOptions {
+    enabled?: boolean;
+    padding?: number | {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
+    borderRadius?: number | {
+        leftTop?: number;
+        rightTop?: number;
+        rightBottom?: number;
+        leftBottom?: number;
+    };
+    preventOverlayInteraction?: boolean;
+}
+interface VOnboardingWrapperOptions {
+    popper?: Parameters<typeof createPopper>[2];
+    overlay?: SvgOverlayOptions;
+    scrollToStep?: {
+        enabled?: boolean;
+        options?: ScrollIntoViewOptions;
+    };
+    autoFinishByExit?: boolean;
+    hideButtons?: {
+        previous?: boolean;
+        next?: boolean;
+        exit?: boolean;
+    };
+    labels?: {
+        previousButton?: string;
+        nextButton?: string;
+        finishButton?: string;
+    };
+    hideNextStepDuringHook?: boolean;
+}
+declare type AttachableElement = string | (() => Element | null);
+interface onGlobalOptions {
+    index: number;
+    step: StepEntity;
+    direction: 1 | -1 | number;
+    isForward: boolean;
+    isBackward: boolean;
+}
+declare type onBeforeStepOptions = onGlobalOptions & {};
+declare type onAfterStepOptions = onGlobalOptions & {};
+interface StepEntity {
+    content: {
+        title: string;
+        description?: string;
+        html?: boolean;
+    };
+    on?: {
+        beforeStep?: (options?: onBeforeStepOptions) => void | Promise<void>;
+        afterStep?: (options?: onAfterStepOptions) => void | Promise<void>;
+    };
+    attachTo: {
+        element: AttachableElement;
+        classList?: string[];
+    };
+    options?: VOnboardingWrapperOptions;
+}
+export { VOnboardingWrapperOptions, VOnboardingWrapper, VOnboardingStep, useVOnboarding, AttachableElement, StepEntity, onBeforeStepOptions, onAfterStepOptions, SvgOverlayOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v-onboarding",
-  "version": "2.8.0",
+  "version": "2.8.1",
   "description": "v-onboarding is a super-slim, fully-typed onboarding component for Vue 3",
   "repository": {
     "type": "git",
@@ -22,11 +22,9 @@
   ],
   "files": [
     "dist",
-    "src/types/*",
-    "src/typings.d.ts",
     "web-types"
   ],
-  "types": "src/typings.d.ts",
+  "types": "./dist/index.d.ts",
   "main": "./dist/v-onboarding.umd.js",
   "module": "./dist/v-onboarding.es.js",
   "exports": {

package/web-types/web-types.json

@@ -1,7 +1,7 @@
 {
   "framework": "vue",
   "name": "v-onboarding",
-  "version": "1.1.0",
+  "version": "2.8.1",
   "contributions": {
     "html": {
       "description-markup": "markdown",

package/src/types/StepEntity.d.ts

@@ -1,34 +0,0 @@
-import { VOnboardingWrapperOptions } from "@/types/VOnboardingWrapper";
-
-export type AttachableElement = string | (() => Element | null)
-
-interface onGlobalOptions {
-  index: number
-  step: StepEntity
-  direction: 1 | -1 | number
-  isForward: boolean
-  isBackward: boolean
-}
-export type onBeforeStepOptions = onGlobalOptions & {
-  // custom options here
-}
-export type onAfterStepOptions = onGlobalOptions & {
-  // custom options here
-}
-
-export interface StepEntity {
-  content: {
-    title: string;
-    description?: string;
-    html?: boolean
-  }
-  on?: {
-    beforeStep?: (options?: onBeforeStepOptions) => void | Promise<void>
-    afterStep?: (options?: onAfterStepOptions) => void | Promise<void>
-  },
-  attachTo: {
-    element: AttachableElement,
-    classList?: string[]
-  }
-  options?: VOnboardingWrapperOptions
-}

package/src/types/VOnboardingWrapper.ts

@@ -1,69 +0,0 @@
-import type { createPopper } from "@popperjs/core/lib/createPopper";
-
-export interface SvgOverlayOptions {
-  enabled?: boolean
-  padding?: number | {
-    top?: number;
-    right?: number;
-    bottom?: number;
-    left?: number;
-  }
-  borderRadius?: number | {
-    leftTop?: number;
-    rightTop?: number;
-    rightBottom?: number;
-    leftBottom?: number;
-  }
-  preventOverlayInteraction?: boolean
-}
-
-export interface VOnboardingWrapperOptions {
-  popper?: Parameters<typeof createPopper>[2]
-  overlay?: SvgOverlayOptions,
-  scrollToStep?: {
-    enabled?: boolean
-    options?: ScrollIntoViewOptions
-  },
-  autoFinishByExit?: boolean
-  hideButtons?: {
-    previous?: boolean
-    next?: boolean
-    exit?: boolean
-  },
-  labels?: {
-    previousButton?: string
-    nextButton?: string
-    finishButton?: string
-  }
-  hideNextStepDuringHook?: boolean
-}
-
-export const defaultVOnboardingWrapperOptions: VOnboardingWrapperOptions = {
-  popper: {},
-  overlay: {
-    enabled: true,
-    padding: 0,
-    borderRadius: 0,
-    preventOverlayInteraction: true
-  },
-  scrollToStep: {
-    enabled: true,
-    options: {
-      behavior: 'smooth',
-      block: 'center',
-      inline: 'center'
-    }
-  },
-  autoFinishByExit: true,
-  labels: {
-    previousButton: 'Previous',
-    nextButton: 'Next',
-    finishButton: 'Finish'
-  },
-  hideButtons: {
-    previous: false,
-    next: false,
-    exit: false
-  },
-  hideNextStepDuringHook: false
-}

package/src/types/index.ts

@@ -1,26 +0,0 @@
-import { ComputedRef, InjectionKey, Ref } from "vue";
-import { StepEntity } from "./StepEntity";
-import { VOnboardingWrapperOptions } from "./VOnboardingWrapper";
-
-export interface OnboardingState {
-  step: ComputedRef<StepEntity>;
-  options: ComputedRef<VOnboardingWrapperOptions>;
-  next: () => void;
-  previous: () => void;
-  finish: () => void;
-  exit: () => void;
-  isFirstStep: ComputedRef<boolean>;
-  isLastStep: ComputedRef<boolean>;
-
-}
-export const STATE_INJECT_KEY = Symbol('onboardingState') as InjectionKey<Ref<OnboardingState>>
-
-export const OnboardingState = {
-  IDLE: -1,
-  FINISHED: -2
-}
-
-export const Direction = {
-  BACKWARD: -1,
-  FORWARD: 1
-}

package/src/typings.d.ts

@@ -1,18 +0,0 @@
-import { DefineComponent } from 'vue'
-import { StepEntity } from '@/types/StepEntity'
-import { VOnboardingWrapperOptions } from '@/types/VOnboardingWrapper'
-
-declare const VOnboardingWrapper: DefineComponent<{
-  steps: StepEntity[]
-  options?: VOnboardingWrapperOptions
-}>
-
-declare const VOnboardingStep: DefineComponent
-
-declare const useVOnboarding: (wrapperRef: any) => {
-  start(): void
-  finish(): void
-  goToStep: (newStepNumber: number | ((currentStepNumber: number) => number)) => void
-}
-
-export { VOnboardingWrapperOptions, VOnboardingWrapper, VOnboardingStep, useVOnboarding }