├── .editorconfig ├── .github ├── actions │ └── yarn-install-wcache │ │ └── action.yml └── workflows │ └── release.yml ├── .gitignore ├── .nvmrc ├── .prettierrc ├── .releaseRules.js ├── .yarn └── releases │ └── yarn-3.2.3.cjs ├── .yarnrc.yml ├── CHANGELOG.md ├── LICENSE.md ├── README.md ├── changelog-preset.config.js ├── lerna.json ├── nx.json ├── package.json ├── packages ├── documentation │ ├── .gitignore │ ├── CHANGELOG.md │ ├── README.md │ ├── babel.config.js │ ├── blog │ │ ├── 2019-05-28-first-blog-post.md │ │ ├── 2019-05-29-long-blog-post.md │ │ ├── 2021-08-01-mdx-blog-post.mdx │ │ ├── 2021-08-26-welcome │ │ │ ├── docusaurus-plushie-banner.jpeg │ │ │ └── index.md │ │ └── authors.yml │ ├── docs │ │ ├── api │ │ │ ├── _category_.json │ │ │ ├── array-field.mdx │ │ │ ├── dependent-field.mdx │ │ │ ├── field.mdx │ │ │ ├── form.mdx │ │ │ └── generated │ │ │ │ ├── _category_.yml │ │ │ │ ├── classes │ │ │ │ ├── _category_.yml │ │ │ │ ├── react_formz_src_models_Cache.Cache.md │ │ │ │ └── react_formz_src_models_SchemaValidator.SchemaValidator.md │ │ │ │ ├── index.md │ │ │ │ ├── interfaces │ │ │ │ ├── _category_.yml │ │ │ │ ├── react_formz_native_src_components_ArrayField_ArrayField_types.ArrayFieldComponentProps.md │ │ │ │ ├── react_formz_native_src_components_ArrayField_ArrayField_types.ArrayFieldProps.md │ │ │ │ ├── react_formz_native_src_components_DependentField_DependentField_types.DependentFieldProps.md │ │ │ │ ├── react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageBaseProps.md │ │ │ │ ├── react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageComponentProps.md │ │ │ │ ├── react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md │ │ │ │ ├── react_formz_native_src_components_Field_Field_types.FieldComponentProps.md │ │ │ │ ├── react_formz_native_src_components_Field_Field_types.FieldInputProps.md │ │ │ │ ├── react_formz_native_src_components_Field_Field_types.NativeFieldProps.md │ │ │ │ ├── react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md │ │ │ │ ├── react_formz_native_src_components_Form_Form_types.FormProps.md │ │ │ │ ├── react_formz_native_src_components_Form_Form_types.NativeFormProps.md │ │ │ │ ├── react_formz_native_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md │ │ │ │ ├── react_formz_native_src_hooks_fields_useField.UseNativeFieldOptions.md │ │ │ │ ├── react_formz_native_src_providers_FormSubmitProvider_FormSubmitProvider.FormSubmitProviderProps.md │ │ │ │ ├── react_formz_src_hooks_fields_useDependentField.UseDependentFieldOptions.md │ │ │ │ ├── react_formz_src_hooks_fields_useDependentFieldEvents.UseDependentFieldEventsOptions.md │ │ │ │ ├── react_formz_src_hooks_fields_useField.UseFieldOptions.md │ │ │ │ ├── react_formz_src_hooks_fields_useField.UseFieldResult.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldActions.FieldActions.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldArrayHelpers.ArrayHelpers.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldEvents.FieldEvents.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldValidation.UseFieldValidationOptions.md │ │ │ │ ├── react_formz_src_hooks_forms_useForm.UseFormOptions.md │ │ │ │ ├── react_formz_src_hooks_forms_useForm.UseFormResult.md │ │ │ │ ├── react_formz_src_models_SchemaValidator.SchemaValidatorErrorResult.md │ │ │ │ ├── react_formz_src_models_SchemaValidator.SchemaValidatorSuccessResult.md │ │ │ │ ├── react_formz_src_models_SchemaValidator.SchemaValidatorValidate.md │ │ │ │ ├── react_formz_src_providers_FormDateProvider_FormDateProvider_types.FormDateProviderProps.md │ │ │ │ ├── react_formz_src_store_store_types.FormzFieldsStore.md │ │ │ │ ├── react_formz_src_store_store_types.FormzSchemaValidatorStore.md │ │ │ │ ├── react_formz_src_store_store_types.FormzStore.md │ │ │ │ ├── react_formz_src_store_store_types.RegisterFieldPayload.md │ │ │ │ ├── react_formz_src_types_events.FormzChangeEvent.md │ │ │ │ ├── react_formz_src_types_events.FormzChangeEventHandler.md │ │ │ │ ├── react_formz_src_types_field.FieldProps.md │ │ │ │ ├── react_formz_src_types_form.FormProps.md │ │ │ │ ├── react_formz_src_types_input.HTMLCheckboxInputElement.md │ │ │ │ ├── react_formz_src_types_input.HTMLDateInputElement.md │ │ │ │ ├── react_formz_src_types_input.HTMLNumberInputElement.md │ │ │ │ ├── react_formz_src_types_input.HTMLSpecificInputElement.md │ │ │ │ ├── react_formz_web_src_components_ArrayField_ArrayField_types.ArrayFieldComponentProps.md │ │ │ │ ├── react_formz_web_src_components_ArrayField_ArrayField_types.ArrayFieldProps.md │ │ │ │ ├── react_formz_web_src_components_ArrayField_ArrayField_types.BaseArrayFieldProps.md │ │ │ │ ├── react_formz_web_src_components_DependentField_DependentField_types.DependentFieldProps.md │ │ │ │ ├── react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageBaseProps.md │ │ │ │ ├── react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageComponentProps.md │ │ │ │ ├── react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md │ │ │ │ ├── react_formz_web_src_components_Field_Field_types.FieldComponentProps.md │ │ │ │ ├── react_formz_web_src_components_Field_Field_types.FieldInputProps.md │ │ │ │ ├── react_formz_web_src_components_Field_Field_types.WebFieldProps.md │ │ │ │ ├── react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md │ │ │ │ ├── react_formz_web_src_components_Form_Form_types.FormChildrenProps.md │ │ │ │ ├── react_formz_web_src_components_Form_Form_types.FormProps.md │ │ │ │ ├── react_formz_web_src_components_Form_Form_types.WebFormProps.md │ │ │ │ ├── react_formz_web_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md │ │ │ │ └── react_formz_web_src_hooks_fields_useField.UseWebFieldOptions.md │ │ │ │ ├── modules.md │ │ │ │ └── modules │ │ │ │ ├── _category_.yml │ │ │ │ ├── react_formz.md │ │ │ │ ├── react_formz_native_src.md │ │ │ │ ├── react_formz_native_src_components_ArrayField.md │ │ │ │ ├── react_formz_native_src_components_ArrayField_ArrayField.md │ │ │ │ ├── react_formz_native_src_components_ArrayField_ArrayField_types.md │ │ │ │ ├── react_formz_native_src_components_CustomField.md │ │ │ │ ├── react_formz_native_src_components_CustomField_CustomField.md │ │ │ │ ├── react_formz_native_src_components_DependentField.md │ │ │ │ ├── react_formz_native_src_components_DependentField_DependentField.md │ │ │ │ ├── react_formz_native_src_components_DependentField_DependentField_extras.md │ │ │ │ ├── react_formz_native_src_components_DependentField_DependentField_types.md │ │ │ │ ├── react_formz_native_src_components_ErrorMessage.md │ │ │ │ ├── react_formz_native_src_components_ErrorMessage_ErrorMessage.md │ │ │ │ ├── react_formz_native_src_components_ErrorMessage_ErrorMessage_types.md │ │ │ │ ├── react_formz_native_src_components_Field.md │ │ │ │ ├── react_formz_native_src_components_Field_Field.md │ │ │ │ ├── react_formz_native_src_components_Field_Field_extras.md │ │ │ │ ├── react_formz_native_src_components_Field_Field_types.md │ │ │ │ ├── react_formz_native_src_components_Form.md │ │ │ │ ├── react_formz_native_src_components_FormLastPersistedAt.md │ │ │ │ ├── react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt.md │ │ │ │ ├── react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt_types.md │ │ │ │ ├── react_formz_native_src_components_Form_Form.md │ │ │ │ ├── react_formz_native_src_components_Form_Form_types.md │ │ │ │ ├── react_formz_native_src_components_SubmitButton.md │ │ │ │ ├── react_formz_native_src_components_SubmitButton_SubmitButton.md │ │ │ │ ├── react_formz_native_src_components_SubmitButton_SubmitButton_types.md │ │ │ │ ├── react_formz_native_src_hooks_fields_useField.md │ │ │ │ ├── react_formz_native_src_hooks_fields_useInternalFieldValue.md │ │ │ │ ├── react_formz_native_src_providers_ArrayFieldProvider.md │ │ │ │ ├── react_formz_native_src_providers_ArrayFieldProvider_ArrayFieldProvider.md │ │ │ │ ├── react_formz_native_src_providers_FormSubmitProvider.md │ │ │ │ ├── react_formz_native_src_providers_FormSubmitProvider_FormSubmitProvider.md │ │ │ │ ├── react_formz_src.md │ │ │ │ ├── react_formz_src_constants.md │ │ │ │ ├── react_formz_src_hooks_fields_useDependentField.md │ │ │ │ ├── react_formz_src_hooks_fields_useDependentFieldEvents.md │ │ │ │ ├── react_formz_src_hooks_fields_useErrorMessage.md │ │ │ │ ├── react_formz_src_hooks_fields_useField.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldActions.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldArrayHelpers.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldEvents.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldRegistration.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldTouched.md │ │ │ │ ├── react_formz_src_hooks_fields_useFieldValidation.md │ │ │ │ ├── react_formz_src_hooks_forms_useExecuteFieldValidations.md │ │ │ │ ├── react_formz_src_hooks_forms_useForm.md │ │ │ │ ├── react_formz_src_hooks_forms_useFormHydration.md │ │ │ │ ├── react_formz_src_hooks_forms_useFormId.md │ │ │ │ ├── react_formz_src_hooks_forms_useFormLastPersistedAt.md │ │ │ │ ├── react_formz_src_hooks_forms_useFormStateInitialized.md │ │ │ │ ├── react_formz_src_hooks_forms_useFormSubmission.md │ │ │ │ ├── react_formz_src_hooks_forms_useRegisterFormSchema.md │ │ │ │ ├── react_formz_src_hooks_forms_useValidateFormSchema.md │ │ │ │ ├── react_formz_src_hooks_utils_useComponentDidMount.md │ │ │ │ ├── react_formz_src_hooks_utils_useIsomorphicLayoutEffect.md │ │ │ │ ├── react_formz_src_hooks_utils_useSelector.md │ │ │ │ ├── react_formz_src_hooks_utils_useStableCallback.md │ │ │ │ ├── react_formz_src_hooks_utils_useStableValue.md │ │ │ │ ├── react_formz_src_logger.md │ │ │ │ ├── react_formz_src_logger_logger.md │ │ │ │ ├── react_formz_src_models_Cache.md │ │ │ │ ├── react_formz_src_models_SchemaValidator.md │ │ │ │ ├── react_formz_src_providers_FormDateProvider.md │ │ │ │ ├── react_formz_src_providers_FormDateProvider_FormDateProvider.md │ │ │ │ ├── react_formz_src_providers_FormDateProvider_FormDateProvider_types.md │ │ │ │ ├── react_formz_src_providers_FormIdProvider.md │ │ │ │ ├── react_formz_src_providers_FormIdProvider_FormIdProvider.md │ │ │ │ ├── react_formz_src_providers_FormProvider.md │ │ │ │ ├── react_formz_src_providers_FormProvider_FormProvider.md │ │ │ │ ├── react_formz_src_store.md │ │ │ │ ├── react_formz_src_store_actions.md │ │ │ │ ├── react_formz_src_store_actions_getFieldStoreValue.md │ │ │ │ ├── react_formz_src_store_actions_getFormState.md │ │ │ │ ├── react_formz_src_store_actions_incrementFormSubmitCount.md │ │ │ │ ├── react_formz_src_store_actions_resetFieldError.md │ │ │ │ ├── react_formz_src_store_actions_resetFormState.md │ │ │ │ ├── react_formz_src_store_actions_setFieldError.md │ │ │ │ ├── react_formz_src_store_actions_setFieldTouched.md │ │ │ │ ├── react_formz_src_store_actions_setFieldValue.md │ │ │ │ ├── react_formz_src_store_actions_setFormIsSubmitting.md │ │ │ │ ├── react_formz_src_store_actions_updateFormValue.md │ │ │ │ ├── react_formz_src_store_actions_updateIsInvalid.md │ │ │ │ ├── react_formz_src_store_hooks_useFieldValue.md │ │ │ │ ├── react_formz_src_store_hooks_useMemoizedSelector.md │ │ │ │ ├── react_formz_src_store_selectors_makeSelectFieldError.md │ │ │ │ ├── react_formz_src_store_selectors_makeSelectFieldTouched.md │ │ │ │ ├── react_formz_src_store_selectors_makeSelectFieldValue.md │ │ │ │ ├── react_formz_src_store_store.md │ │ │ │ ├── react_formz_src_store_store_types.md │ │ │ │ ├── react_formz_src_types_common.md │ │ │ │ ├── react_formz_src_types_events.md │ │ │ │ ├── react_formz_src_types_field.md │ │ │ │ ├── react_formz_src_types_form.md │ │ │ │ ├── react_formz_src_types_input.md │ │ │ │ ├── react_formz_src_types_keys.md │ │ │ │ ├── react_formz_src_types_utils.md │ │ │ │ ├── react_formz_src_types_validation.md │ │ │ │ ├── react_formz_src_utils_array.md │ │ │ │ ├── react_formz_src_utils_get.md │ │ │ │ ├── react_formz_src_utils_getFieldValue.md │ │ │ │ ├── react_formz_src_utils_getTag.md │ │ │ │ ├── react_formz_src_utils_is.md │ │ │ │ ├── react_formz_src_utils_set.md │ │ │ │ ├── react_formz_src_utils_stringToPath.md │ │ │ │ ├── react_formz_src_utils_toKey.md │ │ │ │ ├── react_formz_src_validations_doesNotMatchPattern.md │ │ │ │ ├── react_formz_src_validations_isAboveMax.md │ │ │ │ ├── react_formz_src_validations_isBelowMin.md │ │ │ │ ├── react_formz_web_src.md │ │ │ │ ├── react_formz_web_src_components_ArrayField.md │ │ │ │ ├── react_formz_web_src_components_ArrayField_ArrayField.md │ │ │ │ ├── react_formz_web_src_components_ArrayField_ArrayField_types.md │ │ │ │ ├── react_formz_web_src_components_CustomField.md │ │ │ │ ├── react_formz_web_src_components_CustomField_CustomField.md │ │ │ │ ├── react_formz_web_src_components_DependentField.md │ │ │ │ ├── react_formz_web_src_components_DependentField_DependentField.md │ │ │ │ ├── react_formz_web_src_components_DependentField_DependentField_extras.md │ │ │ │ ├── react_formz_web_src_components_DependentField_DependentField_types.md │ │ │ │ ├── react_formz_web_src_components_ErrorMessage.md │ │ │ │ ├── react_formz_web_src_components_ErrorMessage_ErrorMessage.md │ │ │ │ ├── react_formz_web_src_components_ErrorMessage_ErrorMessage_types.md │ │ │ │ ├── react_formz_web_src_components_Field.md │ │ │ │ ├── react_formz_web_src_components_Field_Field.md │ │ │ │ ├── react_formz_web_src_components_Field_Field_extras.md │ │ │ │ ├── react_formz_web_src_components_Field_Field_types.md │ │ │ │ ├── react_formz_web_src_components_Form.md │ │ │ │ ├── react_formz_web_src_components_FormLastPersistedAt.md │ │ │ │ ├── react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt.md │ │ │ │ ├── react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.md │ │ │ │ ├── react_formz_web_src_components_Form_Form.md │ │ │ │ ├── react_formz_web_src_components_Form_Form_types.md │ │ │ │ ├── react_formz_web_src_components_SubmitButton.md │ │ │ │ ├── react_formz_web_src_components_SubmitButton_SubmitButton.md │ │ │ │ ├── react_formz_web_src_components_SubmitButton_SubmitButton_types.md │ │ │ │ └── react_formz_web_src_hooks_fields_useField.md │ │ ├── components │ │ │ ├── _category_.json │ │ │ ├── array-field.md │ │ │ ├── error-message.mdx │ │ │ ├── field.mdx │ │ │ └── form.md │ │ ├── guides │ │ │ ├── _category_.json │ │ │ ├── basic-usage.md │ │ │ ├── conditional-field.md │ │ │ ├── dependent-field.md │ │ │ ├── field-validation.md │ │ │ ├── form-persistance.mdx │ │ │ └── form-validations.md │ │ ├── hooks │ │ │ ├── _category_.json │ │ │ └── use-field.mdx │ │ ├── integrations │ │ │ ├── react-datepicker.mdx │ │ │ └── react-select.mdx │ │ ├── intro.md │ │ ├── performance.md │ │ └── react-native │ │ │ ├── array-field.mdx │ │ │ └── basic-usage.mdx │ ├── docusaurus.config.js │ ├── package.json │ ├── project.json │ ├── sidebars.js │ ├── src │ │ ├── components │ │ │ ├── ExpoSnack │ │ │ │ ├── ExpoSnack.tsx │ │ │ │ └── index.ts │ │ │ └── HomepageFeatures │ │ │ │ ├── HomepageFeatures.tsx │ │ │ │ ├── index.tsx │ │ │ │ └── styles.module.css │ │ ├── css │ │ │ └── custom.css │ │ └── pages │ │ │ ├── Home │ │ │ ├── Home.tsx │ │ │ ├── index.ts │ │ │ └── styles.module.css │ │ │ └── index.tsx │ ├── static │ │ ├── .nojekyll │ │ └── img │ │ │ ├── docusaurus.png │ │ │ ├── favicon.ico │ │ │ ├── logo.png │ │ │ ├── logo.svg │ │ │ ├── preview.png │ │ │ ├── undraw_delivery_truck_vt6p.svg │ │ │ ├── undraw_docusaurus_mountain.svg │ │ │ ├── undraw_docusaurus_react.svg │ │ │ ├── undraw_docusaurus_tree.svg │ │ │ ├── undraw_start_building_re_xani.svg │ │ │ └── undraw_things_to_say_re_jpcg.svg │ ├── tsconfig.build.json │ └── tsconfig.json ├── react-formz-native │ ├── CHANGELOG.md │ ├── README.md │ ├── babel.config.js │ ├── index.ts │ ├── package.json │ ├── project.json │ ├── src │ │ ├── components │ │ │ ├── ArrayField │ │ │ │ ├── ArrayField.tsx │ │ │ │ ├── ArrayField.types.ts │ │ │ │ └── index.ts │ │ │ ├── CustomField │ │ │ │ ├── CustomField.tsx │ │ │ │ └── index.ts │ │ │ ├── DependentField │ │ │ │ ├── DependentField.extras.tsx │ │ │ │ ├── DependentField.tsx │ │ │ │ ├── DependentField.types.ts │ │ │ │ └── index.ts │ │ │ ├── ErrorMessage │ │ │ │ ├── ErrorMessage.tsx │ │ │ │ ├── ErrorMessage.types.ts │ │ │ │ └── index.ts │ │ │ ├── Field │ │ │ │ ├── Field.extras.tsx │ │ │ │ ├── Field.tsx │ │ │ │ ├── Field.types.ts │ │ │ │ └── index.ts │ │ │ ├── Form │ │ │ │ ├── Form.tsx │ │ │ │ ├── Form.types.ts │ │ │ │ └── index.ts │ │ │ ├── FormLastPersistedAt │ │ │ │ ├── FormLastPersistedAt.tsx │ │ │ │ ├── FormLastPersistedAt.types.ts │ │ │ │ └── index.ts │ │ │ └── SubmitButton │ │ │ │ ├── SubmitButton.tsx │ │ │ │ ├── SubmitButton.types.ts │ │ │ │ └── index.ts │ │ ├── hooks │ │ │ └── fields │ │ │ │ ├── useField.ts │ │ │ │ └── useInternalFieldValue.ts │ │ ├── index.ts │ │ └── providers │ │ │ ├── ArrayFieldProvider │ │ │ ├── ArrayFieldProvider.tsx │ │ │ └── index.ts │ │ │ └── FormSubmitProvider │ │ │ ├── FormSubmitProvider.tsx │ │ │ └── index.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── react-formz-storybook-native │ ├── .expo-shared │ │ └── assets.json │ ├── .gitignore │ ├── .ondevice │ │ ├── Storybook.tsx │ │ ├── main.js │ │ ├── preview.js │ │ └── storybook.requires.js │ ├── .storybook │ │ ├── main.js │ │ └── preview.js │ ├── App.tsx │ ├── App2.tsx │ ├── CHANGELOG.md │ ├── README.md │ ├── app.json │ ├── assets │ │ ├── adaptive-icon.png │ │ ├── favicon.png │ │ ├── icon.png │ │ └── splash.png │ ├── babel.config.js │ ├── index.js │ ├── metro.config.js │ ├── package.json │ ├── stories │ │ ├── ArrayField.stories.tsx │ │ └── Form.stories.tsx │ └── tsconfig.json ├── react-formz-storybook │ ├── .storybook │ │ ├── main.js │ │ ├── preview.css │ │ ├── preview.js │ │ └── wdyr.js │ ├── CHANGELOG.md │ ├── package.json │ ├── stories │ │ ├── Comparison.stories.tsx │ │ ├── DependentField.stories.tsx │ │ ├── Form.stories.tsx │ │ ├── LargeForm │ │ │ ├── LargeForm.ReactFormz.tsx │ │ │ ├── LargeForm.ReactHookForm.tsx │ │ │ ├── LargeForm.components.ReactFormHook.tsx │ │ │ ├── LargeForm.components.tsx │ │ │ └── LargeForm.stories.tsx │ │ ├── MaterialUI.stories.tsx │ │ ├── Performance.stories.tsx │ │ ├── ReactDatePicker.stories.tsx │ │ ├── ReactSelect.stories.tsx │ │ └── Validations.Zod.stories.tsx │ └── tsconfig.json ├── react-formz-validators-utils │ ├── CHANGELOG.md │ ├── package.json │ ├── project.json │ ├── src │ │ ├── index.ts │ │ └── toNestedErrors.ts │ ├── tsconfig.build.json │ ├── tsconfig.json │ ├── tsconfig.node.json │ └── vite.config.ts ├── react-formz-validators-yup │ ├── CHANGELOG.md │ ├── README.md │ ├── babel.config.js │ ├── jest.config.js │ ├── package.json │ ├── project.json │ ├── src │ │ ├── __tests__ │ │ │ └── yup.test.ts │ │ ├── index.ts │ │ └── yup.ts │ ├── tsconfig.build.json │ ├── tsconfig.json │ ├── tsconfig.node.json │ └── vite.config.ts ├── react-formz-validators-zod │ ├── CHANGELOG.md │ ├── README.md │ ├── babel.config.js │ ├── jest.config.js │ ├── package.json │ ├── project.json │ ├── src │ │ ├── __tests__ │ │ │ └── zod.test.ts │ │ ├── index.ts │ │ └── zod.ts │ ├── tsconfig.build.json │ ├── tsconfig.json │ ├── tsconfig.node.json │ └── vite.config.ts ├── react-formz-web │ ├── CHANGELOG.md │ ├── README.md │ ├── babel.config.js │ ├── configs │ │ └── jest │ │ │ └── setup.js │ ├── jest.config.js │ ├── package.json │ ├── project.json │ ├── src │ │ ├── components │ │ │ ├── ArrayField │ │ │ │ ├── ArrayField.tsx │ │ │ │ ├── ArrayField.types.ts │ │ │ │ ├── __tests__ │ │ │ │ │ └── ArrayField.test.tsx │ │ │ │ └── index.ts │ │ │ ├── CustomField │ │ │ │ ├── CustomField.tsx │ │ │ │ └── index.ts │ │ │ ├── DependentField │ │ │ │ ├── DependentField.extras.tsx │ │ │ │ ├── DependentField.tsx │ │ │ │ ├── DependentField.types.ts │ │ │ │ ├── __tests__ │ │ │ │ │ └── DependentField.test.tsx │ │ │ │ └── index.ts │ │ │ ├── ErrorMessage │ │ │ │ ├── ErrorMessage.tsx │ │ │ │ ├── ErrorMessage.types.ts │ │ │ │ └── index.ts │ │ │ ├── Field │ │ │ │ ├── Field.extras.tsx │ │ │ │ ├── Field.tsx │ │ │ │ ├── Field.types.ts │ │ │ │ ├── __tests__ │ │ │ │ │ └── Field.test.tsx │ │ │ │ └── index.ts │ │ │ ├── Form │ │ │ │ ├── Form.tsx │ │ │ │ ├── Form.types.ts │ │ │ │ └── index.ts │ │ │ ├── FormLastPersistedAt │ │ │ │ ├── FormLastPersistedAt.tsx │ │ │ │ ├── FormLastPersistedAt.types.ts │ │ │ │ └── index.ts │ │ │ └── SubmitButton │ │ │ │ ├── SubmitButton.tsx │ │ │ │ ├── SubmitButton.types.ts │ │ │ │ └── index.ts │ │ ├── hooks │ │ │ └── fields │ │ │ │ └── useField.ts │ │ ├── index.ts │ │ └── types.ts │ ├── testUtils │ │ ├── TestFieldComponent.tsx │ │ ├── constants.ts │ │ └── createDefaultFormzState.ts │ ├── tsconfig.build.json │ ├── tsconfig.json │ ├── tsconfig.node.json │ └── vite.config.ts └── react-formz │ ├── CHANGELOG.md │ ├── README.md │ ├── babel.config.js │ ├── configs │ └── jest │ │ └── setup.js │ ├── jest.config.js │ ├── package.json │ ├── project.json │ ├── src │ ├── constants.ts │ ├── hooks │ │ ├── fields │ │ │ ├── __tests__ │ │ │ │ ├── useDependentFieldEvents.test.ts │ │ │ │ ├── useErrorMessage.test.ts │ │ │ │ ├── useFieldEvents.test.ts │ │ │ │ ├── useFieldTouched.test.ts │ │ │ │ └── useFieldValidation.test.ts │ │ │ ├── useDependentField.ts │ │ │ ├── useDependentFieldEvents.ts │ │ │ ├── useErrorMessage.ts │ │ │ ├── useField.ts │ │ │ ├── useFieldActions.ts │ │ │ ├── useFieldArrayHelpers.ts │ │ │ ├── useFieldEvents.ts │ │ │ ├── useFieldRegistration.ts │ │ │ ├── useFieldTouched.ts │ │ │ └── useFieldValidation.ts │ │ ├── forms │ │ │ ├── __tests__ │ │ │ │ ├── useExecuteFieldValidations.test.ts │ │ │ │ ├── useFormHydration.test.ts │ │ │ │ └── useValidateFormSchema.test.ts │ │ │ ├── useExecuteFieldValidations.ts │ │ │ ├── useForm.ts │ │ │ ├── useFormEvents.ts │ │ │ ├── useFormHydration.ts │ │ │ ├── useFormId.ts │ │ │ ├── useFormLastPersistedAt.ts │ │ │ ├── useFormStateInitialized.ts │ │ │ ├── useFormSubmission.ts │ │ │ ├── useRegisterFormSchema.ts │ │ │ └── useValidateFormSchema.ts │ │ └── utils │ │ │ ├── __tests__ │ │ │ ├── useComponentDidMount.test.tsx │ │ │ ├── useLatest.test.ts │ │ │ ├── useSelector.test.ts │ │ │ ├── useStableCallback.test.tsx │ │ │ └── useStableValue.test.tsx │ │ │ ├── useComponentDidMount.ts │ │ │ ├── useIsomorphicLayoutEffect.ts │ │ │ ├── useLatest.ts │ │ │ ├── useSelector.ts │ │ │ ├── useStableCallback.ts │ │ │ └── useStableValue.ts │ ├── index.ts │ ├── logger │ │ ├── index.ts │ │ └── logger.ts │ ├── models │ │ ├── Cache.ts │ │ └── SchemaValidator.ts │ ├── providers │ │ ├── FormDateProvider │ │ │ ├── FormDateProvider.tsx │ │ │ ├── FormDateProvider.types.ts │ │ │ └── index.ts │ │ ├── FormIdProvider │ │ │ ├── FormIdProvider.tsx │ │ │ └── index.ts │ │ └── FormProvider │ │ │ ├── FormProvider.tsx │ │ │ └── index.ts │ ├── store │ │ ├── actions │ │ │ ├── __tests__ │ │ │ │ ├── getFieldStoreValue.test.ts │ │ │ │ ├── incrementFormSubmitCount.test.ts │ │ │ │ ├── resetFieldError.test.ts │ │ │ │ ├── setFieldError.test.ts │ │ │ │ └── setFieldTouched.test.ts │ │ │ ├── getFieldStoreValue.ts │ │ │ ├── getFormState.ts │ │ │ ├── incrementFormSubmitCount.ts │ │ │ ├── index.ts │ │ │ ├── resetFieldError.ts │ │ │ ├── resetFormState.ts │ │ │ ├── setFieldError.ts │ │ │ ├── setFieldTouched.ts │ │ │ ├── setFieldValue.ts │ │ │ ├── setFormIsSubmitting.ts │ │ │ ├── updateFormValue.ts │ │ │ └── updateIsInvalid.ts │ │ ├── hooks │ │ │ ├── useFieldValue.ts │ │ │ └── useMemoizedSelector.ts │ │ ├── index.ts │ │ ├── selectors │ │ │ ├── makeSelectFieldError.ts │ │ │ ├── makeSelectFieldTouched.ts │ │ │ └── makeSelectFieldValue.ts │ │ ├── store.ts │ │ └── store.types.ts │ ├── types │ │ ├── common.ts │ │ ├── events.ts │ │ ├── field.ts │ │ ├── form.ts │ │ ├── input.ts │ │ ├── keys.ts │ │ ├── path.ts │ │ ├── utils.ts │ │ └── validation.ts │ ├── utils │ │ ├── __tests__ │ │ │ ├── array.test.ts │ │ │ ├── get.test.ts │ │ │ ├── getField.test.ts │ │ │ ├── getTag.test.ts │ │ │ ├── set.test.ts │ │ │ └── stringToPath.test.ts │ │ ├── array.ts │ │ ├── date.ts │ │ ├── get.ts │ │ ├── getField.ts │ │ ├── getFieldValue.ts │ │ ├── getTag.ts │ │ ├── is.ts │ │ ├── set.ts │ │ ├── stringToPath.ts │ │ └── toKey.ts │ ├── validations │ │ ├── __tests__ │ │ │ ├── doesNotMatchPattern.test.ts │ │ │ ├── isAboveMax.test.ts │ │ │ └── isBelowMin.test.ts │ │ ├── doesNotMatchPattern.ts │ │ ├── isAboveMax.ts │ │ └── isBelowMin.ts │ └── vite-env.d.ts │ ├── testUtils │ ├── TestSchemaValidator.ts │ ├── constants.ts │ ├── createDefaultFormzState.ts │ ├── index.ts │ ├── mockLocalStorage.ts │ ├── renderHookInAct.ts │ ├── renderWithFormIdProvider.tsx │ └── waitMs.ts │ ├── tsconfig.build.json │ ├── tsconfig.json │ ├── tsconfig.node.json │ └── vite.config.ts ├── tsconfig.json ├── workspace └── project.json └── yarn.lock /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | insert_final_newline = true 6 | 7 | [*.{js,json,yml}] 8 | charset = utf-8 9 | indent_style = space 10 | indent_size = 2 11 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 16.17.0 -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "singleQuote": true, 3 | "trailingComma": "all", 4 | "printWidth": 100 5 | } 6 | -------------------------------------------------------------------------------- /.releaseRules.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | releaseRules: [ 3 | { tag: "Breaking", release: "major" }, 4 | { tag: "Update", release: "minor" }, 5 | { tag: "New", release: "minor" }, 6 | { tag: "Build", release: "minor" }, 7 | { tag: "Docs", release: "patch" }, 8 | { tag: "Fix", release: "patch" }, 9 | { tag: "Chore", release: false }, 10 | { tag: "Ignore", release: false }, 11 | ], 12 | }; 13 | -------------------------------------------------------------------------------- /.yarnrc.yml: -------------------------------------------------------------------------------- 1 | nodeLinker: node-modules 2 | yarnPath: .yarn/releases/yarn-3.2.3.cjs 3 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Public -------------------------------------------------------------------------------- /lerna.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "node_modules/lerna/schemas/lerna-schema.json", 3 | "useWorkspaces": true, 4 | "version": "1.10.0", 5 | "npmClient": "yarn", 6 | "gitTagVersion": true, 7 | "conventionalCommits": true, 8 | "changelogPreset": "./changelog-preset.config.js", 9 | "command": { 10 | "version": { 11 | "message": "release %s [skip ci]" 12 | }, 13 | "publish": {} 14 | }, 15 | "useNx": true, 16 | "loglevel": "debug", 17 | "packages": ["packages/*"], 18 | "private": false, 19 | "verbose": true 20 | } 21 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-formz", 3 | "packageManager": "yarn@3.2.3", 4 | "version": "1.2.0", 5 | "workspaces": [ 6 | "packages/*" 7 | ], 8 | "scripts": { 9 | "test": "yarn workspace @zerry/react-formz-core test && yarn workspace @zerry/react-formz test", 10 | "documentation:build": "yarn workspace @zerry/react-formz-documentation build", 11 | "documentation:start": "yarn workspace @zerry/react-formz-documentation start", 12 | "web:build": "yarn workspace @zerry/react-formz build", 13 | "web:publish": "cd packages/react-formz-web && npm publish --access public", 14 | "native:publish": "cd packages/react-formz-native && npm publish --access public", 15 | "native:build": "yarn workspace @zerry/react-formz-native build", 16 | "build": "nx run workspace:packages:build", 17 | "check-types": "nx run workspace:check-types" 18 | }, 19 | "devDependencies": { 20 | "@nrwl/jest": "^16.8.1", 21 | "@types/prettier": "^2.7.2", 22 | "conventional-changelog-conventionalcommits": "^5.0.0", 23 | "lerna": "^6.6.2", 24 | "prettier": "2.6.2" 25 | }, 26 | "dependencies": { 27 | "nx": "^16.8.1" 28 | }, 29 | "private": true 30 | } 31 | -------------------------------------------------------------------------------- /packages/documentation/.gitignore: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | /node_modules 3 | 4 | # Production 5 | /build 6 | 7 | # Generated files 8 | .docusaurus 9 | .cache-loader 10 | 11 | # Misc 12 | .DS_Store 13 | .env.local 14 | .env.development.local 15 | .env.test.local 16 | .env.production.local 17 | 18 | npm-debug.log* 19 | yarn-debug.log* 20 | yarn-error.log* 21 | -------------------------------------------------------------------------------- /packages/documentation/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | All notable changes to this project will be documented in this file. 4 | See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 5 | 6 | ## [1.2.0](https://github.com/ZerryStack/react-formz/compare/v0.3.0-beta...v1.2.0) (2023-09-17) 7 | 8 | 9 | ### Updates 10 | 11 | * ignore changes ([8c5ec06](https://github.com/ZerryStack/react-formz/commit/8c5ec06724415f3e760ee65c7ce829f0dc9006f9)) 12 | 13 | 14 | 15 | ## [1.1.0](https://github.com/ZerryStack/react-formz/compare/v0.3.0-beta...v1.1.0) (2023-09-17) 16 | 17 | **Note:** Version bump only for package @zerry/react-formz-documentation 18 | -------------------------------------------------------------------------------- /packages/documentation/README.md: -------------------------------------------------------------------------------- 1 | # Website 2 | 3 | This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. 4 | 5 | ### Installation 6 | 7 | ``` 8 | $ yarn 9 | ``` 10 | 11 | ### Local Development 12 | 13 | ``` 14 | $ yarn start 15 | ``` 16 | 17 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. 18 | 19 | ### Build 20 | 21 | ``` 22 | $ yarn build 23 | ``` 24 | 25 | This command generates static content into the `build` directory and can be served using any static contents hosting service. 26 | 27 | ### Deployment 28 | 29 | Using SSH: 30 | 31 | ``` 32 | $ USE_SSH=true yarn deploy 33 | ``` 34 | 35 | Not using SSH: 36 | 37 | ``` 38 | $ GIT_USER= yarn deploy 39 | ``` 40 | 41 | If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. 42 | -------------------------------------------------------------------------------- /packages/documentation/babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [require.resolve('@docusaurus/core/lib/babel/preset')], 3 | }; 4 | -------------------------------------------------------------------------------- /packages/documentation/blog/2019-05-28-first-blog-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: first-blog-post 3 | title: First Blog Post 4 | authors: 5 | name: Gao Wei 6 | title: Docusaurus Core Team 7 | url: https://github.com/wgao19 8 | image_url: https://github.com/wgao19.png 9 | tags: [hola, docusaurus] 10 | --- 11 | 12 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet 13 | -------------------------------------------------------------------------------- /packages/documentation/blog/2021-08-01-mdx-blog-post.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | slug: mdx-blog-post 3 | title: MDX Blog Post 4 | authors: [slorber] 5 | tags: [docusaurus] 6 | --- 7 | 8 | Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). 9 | 10 | :::tip 11 | 12 | Use the power of React to create interactive blog posts. 13 | 14 | ```js 15 | 16 | ``` 17 | 18 | 19 | 20 | ::: 21 | -------------------------------------------------------------------------------- /packages/documentation/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ZerryStack/react-formz/35990b08d1d604b2da779dd4802a908a183d3d9c/packages/documentation/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg -------------------------------------------------------------------------------- /packages/documentation/blog/2021-08-26-welcome/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: welcome 3 | title: Welcome 4 | authors: [slorber, yangshun] 5 | tags: [facebook, hello, docusaurus] 6 | --- 7 | 8 | [Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). 9 | 10 | Simply add Markdown files (or folders) to the `blog` directory. 11 | 12 | Regular blog authors can be added to `authors.yml`. 13 | 14 | The blog post date can be extracted from filenames, such as: 15 | 16 | - `2019-05-30-welcome.md` 17 | - `2019-05-30-welcome/index.md` 18 | 19 | A blog post folder can be convenient to co-locate blog post images: 20 | 21 | ![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) 22 | 23 | The blog supports tags as well! 24 | 25 | **And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. 26 | -------------------------------------------------------------------------------- /packages/documentation/blog/authors.yml: -------------------------------------------------------------------------------- 1 | endi: 2 | name: Endilie Yacop Sucipto 3 | title: Maintainer of Docusaurus 4 | url: https://github.com/endiliey 5 | image_url: https://github.com/endiliey.png 6 | 7 | yangshun: 8 | name: Yangshun Tay 9 | title: Front End Engineer @ Facebook 10 | url: https://github.com/yangshun 11 | image_url: https://github.com/yangshun.png 12 | 13 | slorber: 14 | name: Sébastien Lorber 15 | title: Docusaurus maintainer 16 | url: https://sebastienlorber.com 17 | image_url: https://github.com/slorber.png 18 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "API", 3 | "position": 5, 4 | "link": { 5 | "type": "generated-index", 6 | "description": "Component APIs." 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/array-field.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Array Field 6 | 7 | import ArrayField from "./generated/modules/react_formz_web_src_components_ArrayField_ArrayField.md"; 8 | 9 | 10 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/dependent-field.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Dependent Field 6 | 7 | import DependentField from "./generated/modules/react_formz_web_src_components_DependentField_DependentField.md"; 8 | 9 | 10 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/field.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Field 6 | 7 | import Field from "./generated/modules/react_formz_web_src_components_Field_Field.md"; 8 | 9 | 10 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/form.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | 5 | # Form 6 | 7 | import Form from "./generated/modules/react_formz_web_src_components_Form_Form.md"; 8 | 9 |
10 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/_category_.yml: -------------------------------------------------------------------------------- 1 | label: "API" -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/classes/_category_.yml: -------------------------------------------------------------------------------- 1 | label: "Classes" 2 | position: 3 -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/_category_.yml: -------------------------------------------------------------------------------- 1 | label: "Interfaces" 2 | position: 4 -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_native_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps" 3 | title: "Interface: SubmitButtonProps" 4 | sidebar_label: "SubmitButtonProps" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz-native/src/components/SubmitButton/SubmitButton.types](../modules/react_formz_native_src_components_SubmitButton_SubmitButton_types.md).SubmitButtonProps 9 | 10 | ## Hierarchy 11 | 12 | - `ButtonProps` 13 | 14 | ↳ **`SubmitButtonProps`** 15 | 16 | ## Properties 17 | 18 | ### as 19 | 20 | • `Optional` **as**: `ComponentType`<`Pick`<`ButtonProps`, ``"title"`` \| ``"onPress"``\>\> 21 | 22 | #### Defined in 23 | 24 | [packages/react-formz-native/src/components/SubmitButton/SubmitButton.types.ts:5](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-native/src/components/SubmitButton/SubmitButton.types.ts#L5) 25 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_models_SchemaValidator.SchemaValidatorErrorResult.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_models_SchemaValidator.SchemaValidatorErrorResult" 3 | title: "Interface: SchemaValidatorErrorResult" 4 | sidebar_label: "SchemaValidatorErrorResult" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/models/SchemaValidator](../modules/react_formz_src_models_SchemaValidator.md).SchemaValidatorErrorResult 9 | 10 | ## Type parameters 11 | 12 | | Name | Type | 13 | | :------ | :------ | 14 | | `Values` | extends [`FormzValues`](../modules/react_formz_src_types_form.md#formzvalues) | 15 | 16 | ## Properties 17 | 18 | ### errors 19 | 20 | • **errors**: [`FormzErrors`](../modules/react_formz_src_types_form.md#formzerrors)<`Values`\> 21 | 22 | #### Defined in 23 | 24 | [packages/react-formz/src/models/SchemaValidator.ts:8](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/models/SchemaValidator.ts#L8) 25 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_models_SchemaValidator.SchemaValidatorSuccessResult.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_models_SchemaValidator.SchemaValidatorSuccessResult" 3 | title: "Interface: SchemaValidatorSuccessResult" 4 | sidebar_label: "SchemaValidatorSuccessResult" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/models/SchemaValidator](../modules/react_formz_src_models_SchemaValidator.md).SchemaValidatorSuccessResult 9 | 10 | ## Properties 11 | 12 | ### errors 13 | 14 | • **errors**: `undefined` 15 | 16 | #### Defined in 17 | 18 | [packages/react-formz/src/models/SchemaValidator.ts:4](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/models/SchemaValidator.ts#L4) 19 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_providers_FormDateProvider_FormDateProvider_types.FormDateProviderProps.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_providers_FormDateProvider_FormDateProvider_types.FormDateProviderProps" 3 | title: "Interface: FormDateProviderProps" 4 | sidebar_label: "FormDateProviderProps" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/providers/FormDateProvider/FormDateProvider.types](../modules/react_formz_src_providers_FormDateProvider_FormDateProvider_types.md).FormDateProviderProps 9 | 10 | ## Properties 11 | 12 | ### formatter 13 | 14 | • **formatter**: (`date`: `string` \| `number` \| `Date`, `format`: `string`) => `string` 15 | 16 | #### Type declaration 17 | 18 | ▸ (`date`, `format`): `string` 19 | 20 | ##### Parameters 21 | 22 | | Name | Type | 23 | | :------ | :------ | 24 | | `date` | `string` \| `number` \| `Date` | 25 | | `format` | `string` | 26 | 27 | ##### Returns 28 | 29 | `string` 30 | 31 | #### Defined in 32 | 33 | [packages/react-formz/src/providers/FormDateProvider/FormDateProvider.types.ts:2](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/providers/FormDateProvider/FormDateProvider.types.ts#L2) 34 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_types_events.FormzChangeEvent.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_events.FormzChangeEvent" 3 | title: "Interface: FormzChangeEvent" 4 | sidebar_label: "FormzChangeEvent" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/types/events](../modules/react_formz_src_types_events.md).FormzChangeEvent 9 | 10 | For easy compatability with third party UI libraries we limit the required properties 11 | for the `ChangeEvent` to just the one we need which is `target`. Most libraries include 12 | at least target but not all include the entire react change event. 13 | 14 | ## Type parameters 15 | 16 | | Name | Type | 17 | | :------ | :------ | 18 | | `T` | `Element` | 19 | 20 | ## Hierarchy 21 | 22 | - `Pick`<`React.ChangeEvent`<`T`\>, ``"target"``\> 23 | 24 | ↳ **`FormzChangeEvent`** 25 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_types_input.HTMLCheckboxInputElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_input.HTMLCheckboxInputElement" 3 | title: "Interface: HTMLCheckboxInputElement" 4 | sidebar_label: "HTMLCheckboxInputElement" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/types/input](../modules/react_formz_src_types_input.md).HTMLCheckboxInputElement 9 | 10 | ## Hierarchy 11 | 12 | - [`HTMLSpecificInputElement`](react_formz_src_types_input.HTMLSpecificInputElement.md)<``"checkbox"``\> 13 | 14 | ↳ **`HTMLCheckboxInputElement`** 15 | 16 | ## Properties 17 | 18 | ### type 19 | 20 | • **type**: ``"checkbox"`` 21 | 22 | #### Inherited from 23 | 24 | [HTMLSpecificInputElement](react_formz_src_types_input.HTMLSpecificInputElement.md).[type](react_formz_src_types_input.HTMLSpecificInputElement.md#type) 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/types/input.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/types/input.ts#L3) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_types_input.HTMLDateInputElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_input.HTMLDateInputElement" 3 | title: "Interface: HTMLDateInputElement" 4 | sidebar_label: "HTMLDateInputElement" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/types/input](../modules/react_formz_src_types_input.md).HTMLDateInputElement 9 | 10 | ## Hierarchy 11 | 12 | - [`HTMLSpecificInputElement`](react_formz_src_types_input.HTMLSpecificInputElement.md)<``"date"``\> 13 | 14 | ↳ **`HTMLDateInputElement`** 15 | 16 | ## Properties 17 | 18 | ### type 19 | 20 | • **type**: ``"date"`` 21 | 22 | #### Inherited from 23 | 24 | [HTMLSpecificInputElement](react_formz_src_types_input.HTMLSpecificInputElement.md).[type](react_formz_src_types_input.HTMLSpecificInputElement.md#type) 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/types/input.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/types/input.ts#L3) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_types_input.HTMLNumberInputElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_input.HTMLNumberInputElement" 3 | title: "Interface: HTMLNumberInputElement" 4 | sidebar_label: "HTMLNumberInputElement" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/types/input](../modules/react_formz_src_types_input.md).HTMLNumberInputElement 9 | 10 | ## Hierarchy 11 | 12 | - [`HTMLSpecificInputElement`](react_formz_src_types_input.HTMLSpecificInputElement.md)<``"number"``\> 13 | 14 | ↳ **`HTMLNumberInputElement`** 15 | 16 | ## Properties 17 | 18 | ### type 19 | 20 | • **type**: ``"number"`` 21 | 22 | #### Inherited from 23 | 24 | [HTMLSpecificInputElement](react_formz_src_types_input.HTMLSpecificInputElement.md).[type](react_formz_src_types_input.HTMLSpecificInputElement.md#type) 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/types/input.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/types/input.ts#L3) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_src_types_input.HTMLSpecificInputElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_input.HTMLSpecificInputElement" 3 | title: "Interface: HTMLSpecificInputElement" 4 | sidebar_label: "HTMLSpecificInputElement" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz/src/types/input](../modules/react_formz_src_types_input.md).HTMLSpecificInputElement 9 | 10 | ## Type parameters 11 | 12 | | Name | Type | 13 | | :------ | :------ | 14 | | `T` | extends `string` | 15 | 16 | ## Hierarchy 17 | 18 | - `Omit`<`HTMLInputElement`, ``"type"``\> 19 | 20 | ↳ **`HTMLSpecificInputElement`** 21 | 22 | ↳↳ [`HTMLNumberInputElement`](react_formz_src_types_input.HTMLNumberInputElement.md) 23 | 24 | ↳↳ [`HTMLCheckboxInputElement`](react_formz_src_types_input.HTMLCheckboxInputElement.md) 25 | 26 | ↳↳ [`HTMLDateInputElement`](react_formz_src_types_input.HTMLDateInputElement.md) 27 | 28 | ## Properties 29 | 30 | ### type 31 | 32 | • **type**: `T` 33 | 34 | #### Defined in 35 | 36 | [packages/react-formz/src/types/input.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/types/input.ts#L3) 37 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps" 3 | title: "Interface: FormLastPersistedAtProps" 4 | sidebar_label: "FormLastPersistedAtProps" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.types](../modules/react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.md).FormLastPersistedAtProps 9 | 10 | ## Hierarchy 11 | 12 | - `HtmlSpanProps` 13 | 14 | ↳ **`FormLastPersistedAtProps`** 15 | 16 | ## Properties 17 | 18 | ### format 19 | 20 | • `Optional` **format**: `string` \| (`date`: `Date`) => `string` 21 | 22 | #### Defined in 23 | 24 | [packages/react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.types.ts:4](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.types.ts#L4) 25 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/interfaces/react_formz_web_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps" 3 | title: "Interface: SubmitButtonProps" 4 | sidebar_label: "SubmitButtonProps" 5 | custom_edit_url: null 6 | --- 7 | 8 | [react-formz-web/src/components/SubmitButton/SubmitButton.types](../modules/react_formz_web_src_components_SubmitButton_SubmitButton_types.md).SubmitButtonProps 9 | 10 | ## Hierarchy 11 | 12 | - `HtmlButtonProps` 13 | 14 | ↳ **`SubmitButtonProps`** 15 | 16 | ## Properties 17 | 18 | ### as 19 | 20 | • `Optional` **as**: ``"button"`` \| (`props`: `HtmlButtonProps`) => `Element` 21 | 22 | #### Defined in 23 | 24 | [packages/react-formz-web/src/components/SubmitButton/SubmitButton.types.ts:4](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-web/src/components/SubmitButton/SubmitButton.types.ts#L4) 25 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/_category_.yml: -------------------------------------------------------------------------------- 1 | label: "Modules" 2 | position: 1 -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_ArrayField.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_ArrayField" 3 | title: "Module: react-formz-native/src/components/ArrayField" 4 | sidebar_label: "react-formz-native/src/components/ArrayField" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### ArrayFieldComponentProps 12 | 13 | Re-exports [ArrayFieldComponentProps](../interfaces/react_formz_native_src_components_ArrayField_ArrayField_types.ArrayFieldComponentProps.md) 14 | 15 | ___ 16 | 17 | ### ArrayFieldProps 18 | 19 | Re-exports [ArrayFieldProps](../interfaces/react_formz_native_src_components_ArrayField_ArrayField_types.ArrayFieldProps.md) 20 | 21 | ___ 22 | 23 | ### default 24 | 25 | Renames and re-exports [ArrayField](react_formz_native_src_components_ArrayField_ArrayField.md#arrayfield) 26 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_ArrayField_ArrayField.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_ArrayField_ArrayField" 3 | title: "Module: react-formz-native/src/components/ArrayField/ArrayField" 4 | sidebar_label: "react-formz-native/src/components/ArrayField/ArrayField" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### ArrayField 12 | 13 | ▸ **ArrayField**<`Value`, `Key`\>(`props`): `Element` 14 | 15 | #### Type parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `Value` | `Value` | 20 | | `Key` | extends `string` = `string` | 21 | 22 | #### Parameters 23 | 24 | | Name | Type | 25 | | :------ | :------ | 26 | | `props` | [`ArrayFieldProps`](../interfaces/react_formz_native_src_components_ArrayField_ArrayField_types.ArrayFieldProps.md)<`Value`, `Key`\> | 27 | 28 | #### Returns 29 | 30 | `Element` 31 | 32 | #### Defined in 33 | 34 | [packages/react-formz-native/src/components/ArrayField/ArrayField.tsx:7](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-native/src/components/ArrayField/ArrayField.tsx#L7) 35 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_CustomField.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_CustomField" 3 | title: "Module: react-formz-native/src/components/CustomField" 4 | sidebar_label: "react-formz-native/src/components/CustomField" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [CustomField](react_formz_native_src_components_CustomField_CustomField.md#customfield) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_DependentField_DependentField_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_DependentField_DependentField_types" 3 | title: "Module: react-formz-native/src/components/DependentField/DependentField.types" 4 | sidebar_label: "react-formz-native/src/components/DependentField/DependentField.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [DependentFieldProps](../interfaces/react_formz_native_src_components_DependentField_DependentField_types.DependentFieldProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_ErrorMessage.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_ErrorMessage" 3 | title: "Module: react-formz-native/src/components/ErrorMessage" 4 | sidebar_label: "react-formz-native/src/components/ErrorMessage" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### ErrorMessageProps 12 | 13 | Re-exports [ErrorMessageProps](../interfaces/react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md) 14 | 15 | ___ 16 | 17 | ### default 18 | 19 | Renames and re-exports [ErrorMessage](react_formz_native_src_components_ErrorMessage_ErrorMessage.md#errormessage) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_ErrorMessage_ErrorMessage.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_ErrorMessage_ErrorMessage" 3 | title: "Module: react-formz-native/src/components/ErrorMessage/ErrorMessage" 4 | sidebar_label: "react-formz-native/src/components/ErrorMessage/ErrorMessage" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### ErrorMessage 12 | 13 | ▸ **ErrorMessage**(`__namedParameters`): ``null`` \| `Element` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `__namedParameters` | [`ErrorMessageProps`](../interfaces/react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md) | 20 | 21 | #### Returns 22 | 23 | ``null`` \| `Element` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz-native/src/components/ErrorMessage/ErrorMessage.tsx:6](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-native/src/components/ErrorMessage/ErrorMessage.tsx#L6) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_ErrorMessage_ErrorMessage_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_ErrorMessage_ErrorMessage_types" 3 | title: "Module: react-formz-native/src/components/ErrorMessage/ErrorMessage.types" 4 | sidebar_label: "react-formz-native/src/components/ErrorMessage/ErrorMessage.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [ErrorMessageBaseProps](../interfaces/react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageBaseProps.md) 11 | - [ErrorMessageComponentProps](../interfaces/react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageComponentProps.md) 12 | - [ErrorMessageProps](../interfaces/react_formz_native_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md) 13 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_Field_Field_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_Field_Field_types" 3 | title: "Module: react-formz-native/src/components/Field/Field.types" 4 | sidebar_label: "react-formz-native/src/components/Field/Field.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FieldComponentProps](../interfaces/react_formz_native_src_components_Field_Field_types.FieldComponentProps.md) 11 | - [FieldInputProps](../interfaces/react_formz_native_src_components_Field_Field_types.FieldInputProps.md) 12 | - [NativeFieldProps](../interfaces/react_formz_native_src_components_Field_Field_types.NativeFieldProps.md) 13 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_Form.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_Form" 3 | title: "Module: react-formz-native/src/components/Form" 4 | sidebar_label: "react-formz-native/src/components/Form" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### NativeFormProps 12 | 13 | Re-exports [NativeFormProps](../interfaces/react_formz_native_src_components_Form_Form_types.NativeFormProps.md) 14 | 15 | ___ 16 | 17 | ### PersistedForm 18 | 19 | Renames and re-exports [ReactNativePersistedForm](react_formz_native_src_components_Form_Form.md#reactnativepersistedform) 20 | 21 | ___ 22 | 23 | ### default 24 | 25 | Renames and re-exports [ReactNativeForm](react_formz_native_src_components_Form_Form.md#reactnativeform) 26 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_FormLastPersistedAt.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_FormLastPersistedAt" 3 | title: "Module: react-formz-native/src/components/FormLastPersistedAt" 4 | sidebar_label: "react-formz-native/src/components/FormLastPersistedAt" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [FormLastPersistedAt](react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt.md#formlastpersistedat) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt" 3 | title: "Module: react-formz-native/src/components/FormLastPersistedAt/FormLastPersistedAt" 4 | sidebar_label: "react-formz-native/src/components/FormLastPersistedAt/FormLastPersistedAt" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### FormLastPersistedAt 12 | 13 | ▸ **FormLastPersistedAt**(`__namedParameters`): ``null`` \| `Element` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `__namedParameters` | [`FormLastPersistedAtProps`](../interfaces/react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md) | 20 | 21 | #### Returns 22 | 23 | ``null`` \| `Element` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz-native/src/components/FormLastPersistedAt/FormLastPersistedAt.tsx:6](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-native/src/components/FormLastPersistedAt/FormLastPersistedAt.tsx#L6) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt_types" 3 | title: "Module: react-formz-native/src/components/FormLastPersistedAt/FormLastPersistedAt.types" 4 | sidebar_label: "react-formz-native/src/components/FormLastPersistedAt/FormLastPersistedAt.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FormLastPersistedAtProps](../interfaces/react_formz_native_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_Form_Form_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_Form_Form_types" 3 | title: "Module: react-formz-native/src/components/Form/Form.types" 4 | sidebar_label: "react-formz-native/src/components/Form/Form.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [NativeFormProps](../interfaces/react_formz_native_src_components_Form_Form_types.NativeFormProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_SubmitButton.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_SubmitButton" 3 | title: "Module: react-formz-native/src/components/SubmitButton" 4 | sidebar_label: "react-formz-native/src/components/SubmitButton" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [SubmitButton](react_formz_native_src_components_SubmitButton_SubmitButton.md#submitbutton) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_SubmitButton_SubmitButton.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_SubmitButton_SubmitButton" 3 | title: "Module: react-formz-native/src/components/SubmitButton/SubmitButton" 4 | sidebar_label: "react-formz-native/src/components/SubmitButton/SubmitButton" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### SubmitButton 12 | 13 | ▸ **SubmitButton**(`__namedParameters`): `Element` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `__namedParameters` | [`SubmitButtonProps`](../interfaces/react_formz_native_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md) | 20 | 21 | #### Returns 22 | 23 | `Element` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz-native/src/components/SubmitButton/SubmitButton.tsx:7](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-native/src/components/SubmitButton/SubmitButton.tsx#L7) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_components_SubmitButton_SubmitButton_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_components_SubmitButton_SubmitButton_types" 3 | title: "Module: react-formz-native/src/components/SubmitButton/SubmitButton.types" 4 | sidebar_label: "react-formz-native/src/components/SubmitButton/SubmitButton.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [SubmitButtonProps](../interfaces/react_formz_native_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_providers_ArrayFieldProvider.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_providers_ArrayFieldProvider" 3 | title: "Module: react-formz-native/src/providers/ArrayFieldProvider" 4 | sidebar_label: "react-formz-native/src/providers/ArrayFieldProvider" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### ArrayFieldProvider 12 | 13 | Re-exports [ArrayFieldProvider](react_formz_native_src_providers_ArrayFieldProvider_ArrayFieldProvider.md#arrayfieldprovider) 14 | 15 | ___ 16 | 17 | ### useArrayFieldProvider 18 | 19 | Re-exports [useArrayFieldProvider](react_formz_native_src_providers_ArrayFieldProvider_ArrayFieldProvider.md#usearrayfieldprovider) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_native_src_providers_FormSubmitProvider.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_native_src_providers_FormSubmitProvider" 3 | title: "Module: react-formz-native/src/providers/FormSubmitProvider" 4 | sidebar_label: "react-formz-native/src/providers/FormSubmitProvider" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [FormSubmitProvider](react_formz_native_src_providers_FormSubmitProvider_FormSubmitProvider.md#formsubmitprovider) 14 | 15 | ___ 16 | 17 | ### useFormSubmitContext 18 | 19 | Re-exports [useFormSubmitContext](react_formz_native_src_providers_FormSubmitProvider_FormSubmitProvider.md#useformsubmitcontext) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_constants.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_constants" 3 | title: "Module: react-formz/src/constants" 4 | sidebar_label: "react-formz/src/constants" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Variables 10 | 11 | ### MAX\_SAFE\_INTEGER 12 | 13 | • `Const` **MAX\_SAFE\_INTEGER**: ``9007199254740991`` 14 | 15 | #### Defined in 16 | 17 | [packages/react-formz/src/constants.ts:1](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/constants.ts#L1) 18 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_fields_useErrorMessage.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_fields_useErrorMessage" 3 | title: "Module: react-formz/src/hooks/fields/useErrorMessage" 4 | sidebar_label: "react-formz/src/hooks/fields/useErrorMessage" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useErrorMessage 12 | 13 | ▸ **useErrorMessage**(`field`): [`FormzError`](react_formz_src_types_form.md#formzerror) \| `undefined` 14 | 15 | Returns the error object for a form field. 16 | 17 | #### Parameters 18 | 19 | | Name | Type | Description | 20 | | :------ | :------ | :------ | 21 | | `field` | `string` | The name of the input field. | 22 | 23 | #### Returns 24 | 25 | [`FormzError`](react_formz_src_types_form.md#formzerror) \| `undefined` 26 | 27 | #### Defined in 28 | 29 | [packages/react-formz/src/hooks/fields/useErrorMessage.ts:11](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/fields/useErrorMessage.ts#L11) 30 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_fields_useFieldTouched.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_fields_useFieldTouched" 3 | title: "Module: react-formz/src/hooks/fields/useFieldTouched" 4 | sidebar_label: "react-formz/src/hooks/fields/useFieldTouched" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useFieldTouched 12 | 13 | ▸ **useFieldTouched**(`field`): `boolean` 14 | 15 | Custom hook that returns whether or not a field has been touched. 16 | 17 | #### Parameters 18 | 19 | | Name | Type | Description | 20 | | :------ | :------ | :------ | 21 | | `field` | `string` | The name of the input field. | 22 | 23 | #### Returns 24 | 25 | `boolean` 26 | 27 | #### Defined in 28 | 29 | [packages/react-formz/src/hooks/fields/useFieldTouched.ts:10](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/fields/useFieldTouched.ts#L10) 30 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_forms_useFormLastPersistedAt.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_forms_useFormLastPersistedAt" 3 | title: "Module: react-formz/src/hooks/forms/useFormLastPersistedAt" 4 | sidebar_label: "react-formz/src/hooks/forms/useFormLastPersistedAt" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useFormLastPersistedAt 12 | 13 | ▸ **useFormLastPersistedAt**(`id`): ``null`` \| `Date` 14 | 15 | Custom hook that returns a forms `lastPersistedAt` date i.e. 16 | the date of the last time the form was persisted to 17 | local storage. 18 | 19 | #### Parameters 20 | 21 | | Name | Type | Description | 22 | | :------ | :------ | :------ | 23 | | `id` | `string` | The id of the form. | 24 | 25 | #### Returns 26 | 27 | ``null`` \| `Date` 28 | 29 | #### Defined in 30 | 31 | [packages/react-formz/src/hooks/forms/useFormLastPersistedAt.ts:9](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/forms/useFormLastPersistedAt.ts#L9) 32 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_forms_useFormStateInitialized.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_forms_useFormStateInitialized" 3 | title: "Module: react-formz/src/hooks/forms/useFormStateInitialized" 4 | sidebar_label: "react-formz/src/hooks/forms/useFormStateInitialized" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useFormStateInitialized 12 | 13 | ▸ **useFormStateInitialized**(`id`): ``true`` 14 | 15 | Custom hook to return whether or not a form has been initialized 16 | i.e. the initial form object has been add to the form store. This happens 17 | after the first mount of the form. 18 | 19 | #### Parameters 20 | 21 | | Name | Type | Description | 22 | | :------ | :------ | :------ | 23 | | `id` | `string` | The id of the form. | 24 | 25 | #### Returns 26 | 27 | ``true`` 28 | 29 | #### Defined in 30 | 31 | [packages/react-formz/src/hooks/forms/useFormStateInitialized.ts:9](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/forms/useFormStateInitialized.ts#L9) 32 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_forms_useRegisterFormSchema.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_forms_useRegisterFormSchema" 3 | title: "Module: react-formz/src/hooks/forms/useRegisterFormSchema" 4 | sidebar_label: "react-formz/src/hooks/forms/useRegisterFormSchema" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useRegisterFormSchema 12 | 13 | ▸ **useRegisterFormSchema**(`id`, `schemaValidator?`, `persist?`): `void` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | Default value | 18 | | :------ | :------ | :------ | 19 | | `id` | `string` | `undefined` | 20 | | `schemaValidator?` | [`SchemaValidator`](../classes/react_formz_src_models_SchemaValidator.SchemaValidator.md)<`any`\> | `undefined` | 21 | | `persist` | `boolean` | `false` | 22 | 23 | #### Returns 24 | 25 | `void` 26 | 27 | #### Defined in 28 | 29 | [packages/react-formz/src/hooks/forms/useRegisterFormSchema.ts:9](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/forms/useRegisterFormSchema.ts#L9) 30 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_utils_useComponentDidMount.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_utils_useComponentDidMount" 3 | title: "Module: react-formz/src/hooks/utils/useComponentDidMount" 4 | sidebar_label: "react-formz/src/hooks/utils/useComponentDidMount" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useComponentDidMount 12 | 13 | ▸ **useComponentDidMount**(`callback`): `void` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `callback` | `EffectCallback` | 20 | 21 | #### Returns 22 | 23 | `void` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz/src/hooks/utils/useComponentDidMount.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/utils/useComponentDidMount.ts#L3) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_utils_useIsomorphicLayoutEffect.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_utils_useIsomorphicLayoutEffect" 3 | title: "Module: react-formz/src/hooks/utils/useIsomorphicLayoutEffect" 4 | sidebar_label: "react-formz/src/hooks/utils/useIsomorphicLayoutEffect" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useIsomorphicLayoutEffect 12 | 13 | ▸ **useIsomorphicLayoutEffect**(`effect`, `deps?`): `void` 14 | 15 | Accepts a function that contains imperative, possibly effectful code. 16 | 17 | **`Version`** 18 | 19 | 16.8.0 20 | 21 | **`See`** 22 | 23 | https://reactjs.org/docs/hooks-reference.html#useeffect 24 | 25 | #### Parameters 26 | 27 | | Name | Type | Description | 28 | | :------ | :------ | :------ | 29 | | `effect` | `EffectCallback` | Imperative function that can return a cleanup function | 30 | | `deps?` | `DependencyList` | If present, effect will only activate if the values in the list change. | 31 | 32 | #### Returns 33 | 34 | `void` 35 | 36 | #### Defined in 37 | 38 | node_modules/@types/react/index.d.ts:1059 39 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_utils_useSelector.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_utils_useSelector" 3 | title: "Module: react-formz/src/hooks/utils/useSelector" 4 | sidebar_label: "react-formz/src/hooks/utils/useSelector" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useSelector 12 | 13 | ▸ **useSelector**<`SelectorFn`\>(`fn`): `SelectorFn` 14 | 15 | #### Type parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `SelectorFn` | extends (...`args`: `any`[]) => `any` | 20 | 21 | #### Parameters 22 | 23 | | Name | Type | 24 | | :------ | :------ | 25 | | `fn` | `SelectorFn` | 26 | 27 | #### Returns 28 | 29 | `SelectorFn` 30 | 31 | #### Defined in 32 | 33 | [packages/react-formz/src/hooks/utils/useSelector.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/utils/useSelector.ts#L3) 34 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_hooks_utils_useStableValue.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_hooks_utils_useStableValue" 3 | title: "Module: react-formz/src/hooks/utils/useStableValue" 4 | sidebar_label: "react-formz/src/hooks/utils/useStableValue" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### useStableValue 12 | 13 | ▸ **useStableValue**<`Value`\>(`value`): `Value` 14 | 15 | React hook that caches some value and does not change it. Useful for when 16 | you want to maintain a reference to a function or an object and don't want 17 | it to change. 18 | 19 | #### Type parameters 20 | 21 | | Name | Type | 22 | | :------ | :------ | 23 | | `Value` | extends `unknown` | 24 | 25 | #### Parameters 26 | 27 | | Name | Type | Description | 28 | | :------ | :------ | :------ | 29 | | `value` | `Value` | The value to return. | 30 | 31 | #### Returns 32 | 33 | `Value` 34 | 35 | #### Defined in 36 | 37 | [packages/react-formz/src/hooks/utils/useStableValue.ts:9](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/hooks/utils/useStableValue.ts#L9) 38 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_logger.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_logger" 3 | title: "Module: react-formz/src/logger" 4 | sidebar_label: "react-formz/src/logger" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [logger](react_formz_src_logger_logger.md#logger) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_logger_logger.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_logger_logger" 3 | title: "Module: react-formz/src/logger/logger" 4 | sidebar_label: "react-formz/src/logger/logger" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Variables 10 | 11 | ### logger 12 | 13 | • `Const` **logger**: `Object` 14 | 15 | #### Type declaration 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `error` | (...`args`: `any`[]) => `void` | 20 | | `log` | (...`args`: `any`[]) => `void` | 21 | | `warn` | (...`args`: `any`[]) => `void` | 22 | 23 | #### Defined in 24 | 25 | [packages/react-formz/src/logger/logger.ts:6](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/logger/logger.ts#L6) 26 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_models_Cache.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_models_Cache" 3 | title: "Module: react-formz/src/models/Cache" 4 | sidebar_label: "react-formz/src/models/Cache" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Classes 10 | 11 | - [Cache](../classes/react_formz_src_models_Cache.Cache.md) 12 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_models_SchemaValidator.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_models_SchemaValidator" 3 | title: "Module: react-formz/src/models/SchemaValidator" 4 | sidebar_label: "react-formz/src/models/SchemaValidator" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Classes 10 | 11 | - [SchemaValidator](../classes/react_formz_src_models_SchemaValidator.SchemaValidator.md) 12 | 13 | ## Interfaces 14 | 15 | - [SchemaValidatorErrorResult](../interfaces/react_formz_src_models_SchemaValidator.SchemaValidatorErrorResult.md) 16 | - [SchemaValidatorSuccessResult](../interfaces/react_formz_src_models_SchemaValidator.SchemaValidatorSuccessResult.md) 17 | - [SchemaValidatorValidate](../interfaces/react_formz_src_models_SchemaValidator.SchemaValidatorValidate.md) 18 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_providers_FormDateProvider.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_providers_FormDateProvider" 3 | title: "Module: react-formz/src/providers/FormDateProvider" 4 | sidebar_label: "react-formz/src/providers/FormDateProvider" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [FormDateProvider](react_formz_src_providers_FormDateProvider_FormDateProvider.md#formdateprovider) 14 | 15 | ___ 16 | 17 | ### useFormDateContext 18 | 19 | Re-exports [useFormDateContext](react_formz_src_providers_FormDateProvider_FormDateProvider.md#useformdatecontext) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_providers_FormDateProvider_FormDateProvider_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_providers_FormDateProvider_FormDateProvider_types" 3 | title: "Module: react-formz/src/providers/FormDateProvider/FormDateProvider.types" 4 | sidebar_label: "react-formz/src/providers/FormDateProvider/FormDateProvider.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FormDateProviderProps](../interfaces/react_formz_src_providers_FormDateProvider_FormDateProvider_types.FormDateProviderProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_providers_FormIdProvider.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_providers_FormIdProvider" 3 | title: "Module: react-formz/src/providers/FormIdProvider" 4 | sidebar_label: "react-formz/src/providers/FormIdProvider" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [FormIdProvider](react_formz_src_providers_FormIdProvider_FormIdProvider.md#formidprovider) 14 | 15 | ___ 16 | 17 | ### useFormIdContext 18 | 19 | Re-exports [useFormIdContext](react_formz_src_providers_FormIdProvider_FormIdProvider.md#useformidcontext) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_providers_FormProvider.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_providers_FormProvider" 3 | title: "Module: react-formz/src/providers/FormProvider" 4 | sidebar_label: "react-formz/src/providers/FormProvider" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [FormProvider](react_formz_src_providers_FormProvider_FormProvider.md#formprovider) 14 | 15 | ___ 16 | 17 | ### useFormContext 18 | 19 | Re-exports [useFormContext](react_formz_src_providers_FormProvider_FormProvider.md#useformcontext) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_getFieldStoreValue.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_getFieldStoreValue" 3 | title: "Module: react-formz/src/store/actions/getFieldStoreValue" 4 | sidebar_label: "react-formz/src/store/actions/getFieldStoreValue" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### getFieldStoreValue 12 | 13 | ▸ **getFieldStoreValue**<`Value`\>(`formId`, `name`): `Value` 14 | 15 | #### Type parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `Value` | extends [`FieldValue`](react_formz_src_types_field.md#fieldvalue) = [`FieldValue`](react_formz_src_types_field.md#fieldvalue) | 20 | 21 | #### Parameters 22 | 23 | | Name | Type | 24 | | :------ | :------ | 25 | | `formId` | `string` | 26 | | `name` | `string` | 27 | 28 | #### Returns 29 | 30 | `Value` 31 | 32 | #### Defined in 33 | 34 | [packages/react-formz/src/store/actions/getFieldStoreValue.ts:5](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/store/actions/getFieldStoreValue.ts#L5) 35 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_getFormState.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_getFormState" 3 | title: "Module: react-formz/src/store/actions/getFormState" 4 | sidebar_label: "react-formz/src/store/actions/getFormState" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### getFormState 12 | 13 | ▸ **getFormState**<`Values`\>(`id`): [`FormzState`](react_formz_src_types_form.md#formzstate)<`Values`\> 14 | 15 | #### Type parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `Values` | extends [`FormzValues`](react_formz_src_types_form.md#formzvalues) | 20 | 21 | #### Parameters 22 | 23 | | Name | Type | 24 | | :------ | :------ | 25 | | `id` | `string` | 26 | 27 | #### Returns 28 | 29 | [`FormzState`](react_formz_src_types_form.md#formzstate)<`Values`\> 30 | 31 | #### Defined in 32 | 33 | [packages/react-formz/src/store/actions/getFormState.ts:4](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/store/actions/getFormState.ts#L4) 34 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_incrementFormSubmitCount.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_incrementFormSubmitCount" 3 | title: "Module: react-formz/src/store/actions/incrementFormSubmitCount" 4 | sidebar_label: "react-formz/src/store/actions/incrementFormSubmitCount" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### incrementFormSubmitCount 12 | 13 | ▸ **incrementFormSubmitCount**(`id`): `void` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `id` | `string` | 20 | 21 | #### Returns 22 | 23 | `void` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz/src/store/actions/incrementFormSubmitCount.ts:4](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/store/actions/incrementFormSubmitCount.ts#L4) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_resetFieldError.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_resetFieldError" 3 | title: "Module: react-formz/src/store/actions/resetFieldError" 4 | sidebar_label: "react-formz/src/store/actions/resetFieldError" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### resetFieldError 12 | 13 | Renames and re-exports [__type](react_formz_src_store_actions.md#__type) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_resetFormState.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_resetFormState" 3 | title: "Module: react-formz/src/store/actions/resetFormState" 4 | sidebar_label: "react-formz/src/store/actions/resetFormState" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### resetFormState 12 | 13 | Renames and re-exports [__type](react_formz_src_store_actions.md#__type) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_setFieldError.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_setFieldError" 3 | title: "Module: react-formz/src/store/actions/setFieldError" 4 | sidebar_label: "react-formz/src/store/actions/setFieldError" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### setFieldError 12 | 13 | ▸ **setFieldError**(`formId`, `name`, `error`): `void` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `formId` | `string` | 20 | | `name` | `string` | 21 | | `error` | [`FormzError`](react_formz_src_types_form.md#formzerror) | 22 | 23 | #### Returns 24 | 25 | `void` 26 | 27 | #### Defined in 28 | 29 | [packages/react-formz/src/store/actions/setFieldError.ts:6](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/store/actions/setFieldError.ts#L6) 30 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_setFieldTouched.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_setFieldTouched" 3 | title: "Module: react-formz/src/store/actions/setFieldTouched" 4 | sidebar_label: "react-formz/src/store/actions/setFieldTouched" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### setFieldTouched 12 | 13 | Renames and re-exports [__type](react_formz_src_store_actions.md#__type) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_setFieldValue.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_setFieldValue" 3 | title: "Module: react-formz/src/store/actions/setFieldValue" 4 | sidebar_label: "react-formz/src/store/actions/setFieldValue" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### setFieldValue 12 | 13 | Renames and re-exports [__type](react_formz_src_store_actions.md#__type) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_setFormIsSubmitting.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_setFormIsSubmitting" 3 | title: "Module: react-formz/src/store/actions/setFormIsSubmitting" 4 | sidebar_label: "react-formz/src/store/actions/setFormIsSubmitting" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### setFormIsSubmitting 12 | 13 | Renames and re-exports [__type](react_formz_src_store_actions.md#__type) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_updateFormValue.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_updateFormValue" 3 | title: "Module: react-formz/src/store/actions/updateFormValue" 4 | sidebar_label: "react-formz/src/store/actions/updateFormValue" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### updateFormValue 12 | 13 | Renames and re-exports [__type](react_formz_src_store_actions.md#__type) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_actions_updateIsInvalid.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_actions_updateIsInvalid" 3 | title: "Module: react-formz/src/store/actions/updateIsInvalid" 4 | sidebar_label: "react-formz/src/store/actions/updateIsInvalid" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### updateIsInvalid 12 | 13 | ▸ **updateIsInvalid**(`state`, `formId`): `void` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `state` | `WritableDraft`<[`FormzStore`](../interfaces/react_formz_src_store_store_types.FormzStore.md)\> | 20 | | `formId` | `string` | 21 | 22 | #### Returns 23 | 24 | `void` 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/store/actions/updateIsInvalid.ts:4](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/store/actions/updateIsInvalid.ts#L4) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_store_store_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_store_store_types" 3 | title: "Module: react-formz/src/store/store.types" 4 | sidebar_label: "react-formz/src/store/store.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FormzFieldsStore](../interfaces/react_formz_src_store_store_types.FormzFieldsStore.md) 11 | - [FormzSchemaValidatorStore](../interfaces/react_formz_src_store_store_types.FormzSchemaValidatorStore.md) 12 | - [FormzStore](../interfaces/react_formz_src_store_store_types.FormzStore.md) 13 | - [RegisterFieldPayload](../interfaces/react_formz_src_store_store_types.RegisterFieldPayload.md) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_types_events.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_events" 3 | title: "Module: react-formz/src/types/events" 4 | sidebar_label: "react-formz/src/types/events" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Interfaces 10 | 11 | - [FormzChangeEvent](../interfaces/react_formz_src_types_events.FormzChangeEvent.md) 12 | - [FormzChangeEventHandler](../interfaces/react_formz_src_types_events.FormzChangeEventHandler.md) 13 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_types_keys.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_keys" 3 | title: "Module: react-formz/src/types/keys" 4 | sidebar_label: "react-formz/src/types/keys" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Type Aliases 10 | 11 | ### TypeFromPath 12 | 13 | Ƭ **TypeFromPath**<`T`, `P`\>: `P` extends \`${infer Left}.${infer Right}\` ? `Left` extends `ValidKey`<`T`\> ? `FieldWithPossiblyUndefined`<`T`[`Left`], `Right`\> : `TypeFromBracketNotation`<`T`, `Left`, `Right`\> : `P` extends `ValidKey`<`T`\> ? `T`[`P`] : `LastIndexedField`<`T`, `P`\> 14 | 15 | #### Type parameters 16 | 17 | | Name | 18 | | :------ | 19 | | `T` | 20 | | `P` | 21 | 22 | #### Defined in 23 | 24 | [packages/react-formz/src/types/keys.ts:52](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/types/keys.ts#L52) 25 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_types_validation.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_types_validation" 3 | title: "Module: react-formz/src/types/validation" 4 | sidebar_label: "react-formz/src/types/validation" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Type Aliases 10 | 11 | ### ValidationType 12 | 13 | Ƭ **ValidationType**: [`LiteralUnion`](react_formz_src_types_utils.md#literalunion)<``"required"`` \| ``"min"`` \| ``"max"`` \| ``"pattern"`` \| ``"custom"``\> 14 | 15 | #### Defined in 16 | 17 | [packages/react-formz/src/types/validation.ts:3](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/types/validation.ts#L3) 18 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_utils_getFieldValue.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_utils_getFieldValue" 3 | title: "Module: react-formz/src/utils/getFieldValue" 4 | sidebar_label: "react-formz/src/utils/getFieldValue" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### getFieldValue 12 | 13 | ▸ **getFieldValue**(`eventOrTextValue`): `string` \| `number` \| `boolean` \| `Date` \| ``null`` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `eventOrTextValue` | `string` \| [`FormzChangeEvent`](../interfaces/react_formz_src_types_events.FormzChangeEvent.md)<`any`\> | 20 | 21 | #### Returns 22 | 23 | `string` \| `number` \| `boolean` \| `Date` \| ``null`` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz/src/utils/getFieldValue.ts:5](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/utils/getFieldValue.ts#L5) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_utils_getTag.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_utils_getTag" 3 | title: "Module: react-formz/src/utils/getTag" 4 | sidebar_label: "react-formz/src/utils/getTag" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### getTag 12 | 13 | ▸ **getTag**(`value`): `StringToTag` 14 | 15 | Gets the `toStringTag` of `value`. 16 | 17 | #### Parameters 18 | 19 | | Name | Type | Description | 20 | | :------ | :------ | :------ | 21 | | `value` | `any` | The value to query. | 22 | 23 | #### Returns 24 | 25 | `StringToTag` 26 | 27 | Returns the `toString` tag which is a string value.. 28 | 29 | #### Defined in 30 | 31 | [packages/react-formz/src/utils/getTag.ts:11](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/utils/getTag.ts#L11) 32 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_utils_set.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_utils_set" 3 | title: "Module: react-formz/src/utils/set" 4 | sidebar_label: "react-formz/src/utils/set" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### set 12 | 13 | ▸ **set**<`Value`, `Values`\>(`object`, `path`, `value?`): `Values` 14 | 15 | #### Type parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `Value` | extends `unknown` | 20 | | `Values` | extends [`AnyObject`](react_formz_src_types_common.md#anyobject) | 21 | 22 | #### Parameters 23 | 24 | | Name | Type | 25 | | :------ | :------ | 26 | | `object` | `Values` | 27 | | `path` | `string` | 28 | | `value?` | `Value` | 29 | 30 | #### Returns 31 | 32 | `Values` 33 | 34 | #### Defined in 35 | 36 | [packages/react-formz/src/utils/set.ts:6](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/utils/set.ts#L6) 37 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_utils_stringToPath.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_utils_stringToPath" 3 | title: "Module: react-formz/src/utils/stringToPath" 4 | sidebar_label: "react-formz/src/utils/stringToPath" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### stringToPath 12 | 13 | ▸ **stringToPath**(`input`): `string`[] 14 | 15 | Converts a string path to an array. 16 | 17 | Thanks!: https://github.com/react-hook-form/react-hook-form/blob/master/src/utils/stringToPath.ts 18 | 19 | #### Parameters 20 | 21 | | Name | Type | 22 | | :------ | :------ | 23 | | `input` | `string` | 24 | 25 | #### Returns 26 | 27 | `string`[] 28 | 29 | #### Defined in 30 | 31 | [packages/react-formz/src/utils/stringToPath.ts:10](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/utils/stringToPath.ts#L10) 32 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_utils_toKey.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_utils_toKey" 3 | title: "Module: react-formz/src/utils/toKey" 4 | sidebar_label: "react-formz/src/utils/toKey" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### toKey 12 | 13 | ▸ `Private` **toKey**(`value`): `string` \| `symbol` 14 | 15 | Converts `value` to a string key if it's not a string or symbol. 16 | 17 | #### Parameters 18 | 19 | | Name | Type | Description | 20 | | :------ | :------ | :------ | 21 | | `value` | `any` | The value to inspect. | 22 | 23 | #### Returns 24 | 25 | `string` \| `symbol` 26 | 27 | Returns the key. 28 | 29 | #### Defined in 30 | 31 | [packages/react-formz/src/utils/toKey.ts:14](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/utils/toKey.ts#L14) 32 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_validations_doesNotMatchPattern.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_validations_doesNotMatchPattern" 3 | title: "Module: react-formz/src/validations/doesNotMatchPattern" 4 | sidebar_label: "react-formz/src/validations/doesNotMatchPattern" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### doesNotMatchPattern 12 | 13 | ▸ **doesNotMatchPattern**(`value`, `pattern`): `boolean` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `value` | `string` | 20 | | `pattern` | `RegExp` | 21 | 22 | #### Returns 23 | 24 | `boolean` 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/validations/doesNotMatchPattern.ts:1](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/validations/doesNotMatchPattern.ts#L1) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_validations_isAboveMax.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_validations_isAboveMax" 3 | title: "Module: react-formz/src/validations/isAboveMax" 4 | sidebar_label: "react-formz/src/validations/isAboveMax" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### isAboveMax 12 | 13 | ▸ **isAboveMax**(`value`, `max`): `boolean` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `value` | `number` | 20 | | `max` | `number` | 21 | 22 | #### Returns 23 | 24 | `boolean` 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/validations/isAboveMax.ts:1](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/validations/isAboveMax.ts#L1) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_src_validations_isBelowMin.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_src_validations_isBelowMin" 3 | title: "Module: react-formz/src/validations/isBelowMin" 4 | sidebar_label: "react-formz/src/validations/isBelowMin" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### isBelowMin 12 | 13 | ▸ **isBelowMin**(`value`, `min`): `boolean` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `value` | `number` | 20 | | `min` | `number` | 21 | 22 | #### Returns 23 | 24 | `boolean` 25 | 26 | #### Defined in 27 | 28 | [packages/react-formz/src/validations/isBelowMin.ts:1](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz/src/validations/isBelowMin.ts#L1) 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_ArrayField.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_ArrayField" 3 | title: "Module: react-formz-web/src/components/ArrayField" 4 | sidebar_label: "react-formz-web/src/components/ArrayField" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### ArrayFieldComponentProps 12 | 13 | Re-exports [ArrayFieldComponentProps](../interfaces/react_formz_web_src_components_ArrayField_ArrayField_types.ArrayFieldComponentProps.md) 14 | 15 | ___ 16 | 17 | ### ArrayFieldProps 18 | 19 | Re-exports [ArrayFieldProps](../interfaces/react_formz_web_src_components_ArrayField_ArrayField_types.ArrayFieldProps.md) 20 | 21 | ___ 22 | 23 | ### default 24 | 25 | Renames and re-exports [ArrayField](react_formz_web_src_components_ArrayField_ArrayField.md#arrayfield) 26 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_ArrayField_ArrayField.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_ArrayField_ArrayField" 3 | title: "Module: react-formz-web/src/components/ArrayField/ArrayField" 4 | sidebar_label: "react-formz-web/src/components/ArrayField/ArrayField" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### ArrayField 12 | 13 | ▸ **ArrayField**<`Value`, `Key`\>(`props`): `Element` 14 | 15 | #### Type parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `Value` | `Value` | 20 | | `Key` | extends `string` = `string` | 21 | 22 | #### Parameters 23 | 24 | | Name | Type | 25 | | :------ | :------ | 26 | | `props` | [`ArrayFieldProps`](../interfaces/react_formz_web_src_components_ArrayField_ArrayField_types.ArrayFieldProps.md)<`Value`, `Key`\> | 27 | 28 | #### Returns 29 | 30 | `Element` 31 | 32 | #### Defined in 33 | 34 | [packages/react-formz-web/src/components/ArrayField/ArrayField.tsx:6](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-web/src/components/ArrayField/ArrayField.tsx#L6) 35 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_CustomField.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_CustomField" 3 | title: "Module: react-formz-web/src/components/CustomField" 4 | sidebar_label: "react-formz-web/src/components/CustomField" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [CustomField](react_formz_web_src_components_CustomField_CustomField.md#customfield) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_DependentField_DependentField_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_DependentField_DependentField_types" 3 | title: "Module: react-formz-web/src/components/DependentField/DependentField.types" 4 | sidebar_label: "react-formz-web/src/components/DependentField/DependentField.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [DependentFieldProps](../interfaces/react_formz_web_src_components_DependentField_DependentField_types.DependentFieldProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_ErrorMessage.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_ErrorMessage" 3 | title: "Module: react-formz-web/src/components/ErrorMessage" 4 | sidebar_label: "react-formz-web/src/components/ErrorMessage" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### ErrorMessageProps 12 | 13 | Re-exports [ErrorMessageProps](../interfaces/react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md) 14 | 15 | ___ 16 | 17 | ### default 18 | 19 | Renames and re-exports [ErrorMessage](react_formz_web_src_components_ErrorMessage_ErrorMessage.md#errormessage) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_ErrorMessage_ErrorMessage.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_ErrorMessage_ErrorMessage" 3 | title: "Module: react-formz-web/src/components/ErrorMessage/ErrorMessage" 4 | sidebar_label: "react-formz-web/src/components/ErrorMessage/ErrorMessage" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### ErrorMessage 12 | 13 | ▸ **ErrorMessage**(`__namedParameters`): ``null`` \| `Element` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `__namedParameters` | [`ErrorMessageProps`](../interfaces/react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md) | 20 | 21 | #### Returns 22 | 23 | ``null`` \| `Element` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz-web/src/components/ErrorMessage/ErrorMessage.tsx:5](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-web/src/components/ErrorMessage/ErrorMessage.tsx#L5) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_ErrorMessage_ErrorMessage_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_ErrorMessage_ErrorMessage_types" 3 | title: "Module: react-formz-web/src/components/ErrorMessage/ErrorMessage.types" 4 | sidebar_label: "react-formz-web/src/components/ErrorMessage/ErrorMessage.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [ErrorMessageBaseProps](../interfaces/react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageBaseProps.md) 11 | - [ErrorMessageComponentProps](../interfaces/react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageComponentProps.md) 12 | - [ErrorMessageProps](../interfaces/react_formz_web_src_components_ErrorMessage_ErrorMessage_types.ErrorMessageProps.md) 13 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_Field_Field_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_Field_Field_types" 3 | title: "Module: react-formz-web/src/components/Field/Field.types" 4 | sidebar_label: "react-formz-web/src/components/Field/Field.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FieldComponentProps](../interfaces/react_formz_web_src_components_Field_Field_types.FieldComponentProps.md) 11 | - [FieldInputProps](../interfaces/react_formz_web_src_components_Field_Field_types.FieldInputProps.md) 12 | - [WebFieldProps](../interfaces/react_formz_web_src_components_Field_Field_types.WebFieldProps.md) 13 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_Form.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_Form" 3 | title: "Module: react-formz-web/src/components/Form" 4 | sidebar_label: "react-formz-web/src/components/Form" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### FormProps 12 | 13 | Renames and re-exports [WebFormProps](../interfaces/react_formz_web_src_components_Form_Form_types.WebFormProps.md) 14 | 15 | ___ 16 | 17 | ### PersistedForm 18 | 19 | Re-exports [PersistedForm](react_formz_web_src_components_Form_Form.md#persistedform) 20 | 21 | ___ 22 | 23 | ### default 24 | 25 | Renames and re-exports [Form](react_formz_web_src_components_Form_Form.md#form) 26 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_FormLastPersistedAt.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_FormLastPersistedAt" 3 | title: "Module: react-formz-web/src/components/FormLastPersistedAt" 4 | sidebar_label: "react-formz-web/src/components/FormLastPersistedAt" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### default 12 | 13 | Renames and re-exports [FormLastPersistedAt](react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt.md#formlastpersistedat) 14 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt" 3 | title: "Module: react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt" 4 | sidebar_label: "react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## Functions 10 | 11 | ### FormLastPersistedAt 12 | 13 | ▸ **FormLastPersistedAt**(`__namedParameters`): ``null`` \| `Element` 14 | 15 | #### Parameters 16 | 17 | | Name | Type | 18 | | :------ | :------ | 19 | | `__namedParameters` | [`FormLastPersistedAtProps`](../interfaces/react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md) | 20 | 21 | #### Returns 22 | 23 | ``null`` \| `Element` 24 | 25 | #### Defined in 26 | 27 | [packages/react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.tsx:5](https://github.com/ZerryStack/react-formz/blob/main/packages/react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.tsx#L5) 28 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types" 3 | title: "Module: react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.types" 4 | sidebar_label: "react-formz-web/src/components/FormLastPersistedAt/FormLastPersistedAt.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FormLastPersistedAtProps](../interfaces/react_formz_web_src_components_FormLastPersistedAt_FormLastPersistedAt_types.FormLastPersistedAtProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_Form_Form_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_Form_Form_types" 3 | title: "Module: react-formz-web/src/components/Form/Form.types" 4 | sidebar_label: "react-formz-web/src/components/Form/Form.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [FormChildrenProps](../interfaces/react_formz_web_src_components_Form_Form_types.FormChildrenProps.md) 11 | - [WebFormProps](../interfaces/react_formz_web_src_components_Form_Form_types.WebFormProps.md) 12 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_SubmitButton.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_SubmitButton" 3 | title: "Module: react-formz-web/src/components/SubmitButton" 4 | sidebar_label: "react-formz-web/src/components/SubmitButton" 5 | sidebar_position: 0 6 | custom_edit_url: null 7 | --- 8 | 9 | ## References 10 | 11 | ### SubmitButtonProps 12 | 13 | Re-exports [SubmitButtonProps](../interfaces/react_formz_web_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md) 14 | 15 | ___ 16 | 17 | ### default 18 | 19 | Renames and re-exports [SubmitButton](react_formz_web_src_components_SubmitButton_SubmitButton.md#submitbutton) 20 | -------------------------------------------------------------------------------- /packages/documentation/docs/api/generated/modules/react_formz_web_src_components_SubmitButton_SubmitButton_types.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: "react_formz_web_src_components_SubmitButton_SubmitButton_types" 3 | title: "Module: react-formz-web/src/components/SubmitButton/SubmitButton.types" 4 | sidebar_label: "react-formz-web/src/components/SubmitButton/SubmitButton.types" 5 | custom_edit_url: null 6 | --- 7 | 8 | ## Interfaces 9 | 10 | - [SubmitButtonProps](../interfaces/react_formz_web_src_components_SubmitButton_SubmitButton_types.SubmitButtonProps.md) 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/components/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Components", 3 | "position": 4, 4 | "link": { 5 | "type": "generated-index", 6 | "description": "A breakdown of the components exported by React Formz." 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /packages/documentation/docs/guides/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Guides", 3 | "position": 3, 4 | "link": { 5 | "type": "generated-index", 6 | "description": "Usage guides to learn how to use React Formz." 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /packages/documentation/docs/guides/basic-usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | 5 | # Basic Usage 6 | 7 | The goal of React Formz is to make form building feel natural, painless and declarative so the api is designed to be easy-to-use and solve common issues with building forms behind the scenes. 8 | 9 | The most basic components of React Formz are `Form` and `Field`. `Form`'s serve as the contextual data and api wrapper for all of its' fields. Fields can be nested to any depth, dynamically rendered and deleted as needed. 10 | 11 | 17 | -------------------------------------------------------------------------------- /packages/documentation/docs/guides/conditional-field.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | 5 | # Conditional Fields 6 | 7 | There will be times when you want to conditionally render a field based on the value or values of other fields. React Hook Form supports that out of the box with ease. You can use as `DependentField` as so: 8 | 9 | ```tsx 10 | 11 | 12 | name="favoriteDrink" 13 | dependencies={(values) => ({ dob: values.dob })} 14 | as={({ input, dependencies }) => { 15 | if (dependencies.dob < 21) return null; 16 | return 17 | }} 18 | /> 19 | ``` 20 | 21 | 27 | -------------------------------------------------------------------------------- /packages/documentation/docs/guides/field-validation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 3 3 | --- 4 | 5 | # Field Validation 6 | 7 | `Field`'s can be validated in a few ways. The following pre-built validations are available: 8 | 9 | - required 10 | - min 11 | - max 12 | - pattern 13 | 14 | If you want to use your own validation either sync or async (returns a Promise) you can use the `validate` property of a `Field`. 15 | 16 | The sandbox below shows how the validator can be used. 17 | 18 | 24 | -------------------------------------------------------------------------------- /packages/documentation/docs/hooks/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Hooks", 3 | "position": 3, 4 | "link": { 5 | "type": "generated-index", 6 | "description": "React Formz hooks api." 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /packages/documentation/docs/hooks/use-field.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | 5 | # useField 6 | 7 | React Formz also exposes field hooks that you can use to build your own components. 8 | 9 | 16 | 17 | ## Declarative Hooks 18 | 19 | Because of React Formz principle of declarative first programming a number of helper hooks are export for you as well. 20 | 21 | - `useTextField` 22 | - `useBooleanField` 23 | - `useRadioField` 24 | - `useNumberField` 25 | - `useDateField` 26 | - `useSelectField` 27 | - `useDateField` 28 | - `useCustomField` 29 | -------------------------------------------------------------------------------- /packages/documentation/docs/react-native/array-field.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | import ExpoSnack from "../../src/components/ExpoSnack"; 6 | 7 | # Array Field 8 | 9 | Array Fields work with react native as well using the same api as the web library. 10 | 11 | -------------------------------------------------------------------------------- /packages/documentation/docs/react-native/basic-usage.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | 5 | import ExpoSnack from "../../src/components/ExpoSnack"; 6 | 7 | # Basic Usage 8 | 9 | React Formz can be used in React Native as well and the API is mostly the same so the skills from using either web or native can be transferred to the alternate. 10 | You get all of the same features with both library versions as well. 11 | 12 | ## Installation 13 | 14 | ### NPM 15 | 16 | React Formz can be installed the same as every other package. 17 | 18 | ```sh 19 | npm install @zerry/react-formz-native immer 20 | ``` 21 | 22 | ### Yarn 23 | 24 | ```sh 25 | yarn add @zerry/react-formz-native immer 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /packages/documentation/project.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@zerry/react-formz-documentation", 3 | "$schema": "../../node_modules/nx/schemas/project-schema.json", 4 | "sourceRoot": "packages/documentation", 5 | "projectType": "library", 6 | "targets": {}, 7 | "tags": [] 8 | } -------------------------------------------------------------------------------- /packages/documentation/src/components/ExpoSnack/ExpoSnack.tsx: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | 3 | interface ExpoSnackProps { 4 | id: string; 5 | style?: React.CSSProperties 6 | } 7 | 8 | const ExpoSnack = ({ id, style }: ExpoSnackProps) => { 9 | return ( 10 | <> 11 |