Merge pull request #28 from webdevnerdstuff/dev

Dev

Author: webdevnerdstuff

.github/CONTRIBUTING.md

@@ -19,31 +19,30 @@ Fork using the command line:
 ### Make your update:
 
 Make your changes to the file(s) you'd like to update.
-Update the CHANGELOG.md with the updates you made, please include the date and Github username.
 
 ### Open a pull request
 When you're done making changes and you'd like to propose them for review, open your PR (pull request).
 
 ### Submit your PR & get it reviewed
-- Once you submit your PR, others from the Vue Unicorn Log community will review it with you.
+- Once you submit your PR, others from the Vuetify Stepper Form community will review it with you.
 - After that, we may have questions, check back on your PR to keep up with the conversation.
 
 ### Your PR is merged!
 Congratulations! The whole GitHub community thanks you. :sparkles:
 
 Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/webdevnerdstuff/vuetify-stepper-form/graphs/contributors).
 
-### Keep contributing as you use Vue Unicorn Log
+### Keep contributing as you use Vuetify Stepper Form
 
-Now that you're a part of the Vue Unicorn Log community, you can keep participating in many ways.
+Now that you're a part of the Vuetify Stepper Form community, you can keep participating in many ways.
 
 ## Types of contributions
-You can contribute to the Vue Unicorn Log content and site in several ways. This repo is a place to discuss and collaborate on Vue Unicorn Log! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
+You can contribute to the Vuetify Stepper Form content and site in several ways. This repo is a place to discuss and collaborate on Vuetify Stepper Form! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
 
 ### :mega: Discussions
 Discussions are where we have conversations.
 
-If you'd like help troubleshooting a Vue Unicorn Log PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/webdevnerdstuff/vuetify-stepper-form/discussions).
+If you'd like help troubleshooting a Vuetify Stepper Form PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/webdevnerdstuff/vuetify-stepper-form/discussions).
 
 ### :beetle: Issues
 [Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with.
@@ -75,13 +74,13 @@ suggestions to improve the code or adding of additional features.
 ## Opening a pull request
 You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
 
-## Working in the Vue Unicorn Log repository
-Here's some information that might be helpful while working on a Vue Unicorn Log PR:
+## Working in the Vuetify Stepper Form repository
+Here's some information that might be helpful while working on a Vuetify Stepper Form PR:
 
 <!-- - [Development](/contributing/development.md) - This short guide describes how to get this app running on your local machine. -->
 
 ## Reviewing
-We (usually the Vue Unicorn Log team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
+We (usually the Vuetify Stepper Form team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
 
 - Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.  
 - Reviews discuss content, not the person who created it.  

.release-it.json

@@ -0,0 +1,13 @@
+{
+  "git": {
+    "commitMessage": "chore: release ${version}",
+    "tagName": "v${version}"
+  },
+  "npm": {
+    "publish": true
+  },
+  "github": {
+    "release": true,
+    "releaseName": "v${version}"
+  }
+}

CHANGELOG.md

@@ -32,11 +32,6 @@ The Vuetify Stepper Form plugin provides a structured way to create multi-step f
 [VeeValidate](https://vee-validate.logaretm.com/v4/)
 
 
-## Change Log
- 
-[CHANGELOG](https://github.com/webdevnerdstuff/vuetify-stepper-form/blob/master/CHANGELOG.md)
-
-
 ## License
 
 Copyright (c) 2023 WebDevNerdStuff  

README.md

@@ -6,17 +6,18 @@ type __VLS_PublicProps = {
 declare function __VLS_template(): {
     slots: Partial<Record<NonNullable<string | number>, (_: any) => any>>;
     refs: {
-        stepperFormRef: any;
+        stepperFormRef: HTMLFormElement;
     };
     attrs: Partial<{}>;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{}>, {
     width: string;
     readonly disabled: boolean;
-    readonly editable: boolean;
+    editable: import('vuetify/lib/components/index.mjs').VStepperItem["editable"];
     autoPageDelay: number;
     direction: "horizontal" | "vertical";
+    jumpAhead: boolean;
     keepValuesOnUnmount: boolean;
     navButtonSize: import('vuetify/lib/components/index.mjs').VBtn["size"];
     tooltipLocation: import('vuetify/lib/components/index.mjs').VTooltip["location"];

dist/plugin/VStepperForm.vue.d.ts

@@ -5,9 +5,57 @@ type __VLS_PublicProps = {
 } & typeof __VLS_typeProps;
 declare function __VLS_template(): {
     slots: Partial<Record<string, (_: {
-        errorMessage: any;
+        prevText?: string | undefined;
+        nextText?: string | undefined;
+        theme?: string | undefined;
+        tag?: string | undefined;
+        rounded?: string | number | boolean | undefined;
+        tile?: boolean | undefined;
+        elevation?: string | number | undefined;
+        height?: string | number | undefined;
+        maxHeight?: string | number | undefined;
+        maxWidth?: string | number | undefined;
+        minHeight?: string | number | undefined;
+        minWidth?: string | number | undefined;
+        width?: string | undefined;
+        border?: string | number | boolean | undefined;
+        color?: string | undefined;
+        selectedClass?: string | undefined;
+        disabled?: boolean | undefined;
+        altLabels?: boolean | undefined;
+        bgColor?: string | undefined;
+        editIcon?: string | undefined;
+        editable?: import('vuetify/lib/components/index.mjs').VStepperItem["editable"] | undefined;
+        errorIcon?: import('vuetify/lib/components/index.mjs').VStepperItem["errorIcon"] | undefined;
+        hideActions?: boolean | undefined;
+        flat?: boolean | undefined;
+        autoPage?: boolean | undefined;
+        autoPageDelay?: number | undefined;
+        density?: import('../../../types').GlobalDensity | undefined;
+        direction?: ("horizontal" | "vertical") | undefined;
+        fieldColumns?: import('../../../types').ResponsiveColumns | undefined;
+        headerTooltips?: boolean | undefined;
+        hideDetails?: import('../../../types').GlobalHideDetails;
+        jumpAhead?: boolean | undefined;
+        keepValuesOnUnmount?: boolean | undefined;
+        navButtonSize?: import('vuetify/lib/components/index.mjs').VBtn["size"] | undefined;
+        navButtonVariant?: import('vuetify/lib/components/index.mjs').VBtn["variant"] | undefined;
+        summaryColumns?: import('../../../types').ResponsiveColumns | undefined;
+        title?: string | undefined;
+        tooltipLocation?: import('vuetify/lib/components/index.mjs').VTooltip["location"] | undefined;
+        tooltipOffset?: import('vuetify/lib/components/index.mjs').VTooltip["offset"];
+        tooltipTransition?: import('vuetify/lib/components/index.mjs').VTooltip["transition"] | undefined;
+        validateOn?: import('../../../types').Field["validateOn"];
+        validateOnMount?: boolean | undefined;
+        variant?: string | undefined;
+        transition?: import('vuetify/lib/components/index.mjs').VStepperWindowItem["transition"] | undefined;
+        FieldLabel: import('vue').DefineComponent<import('../../shared/FieldLabel.vue').FieldLabelProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('../../shared/FieldLabel.vue').FieldLabelProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+        blur: () => Promise<void>;
+        change: () => Promise<void>;
+        input: () => Promise<void>;
         field: {
             options: KeyStringAny<any> | undefined;
+            required: boolean | undefined;
             prevText?: string | undefined;
             nextText?: string | undefined;
             theme?: string | undefined;
@@ -28,7 +76,7 @@ declare function __VLS_template(): {
             altLabels?: boolean | undefined;
             bgColor?: string | undefined;
             editIcon?: string | undefined;
-            editable?: boolean | undefined;
+            editable?: import('vuetify/lib/components/index.mjs').VStepperItem["editable"] | undefined;
             errorIcon?: import('vuetify/lib/components/index.mjs').VStepperItem["errorIcon"] | undefined;
             hideActions?: boolean | undefined;
             flat?: boolean | undefined;
@@ -39,8 +87,10 @@ declare function __VLS_template(): {
             fieldColumns?: import('../../../types').ResponsiveColumns | undefined;
             headerTooltips?: boolean | undefined;
             hideDetails?: import('../../../types').GlobalHideDetails;
+            jumpAhead?: boolean | undefined;
             keepValuesOnUnmount?: boolean | undefined;
             navButtonSize?: import('vuetify/lib/components/index.mjs').VBtn["size"] | undefined;
+            navButtonVariant?: import('vuetify/lib/components/index.mjs').VBtn["variant"] | undefined;
             summaryColumns?: import('../../../types').ResponsiveColumns | undefined;
             title?: string | undefined;
             tooltipLocation?: import('vuetify/lib/components/index.mjs').VTooltip["location"] | undefined;
@@ -50,11 +100,9 @@ declare function __VLS_template(): {
             validateOnMount?: boolean | undefined;
             variant?: string | undefined;
             transition?: import('vuetify/lib/components/index.mjs').VStepperWindowItem["transition"] | undefined;
+            errorMessages: any;
+            modelValue: any;
         };
-        FieldLabel: import('vue').DefineComponent<import('../../shared/FieldLabel.vue').FieldLabelProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('../../shared/FieldLabel.vue').FieldLabelProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-        blur: () => Promise<void>;
-        change: () => Promise<void>;
-        input: () => Promise<void>;
     }) => any>>;
     refs: {};
     attrs: Partial<{}>;

dist/plugin/components/fields/VSFCustom/VSFCustom.vue.d.ts

@@ -5,7 +5,9 @@ interface InternalField extends Omit<Field, 'inline' | 'inlineSpacing' | 'labelP
     color?: VSwitch['color'];
     density?: VSwitch['density'];
     falseIcon?: VSwitch['falseIcon'];
+    falseValue?: VSwitch['falseValue'];
     hideDetails?: VSwitch['hideDetails'];
+    trueValue?: VSwitch['trueValue'];
 }
 export interface VSFSwitchProps extends SharedProps {
     field: InternalField;

dist/plugin/components/fields/VSFSwitch/index.d.ts

@@ -9,10 +9,8 @@ type __VLS_PublicProps = {
     modelValue?: any;
 } & typeof __VLS_typeProps;
 declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    submit: (...args: any[]) => void;
     goToQuestion: (...args: any[]) => void;
 }, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
-    onSubmit?: ((...args: any[]) => any) | undefined;
     onGoToQuestion?: ((...args: any[]) => any) | undefined;
 }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

dist/plugin/components/shared/PageReviewContainer.vue.d.ts

@@ -1,4 +1,4 @@
-import { UseAutoPage, UseBuildSettings, UseColumnErrorCheck, UseDeepMerge } from '../types';
+import { UseAutoPage, UseBuildSettings, UseColumnErrorCheck, UseDeepMerge, UseGetFirstAndLastEditableFalse } from '../types';
 export declare const useDeepMerge: UseDeepMerge;
 /**
 * Builds the settings object.
@@ -12,3 +12,4 @@ export declare const useAutoPage: UseAutoPage;
  * Checks if the column values are between 1 and 12.
  */
 export declare const useColumnErrorCheck: UseColumnErrorCheck;
+export declare const useGetFirstAndLastEditableFalse: UseGetFirstAndLastEditableFalse;

dist/plugin/composables/helpers.d.ts

@@ -0,0 +1,4 @@
+import { UseHandleJumpAhead, UseHandleNonJumpAhead } from '../types';
+declare const useHandleJumpAhead: UseHandleJumpAhead;
+declare const useHandleNonJumpAhead: UseHandleNonJumpAhead;
+export { useHandleJumpAhead, useHandleNonJumpAhead, };

dist/plugin/composables/navigation.d.ts

@@ -1,5 +1,5 @@
 import { FieldValidator, FormValidationResult, GenericObject } from 'vee-validate';
-import { App } from 'vue';
+import { App, MaybeRef } from 'vue';
 import { VBtn, VStepper, VStepperItem, VStepperWindowItem, VTooltip } from 'vuetify/components';
 import { ValidationRule } from 'vuetify/composables/validation';
 import { Schema } from 'yup';
@@ -80,12 +80,15 @@ export interface Props extends /* @vue-ignore */ VStepperProps, VStepperWindowIt
     color?: string | undefined;
     density?: GlobalDensity;
     direction?: 'horizontal' | 'vertical';
+    editable?: VStepperItem['editable'];
     errorIcon?: VStepperItem['errorIcon'];
     fieldColumns?: ResponsiveColumns | undefined;
     headerTooltips?: boolean;
     hideDetails?: GlobalHideDetails;
+    jumpAhead?: boolean;
     keepValuesOnUnmount?: boolean;
     navButtonSize?: VBtn['size'];
+    navButtonVariant?: VBtn['variant'];
     summaryColumns?: ResponsiveColumns;
     title?: string;
     tooltipLocation?: VTooltip['location'];
@@ -120,7 +123,7 @@ export interface UseBuildSettings {
     (props: Settings): Settings;
 }
 export interface UseDeepMerge {
-    (A: Record<string, any>, B: Record<string, any>, C: Record<string, any>): Record<string, any>;
+    (A: Record<string, any>, B: Record<string, any>, C?: Record<string, any>): Record<string, any>;
 }
 export interface UseAutoPage {
     (options: {
@@ -138,6 +141,12 @@ export interface UseColumnErrorCheck {
         propName?: string;
     }): void;
 }
+export interface UseGetFirstAndLastEditableFalse {
+    (pages: Page[]): {
+        firstNonEditableIndex: number;
+        lastNonEditableIndex: number;
+    };
+}
 export type ComputedClasses = Record<string, boolean>;
 export interface UseContainerClasses {
     (options: {
@@ -156,6 +165,35 @@ export interface UseColumnClasses {
         propName?: string;
     }): ComputedClasses;
 }
+export interface UseHandleJumpAhead {
+    (options: {
+        currentPageEditable: boolean;
+        currentPageIdx: MaybeRef<number>;
+        firstNonEditableIndex: number;
+        lastNonEditableIndex: number;
+        lastPageIdx: number;
+        nextPageEditable: boolean;
+        nextPageNotEditable: boolean;
+        pageIdx: number;
+        pageNotEditable: boolean;
+        previousPageEditable: boolean;
+        previousPageNotEditable: boolean;
+    }): boolean;
+}
+export interface UseHandleNonJumpAhead {
+    (options: {
+        currentPageEditable: boolean;
+        currentPageIdx: MaybeRef<number>;
+        firstNonEditableIndex: number;
+        lastNonEditableIndex: number;
+        lastPageIdx: number;
+        nextPageEditable: boolean;
+        nextPageNotEditable: boolean;
+        pageEditable: boolean;
+        pageIdx: number;
+        pageNotEditable: boolean;
+    }): boolean;
+}
 declare module 'vue' {
     interface ComponentCustomProperties {
     }

dist/plugin/types/index.d.ts

@@ -3,6 +3,7 @@ export declare const AllProps: {
     direction: "horizontal";
     disabled: boolean;
     editable: boolean;
+    jumpAhead: boolean;
     keepValuesOnUnmount: boolean;
     navButtonSize: "large";
     tooltipLocation: "bottom";