From 7b9aabb1d9c479f1733872e2c57bd2138d179ab3 Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Thu, 29 Aug 2024 05:26:35 -0500 Subject: [PATCH] docs update --- src/Field.tsx | 10 +++++----- src/types.ts | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/Field.tsx b/src/Field.tsx index 1ea488c..cb28464 100644 --- a/src/Field.tsx +++ b/src/Field.tsx @@ -184,11 +184,11 @@ export type FieldProps< }; /** - * The `` component is the main building-block of forms in - * Formularity. It drastically reduces the amount of boilerplate code - * needed to manage the state of a form field by taking care of many basic - * actions such as handling change, blur, and showing errors. **Must be used - * underneath a `` component.** + * The `` component is the main component for hooking up inputs and + * sections of forms in Formularity. It drastically reduces the amount of + * boilerplate code needed to manage the state of a form field by taking care of + * many basic actions such as handling change, blur, and showing errors. **Must + * be used underneath a `` component.** */ export const Field = < TFormValues extends FormValues diff --git a/src/types.ts b/src/types.ts index 6645139..b20e062 100644 --- a/src/types.ts +++ b/src/types.ts @@ -336,11 +336,11 @@ FormStoreState ////// COMPONENTS ////// export type FormularityComponents = { /** - * The `` component is the main building-block of forms in - * Formularity. It drastically reduces the amount of boilerplate code - * needed to manage the state of a form field by taking care of many basic - * actions such as handling change, blur, and showing errors. **Must be used - * underneath a `` component.** + * The `` component is the main component for hooking up inputs and + * sections of forms in Formularity. It drastically reduces the amount of + * boilerplate code needed to manage the state of a form field by taking care of + * many basic actions such as handling change, blur, and showing errors. **Must + * be used underneath a `` component.** */ Field: FieldComponent; /**