Merge pull request #295 from wellyshen/feature/change-touched-fields-…

…to-touched Feat(useForm): rename the option of "setValues" from "touchedFields" to "touched"
wellyshen · Jan 2, 2021 · 92289f1 · 92289f1
2 parents eaadadd + 971180d
commit 92289f1
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 9 deletions.
diff --git a/.changeset/smart-lions-sip.md b/.changeset/smart-lions-sip.md
@@ -0,0 +1,5 @@
+---
+"react-cool-form": patch
+---
+
+Feat(useForm): rename the option of `setValues` from `touchedFields` to `touched`
diff --git a/docs/api-reference/use-form.md b/docs/api-reference/use-form.md
@@ -217,8 +217,8 @@ setValues(
  { firstName: "Welly", lastName: "Shen" }, // It will replace the entire values object
  {
  shouldValidate: true, // (Default = "validateOnChange" option) Triggers form validation
- touchedFields: ["firstName"], // Sets fields as touched by passing their names
- // touchedFields: (allFieldNames) => allFieldNames, // A reverse way to set touched fields
+ touched: ["firstName"], // Sets fields as touched by passing their names
+ // touched: (allFieldNames) => allFieldNames, // A reverse way to set touched fields
  dirtyFields: ["firstName"], // Sets fields as dirty by passing their names
  // dirtyFields: (allFieldNames) => allFieldNames, // A reverse way to set dirty fields
  }

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -158,7 +158,7 @@ export interface SetValues<V> {
  values: ValuesArg<V>,
  options?: {
  shouldValidate?: boolean;
- touchedFields?: string[] | FieldNamesFn;
+ touched?: string[] | FieldNamesFn;
  dirtyFields?: string[] | FieldNamesFn;
  }
  ): void;

diff --git a/src/types/react-cool-form.d.ts b/src/types/react-cool-form.d.ts
@@ -33,7 +33,7 @@ declare module "react-cool-form" {
  values: V | PreviousValuesFn<V>,
  options?: {
  shouldValidate?: boolean;
- touchedFields?: string[] | FieldNamesFn;
+ touched?: string[] | FieldNamesFn;
  dirtyFields?: string[] | FieldNamesFn;
  }
  ): void;

diff --git a/src/useForm.ts b/src/useForm.ts
@@ -581,7 +581,7 @@ export default <V extends FormValues = FormValues>({
  values,
  {
  shouldValidate = validateOnChange,
- touchedFields = [],
+ touched = [],
  dirtyFields = [],
  } = {}
  ) => {
@@ -590,14 +590,14 @@ export default <V extends FormValues = FormValues>({
  setStateRef("values", values);
  setNodesOrStateValue(values);
 
- if (touchedFields.length)
+ if (touched.length)
  setStateRef(
  "touched",
  setTrueValues(
  stateRef.current.touched,
- isFunction(touchedFields)
- ? touchedFields(getFieldNames())
- : touchedFields
+ isFunction(touched)
+ ? touched(getFieldNames())
+ : touched
  )
  );
  if (dirtyFields.length)