@formkit/core - npm Package Compare versions

Comparing version 1.0.0-beta.7-ebffb4b to 1.0.0-beta.7-eeea122

dist/index.d.ts

@@ -17,2 +17,10 @@ /**
 /**
+ * Clears child errors.
+ * @param id - The id of the node you want to clear errors for
+ * @param clearChildren - Determines if the the children of this node should have their errors cleared.
+ * @public
+ */
+export declare function clearErrors(id: string, clearChildren?: boolean): void;
+
+/**
  * Compiles a logical string like "a != z || b == c" into a single function.
@@ -425,59 +433,3 @@ * The return value is an object with a "provide" method that iterates over all
      */
-    state: Record<string, boolean | undefined> & {
-        /**
-         * If the input has been blurred.
-         */
-        blurred: boolean;
-        /**
-         * True when these conditions are met:
-         *
-         * Either:
-         * - The input has validation rules
-         * - The validation rules are all passing
-         * - There are no errors on the input
-         * Or:
-         * - The input has no validation rules
-         * - The input has no errors
-         * - The input is dirty and has a value
-         *
-         * This is not intended to be used on forms/groups/lists but instead on
-         * individual inputs. Imagine placing a green checkbox next to each input
-         * when the user filled it out correctly — thats what these are for.
-         */
-        complete: boolean;
-        /**
-         * If the input has had a value typed into it or a change made to it.
-         */
-        dirty: boolean;
-        /**
-         * If the input has explicit errors placed on it, or in the case of a group,
-         * list, or form, this is true if any children have errors on them.
-         */
-        errors: boolean;
-        /**
-         * True when the input has validation rules. Has nothing to do with the
-         * state of those validation rules.
-         */
-        rules: boolean;
-        /**
-         * True when the input has completed its internal debounce cycle and the
-         * value was committed to the form.
-         */
-        settled: boolean;
-        /**
-         * If the form has been submitted.
-         */
-        submitted: boolean;
-        /**
-         * If the input (or group/form/list) is passing all validation rules. In
-         * the case of groups, forms, and lists this includes the validation state
-         * of all its children.
-         */
-        valid: boolean;
-        /**
-         * If the validation-visibility has been satisfied and any validation
-         * messages should be displayed.
-         */
-        validationVisible: boolean;
-    };
+    state: FormKitFrameworkContextState;
     /**
@@ -496,2 +448,69 @@ * The type of input "text" or "select" (retrieved from node.props.type). This
 /**
+ * The state inside a node’s framework context. Usually used to track things
+ * like blurred, and validity states.
+ * @public
+ */
+export declare interface FormKitFrameworkContextState {
+    /**
+     * If the input has been blurred.
+     */
+    blurred: boolean;
+    /**
+     * True when these conditions are met:
+     *
+     * Either:
+     * - The input has validation rules
+     * - The validation rules are all passing
+     * - There are no errors on the input
+     * Or:
+     * - The input has no validation rules
+     * - The input has no errors
+     * - The input is dirty and has a value
+     *
+     * This is not intended to be used on forms/groups/lists but instead on
+     * individual inputs. Imagine placing a green checkbox next to each input
+     * when the user filled it out correctly — thats what these are for.
+     */
+    complete: boolean;
+    /**
+     * If the input has had a value typed into it or a change made to it.
+     */
+    dirty: boolean;
+    /**
+     * If the input has explicit errors placed on it, or in the case of a group,
+     * list, or form, this is true if any children have errors on them.
+     */
+    errors: boolean;
+    /**
+     * True when the input has validation rules. Has nothing to do with the
+     * state of those validation rules.
+     */
+    rules: boolean;
+    /**
+     * True when the input has completed its internal debounce cycle and the
+     * value was committed to the form.
+     */
+    settled: boolean;
+    /**
+     * If the form has been submitted.
+     */
+    submitted: boolean;
+    /**
+     * If the input (or group/form/list) is passing all validation rules. In
+     * the case of groups, forms, and lists this includes the validation state
+     * of all its children.
+     */
+    valid: boolean;
+    /**
+     * If the validation-visibility has been satisfied and any validation
+     * messages should be displayed.
+     */
+    validationVisible: boolean;
+    /**
+     * Allow users to add their own arbitrary states.
+     */
+    [index: string]: boolean;
+}
+
+/**
  * FormKit inputs of type 'group' must have keyed values by default.
@@ -676,2 +695,7 @@ * @public
     /**
+     * Adds props to the given node by removing them from node.props.attrs and
+     * moving them to the top-level node.props object.
+     */
+    addProps: (props: string[]) => FormKitNode;
+    /**
      * Gets a node at another address. Addresses are dot-syntax paths (or arrays)
@@ -697,4 +721,8 @@ * of node names. For example: form.users.0.first_name There are a few
      */
-    calm: (childValue?: FormKitChildValue) => void;
+    calm: (childValue?: FormKitChildValue) => FormKitNode;
     /**
+     * Clears the errors of the node, and optionally all the children.
+     */
+    clearErrors: (clearChildren?: boolean) => FormKitNode;
+    /**
      * An object that is shared tree-wide with various configuration options that
@@ -701,0 +729,0 @@ * should be applied to the entire tree.

package.json

 {
   "name": "@formkit/core",
-  "version": "1.0.0-beta.7-ebffb4b",
+  "version": "1.0.0-beta.7-eeea122",
   "type": "module",
@@ -36,5 +36,5 @@ "description": "The framework agnostic core of FormKit",
   "dependencies": {
-    "@formkit/utils": "1.0.0-beta.7-ebffb4b"
+    "@formkit/utils": "1.0.0-beta.7-eeea122"
   },
   "devDependencies": {}
 }

No alert changes

Improved metrics

Total package byte prevSize

213280

increased by2.04%

Lines of code

6355

increased by2.4%

Dependency changes

• + Added@formkit/utils@1.0.0-beta.7-eeea122(transitive)

• - Removed@formkit/utils@1.0.0-beta.7-ebffb4b(transitive)

• Updated@formkit/utils@1.0.0-beta.7-eeea122