diff --git a/assets/search.js b/assets/search.js index 5e73f8c..5b437d0 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":4,\"name\":\"validator\",\"url\":\"modules/validator.html\",\"classes\":\"tsd-kind-namespace\"},{\"kind\":64,\"name\":\"combine\",\"url\":\"functions/validator.combine.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"min\",\"url\":\"functions/validator.min.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"max\",\"url\":\"functions/validator.max.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"minLength\",\"url\":\"functions/validator.minLength.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"maxLength\",\"url\":\"functions/validator.maxLength.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"pattern\",\"url\":\"functions/validator.pattern.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"useForm\",\"url\":\"functions/useForm.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"UseFormOptions\",\"url\":\"interfaces/UseFormOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"initialState\",\"url\":\"interfaces/UseFormOptions.html#initialState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":2048,\"name\":\"onSubmit\",\"url\":\"interfaces/UseFormOptions.html#onSubmit\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":1024,\"name\":\"errorMessages\",\"url\":\"interfaces/UseFormOptions.html#errorMessages\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":1024,\"name\":\"autoValidateBehavior\",\"url\":\"interfaces/UseFormOptions.html#autoValidateBehavior\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":256,\"name\":\"UseFormReturn\",\"url\":\"interfaces/UseFormReturn.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"field\",\"url\":\"interfaces/UseFormReturn.html#field\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"errors\",\"url\":\"interfaces/UseFormReturn.html#errors\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"state\",\"url\":\"interfaces/UseFormReturn.html#state\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"rawState\",\"url\":\"interfaces/UseFormReturn.html#rawState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"isValid\",\"url\":\"interfaces/UseFormReturn.html#isValid\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"handleSubmit\",\"url\":\"interfaces/UseFormReturn.html#handleSubmit\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"setValues\",\"url\":\"interfaces/UseFormReturn.html#setValues\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"interfaces/UseFormReturn.html#setValue\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"interfaces/UseFormReturn.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":256,\"name\":\"FieldOptions\",\"url\":\"interfaces/FieldOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"interfaces/FieldOptions.html#required\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"interfaces/FieldOptions.html#minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"maxLength\",\"url\":\"interfaces/FieldOptions.html#maxLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"pattern\",\"url\":\"interfaces/FieldOptions.html#pattern\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"errorMessages\",\"url\":\"interfaces/FieldOptions.html#errorMessages\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"validate\",\"url\":\"interfaces/FieldOptions.html#validate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":2048,\"name\":\"parse\",\"url\":\"interfaces/FieldOptions.html#parse\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":2048,\"name\":\"onChange\",\"url\":\"interfaces/FieldOptions.html#onChange\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":2048,\"name\":\"onBlur\",\"url\":\"interfaces/FieldOptions.html#onBlur\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":256,\"name\":\"ErrorMessage\",\"url\":\"interfaces/ErrorMessage.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/ErrorMessage.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorMessage\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"interfaces/ErrorMessage.html#message\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorMessage\"},{\"kind\":4194304,\"name\":\"Validator\",\"url\":\"types/Validator-1.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Validator-1.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Validator\"},{\"kind\":4194304,\"name\":\"MessageResolver\",\"url\":\"types/MessageResolver.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MessageResolver.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"MessageResolver\"},{\"kind\":256,\"name\":\"ErrorStrings\",\"url\":\"interfaces/ErrorStrings.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"interfaces/ErrorStrings.html#required\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorStrings\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"interfaces/ErrorStrings.html#minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorStrings\"},{\"kind\":1024,\"name\":\"maxLength\",\"url\":\"interfaces/ErrorStrings.html#maxLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorStrings\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,28.904]],[\"comment/0\",[]],[\"name/1\",[1,34.012]],[\"comment/1\",[]],[\"name/2\",[2,34.012]],[\"comment/2\",[]],[\"name/3\",[3,34.012]],[\"comment/3\",[]],[\"name/4\",[4,25.539]],[\"comment/4\",[]],[\"name/5\",[5,25.539]],[\"comment/5\",[]],[\"name/6\",[6,28.904]],[\"comment/6\",[]],[\"name/7\",[7,34.012]],[\"comment/7\",[]],[\"name/8\",[8,34.012]],[\"comment/8\",[]],[\"name/9\",[9,34.012]],[\"comment/9\",[]],[\"name/10\",[10,34.012]],[\"comment/10\",[]],[\"name/11\",[11,28.904]],[\"comment/11\",[]],[\"name/12\",[12,34.012]],[\"comment/12\",[]],[\"name/13\",[13,34.012]],[\"comment/13\",[]],[\"name/14\",[14,34.012]],[\"comment/14\",[]],[\"name/15\",[15,34.012]],[\"comment/15\",[]],[\"name/16\",[16,34.012]],[\"comment/16\",[]],[\"name/17\",[17,34.012]],[\"comment/17\",[]],[\"name/18\",[18,34.012]],[\"comment/18\",[]],[\"name/19\",[19,34.012]],[\"comment/19\",[]],[\"name/20\",[20,34.012]],[\"comment/20\",[]],[\"name/21\",[21,34.012]],[\"comment/21\",[]],[\"name/22\",[22,28.904]],[\"comment/22\",[]],[\"name/23\",[23,34.012]],[\"comment/23\",[]],[\"name/24\",[24,28.904]],[\"comment/24\",[]],[\"name/25\",[4,25.539]],[\"comment/25\",[]],[\"name/26\",[5,25.539]],[\"comment/26\",[]],[\"name/27\",[6,28.904]],[\"comment/27\",[]],[\"name/28\",[11,28.904]],[\"comment/28\",[]],[\"name/29\",[22,28.904]],[\"comment/29\",[]],[\"name/30\",[25,34.012]],[\"comment/30\",[]],[\"name/31\",[26,34.012]],[\"comment/31\",[]],[\"name/32\",[27,34.012]],[\"comment/32\",[]],[\"name/33\",[28,34.012]],[\"comment/33\",[]],[\"name/34\",[29,34.012]],[\"comment/34\",[]],[\"name/35\",[30,34.012]],[\"comment/35\",[]],[\"name/36\",[0,28.904]],[\"comment/36\",[]],[\"name/37\",[31,28.904]],[\"comment/37\",[]],[\"name/38\",[32,34.012]],[\"comment/38\",[]],[\"name/39\",[31,28.904]],[\"comment/39\",[]],[\"name/40\",[33,34.012]],[\"comment/40\",[]],[\"name/41\",[24,28.904]],[\"comment/41\",[]],[\"name/42\",[4,25.539]],[\"comment/42\",[]],[\"name/43\",[5,25.539]],[\"comment/43\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":31,\"name\":{\"37\":{},\"39\":{}},\"comment\":{}}],[\"autovalidatebehavior\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"combine\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"error\",{\"_index\":29,\"name\":{\"34\":{}},\"comment\":{}}],[\"errormessage\",{\"_index\":28,\"name\":{\"33\":{}},\"comment\":{}}],[\"errormessages\",{\"_index\":11,\"name\":{\"11\":{},\"28\":{}},\"comment\":{}}],[\"errors\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"errorstrings\",{\"_index\":33,\"name\":{\"40\":{}},\"comment\":{}}],[\"field\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"fieldoptions\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"handlesubmit\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"initialstate\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"isvalid\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"max\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"maxlength\",{\"_index\":5,\"name\":{\"5\":{},\"26\":{},\"43\":{}},\"comment\":{}}],[\"message\",{\"_index\":30,\"name\":{\"35\":{}},\"comment\":{}}],[\"messageresolver\",{\"_index\":32,\"name\":{\"38\":{}},\"comment\":{}}],[\"min\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"minlength\",{\"_index\":4,\"name\":{\"4\":{},\"25\":{},\"42\":{}},\"comment\":{}}],[\"onblur\",{\"_index\":27,\"name\":{\"32\":{}},\"comment\":{}}],[\"onchange\",{\"_index\":26,\"name\":{\"31\":{}},\"comment\":{}}],[\"onsubmit\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"parse\",{\"_index\":25,\"name\":{\"30\":{}},\"comment\":{}}],[\"pattern\",{\"_index\":6,\"name\":{\"6\":{},\"27\":{}},\"comment\":{}}],[\"rawstate\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"required\",{\"_index\":24,\"name\":{\"24\":{},\"41\":{}},\"comment\":{}}],[\"setvalue\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"setvalues\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"state\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"useform\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"useformoptions\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"useformreturn\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"validate\",{\"_index\":22,\"name\":{\"22\":{},\"29\":{}},\"comment\":{}}],[\"validator\",{\"_index\":0,\"name\":{\"0\":{},\"36\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":4,\"name\":\"validator\",\"url\":\"modules/validator.html\",\"classes\":\"tsd-kind-namespace\"},{\"kind\":64,\"name\":\"combine\",\"url\":\"functions/validator.combine.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"min\",\"url\":\"functions/validator.min.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"max\",\"url\":\"functions/validator.max.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"minLength\",\"url\":\"functions/validator.minLength.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"maxLength\",\"url\":\"functions/validator.maxLength.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"pattern\",\"url\":\"functions/validator.pattern.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"validator\"},{\"kind\":64,\"name\":\"useForm\",\"url\":\"functions/useForm.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"UseFormOptions\",\"url\":\"interfaces/UseFormOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"initialState\",\"url\":\"interfaces/UseFormOptions.html#initialState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":2048,\"name\":\"onSubmit\",\"url\":\"interfaces/UseFormOptions.html#onSubmit\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":1024,\"name\":\"errorMessages\",\"url\":\"interfaces/UseFormOptions.html#errorMessages\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":1024,\"name\":\"autoValidateBehavior\",\"url\":\"interfaces/UseFormOptions.html#autoValidateBehavior\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormOptions\"},{\"kind\":256,\"name\":\"UseFormReturn\",\"url\":\"interfaces/UseFormReturn.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"field\",\"url\":\"interfaces/UseFormReturn.html#field\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"errors\",\"url\":\"interfaces/UseFormReturn.html#errors\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"state\",\"url\":\"interfaces/UseFormReturn.html#state\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"rawState\",\"url\":\"interfaces/UseFormReturn.html#rawState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"dirty\",\"url\":\"interfaces/UseFormReturn.html#dirty\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":1024,\"name\":\"isValid\",\"url\":\"interfaces/UseFormReturn.html#isValid\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"handleSubmit\",\"url\":\"interfaces/UseFormReturn.html#handleSubmit\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"setValues\",\"url\":\"interfaces/UseFormReturn.html#setValues\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"interfaces/UseFormReturn.html#setValue\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"interfaces/UseFormReturn.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"UseFormReturn\"},{\"kind\":256,\"name\":\"FieldOptions\",\"url\":\"interfaces/FieldOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"interfaces/FieldOptions.html#required\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"multiple\",\"url\":\"interfaces/FieldOptions.html#multiple\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"interfaces/FieldOptions.html#minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"maxLength\",\"url\":\"interfaces/FieldOptions.html#maxLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"pattern\",\"url\":\"interfaces/FieldOptions.html#pattern\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"errorMessages\",\"url\":\"interfaces/FieldOptions.html#errorMessages\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":1024,\"name\":\"validate\",\"url\":\"interfaces/FieldOptions.html#validate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":2048,\"name\":\"parse\",\"url\":\"interfaces/FieldOptions.html#parse\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":2048,\"name\":\"onChange\",\"url\":\"interfaces/FieldOptions.html#onChange\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":2048,\"name\":\"onBlur\",\"url\":\"interfaces/FieldOptions.html#onBlur\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"FieldOptions\"},{\"kind\":256,\"name\":\"ErrorMessage\",\"url\":\"interfaces/ErrorMessage.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/ErrorMessage.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorMessage\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"interfaces/ErrorMessage.html#message\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorMessage\"},{\"kind\":4194304,\"name\":\"Validator\",\"url\":\"types/Validator-1.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Validator-1.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Validator\"},{\"kind\":4194304,\"name\":\"MessageResolver\",\"url\":\"types/MessageResolver.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MessageResolver.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"MessageResolver\"},{\"kind\":256,\"name\":\"ErrorStrings\",\"url\":\"interfaces/ErrorStrings.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"interfaces/ErrorStrings.html#required\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorStrings\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"interfaces/ErrorStrings.html#minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorStrings\"},{\"kind\":1024,\"name\":\"maxLength\",\"url\":\"interfaces/ErrorStrings.html#maxLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ErrorStrings\"},{\"kind\":4194304,\"name\":\"InputType\",\"url\":\"types/InputType.html\",\"classes\":\"tsd-kind-type-alias\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,29.549]],[\"comment/0\",[]],[\"name/1\",[1,34.657]],[\"comment/1\",[]],[\"name/2\",[2,34.657]],[\"comment/2\",[]],[\"name/3\",[3,34.657]],[\"comment/3\",[]],[\"name/4\",[4,26.184]],[\"comment/4\",[]],[\"name/5\",[5,26.184]],[\"comment/5\",[]],[\"name/6\",[6,29.549]],[\"comment/6\",[]],[\"name/7\",[7,34.657]],[\"comment/7\",[]],[\"name/8\",[8,34.657]],[\"comment/8\",[]],[\"name/9\",[9,34.657]],[\"comment/9\",[]],[\"name/10\",[10,34.657]],[\"comment/10\",[]],[\"name/11\",[11,29.549]],[\"comment/11\",[]],[\"name/12\",[12,34.657]],[\"comment/12\",[]],[\"name/13\",[13,34.657]],[\"comment/13\",[]],[\"name/14\",[14,34.657]],[\"comment/14\",[]],[\"name/15\",[15,34.657]],[\"comment/15\",[]],[\"name/16\",[16,34.657]],[\"comment/16\",[]],[\"name/17\",[17,34.657]],[\"comment/17\",[]],[\"name/18\",[18,34.657]],[\"comment/18\",[]],[\"name/19\",[19,34.657]],[\"comment/19\",[]],[\"name/20\",[20,34.657]],[\"comment/20\",[]],[\"name/21\",[21,34.657]],[\"comment/21\",[]],[\"name/22\",[22,34.657]],[\"comment/22\",[]],[\"name/23\",[23,29.549]],[\"comment/23\",[]],[\"name/24\",[24,34.657]],[\"comment/24\",[]],[\"name/25\",[25,29.549]],[\"comment/25\",[]],[\"name/26\",[26,34.657]],[\"comment/26\",[]],[\"name/27\",[4,26.184]],[\"comment/27\",[]],[\"name/28\",[5,26.184]],[\"comment/28\",[]],[\"name/29\",[6,29.549]],[\"comment/29\",[]],[\"name/30\",[11,29.549]],[\"comment/30\",[]],[\"name/31\",[23,29.549]],[\"comment/31\",[]],[\"name/32\",[27,34.657]],[\"comment/32\",[]],[\"name/33\",[28,34.657]],[\"comment/33\",[]],[\"name/34\",[29,34.657]],[\"comment/34\",[]],[\"name/35\",[30,34.657]],[\"comment/35\",[]],[\"name/36\",[31,34.657]],[\"comment/36\",[]],[\"name/37\",[32,34.657]],[\"comment/37\",[]],[\"name/38\",[0,29.549]],[\"comment/38\",[]],[\"name/39\",[33,29.549]],[\"comment/39\",[]],[\"name/40\",[34,34.657]],[\"comment/40\",[]],[\"name/41\",[33,29.549]],[\"comment/41\",[]],[\"name/42\",[35,34.657]],[\"comment/42\",[]],[\"name/43\",[25,29.549]],[\"comment/43\",[]],[\"name/44\",[4,26.184]],[\"comment/44\",[]],[\"name/45\",[5,26.184]],[\"comment/45\",[]],[\"name/46\",[36,34.657]],[\"comment/46\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":33,\"name\":{\"39\":{},\"41\":{}},\"comment\":{}}],[\"autovalidatebehavior\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"combine\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"dirty\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"error\",{\"_index\":31,\"name\":{\"36\":{}},\"comment\":{}}],[\"errormessage\",{\"_index\":30,\"name\":{\"35\":{}},\"comment\":{}}],[\"errormessages\",{\"_index\":11,\"name\":{\"11\":{},\"30\":{}},\"comment\":{}}],[\"errors\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"errorstrings\",{\"_index\":35,\"name\":{\"42\":{}},\"comment\":{}}],[\"field\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"fieldoptions\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"handlesubmit\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"initialstate\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"inputtype\",{\"_index\":36,\"name\":{\"46\":{}},\"comment\":{}}],[\"isvalid\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"max\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"maxlength\",{\"_index\":5,\"name\":{\"5\":{},\"28\":{},\"45\":{}},\"comment\":{}}],[\"message\",{\"_index\":32,\"name\":{\"37\":{}},\"comment\":{}}],[\"messageresolver\",{\"_index\":34,\"name\":{\"40\":{}},\"comment\":{}}],[\"min\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"minlength\",{\"_index\":4,\"name\":{\"4\":{},\"27\":{},\"44\":{}},\"comment\":{}}],[\"multiple\",{\"_index\":26,\"name\":{\"26\":{}},\"comment\":{}}],[\"onblur\",{\"_index\":29,\"name\":{\"34\":{}},\"comment\":{}}],[\"onchange\",{\"_index\":28,\"name\":{\"33\":{}},\"comment\":{}}],[\"onsubmit\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"parse\",{\"_index\":27,\"name\":{\"32\":{}},\"comment\":{}}],[\"pattern\",{\"_index\":6,\"name\":{\"6\":{},\"29\":{}},\"comment\":{}}],[\"rawstate\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"required\",{\"_index\":25,\"name\":{\"25\":{},\"43\":{}},\"comment\":{}}],[\"setvalue\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"setvalues\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"state\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"useform\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"useformoptions\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"useformreturn\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"validate\",{\"_index\":23,\"name\":{\"23\":{},\"31\":{}},\"comment\":{}}],[\"validator\",{\"_index\":0,\"name\":{\"0\":{},\"38\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/functions/useForm.html b/functions/useForm.html index 1c1cf3b..9adddf5 100644 --- a/functions/useForm.html +++ b/functions/useForm.html @@ -44,7 +44,7 @@

Returns UseFormReturn<T>

+
  • Defined in use-form.ts:24
    • @@ -74,7 +74,8 @@
  • FieldOptions
  • UseFormOptions
  • UseFormReturn
    • -
  • MessageResolver
    • +
  • InputType
    • +
  • MessageResolver
  • Validator
  • useForm
    • diff --git a/functions/validator.combine.html b/functions/validator.combine.html index b394915..656167a 100644 --- a/functions/validator.combine.html +++ b/functions/validator.combine.html @@ -33,7 +33,7 @@

    Returns Validator

    +
  • Defined in validators.ts:10
    • diff --git a/functions/validator.max.html b/functions/validator.max.html index 76cdd43..be20aab 100644 --- a/functions/validator.max.html +++ b/functions/validator.max.html @@ -37,7 +37,7 @@

    Returns Validator<number>

    +
  • Defined in validators.ts:37
    • diff --git a/functions/validator.maxLength.html b/functions/validator.maxLength.html index ab128e7..9d4982a 100644 --- a/functions/validator.maxLength.html +++ b/functions/validator.maxLength.html @@ -37,7 +37,7 @@

    Returns Validator<string>

    +
  • Defined in validators.ts:57
    • diff --git a/functions/validator.min.html b/functions/validator.min.html index 8091245..cb15adb 100644 --- a/functions/validator.min.html +++ b/functions/validator.min.html @@ -37,7 +37,7 @@

    Returns Validator<number>

    +
  • Defined in validators.ts:27
    • diff --git a/functions/validator.minLength.html b/functions/validator.minLength.html index 7c35d3d..dabf378 100644 --- a/functions/validator.minLength.html +++ b/functions/validator.minLength.html @@ -37,7 +37,7 @@

    Returns Validator<string>

    +
  • Defined in validators.ts:47
    • diff --git a/functions/validator.pattern.html b/functions/validator.pattern.html index f4f894e..b036254 100644 --- a/functions/validator.pattern.html +++ b/functions/validator.pattern.html @@ -37,7 +37,7 @@

    Returns Validator<string>

    +
  • Defined in validators.ts:67
    • diff --git a/index.html b/index.html index ad28fef..031a17a 100644 --- a/index.html +++ b/index.html @@ -40,7 +40,7 @@ options, return values and more examples.

    values as needed.

    This is a full example of a hook usage with all the available options and return values. All options are optional, see the docs for each for more information.

    -
    const { field, handleSubmit, isValid, errors, state, rawState, setValue, setValues } =
      useForm<MyFormData>({
        initialState: {
          firstName: 'John',
          lastName: 'Doe',
        },
        autoValidateBehavior: 'onChange',
        errorMessages: {
          required: 'This field is required',
          minLength: (n) => `Must be more than ${n} chars long`,
          maxLength: (n) => `Must be less than ${n} chars long`,
        },
        onSubmit(values, e) {
          console.log('Form submitted:', values)
          fetch('/submit', { method: 'POST', body: JSON.stringify(values) })
        },
      })
+
    const { field, handleSubmit, isValid, errors, state, rawState, dirty, setValue, setValues } =
      useForm<MyFormData>({
        initialState: {
          firstName: 'John',
          lastName: 'Doe',
        },
        autoValidateBehavior: 'onChange',
        errorMessages: {
          required: 'This field is required',
          minLength: (n) => `Must be more than ${n} chars long`,
          maxLength: (n) => `Must be less than ${n} chars long`,
        },
        onSubmit(values, e) {
          console.log('Form submitted:', values)
          fetch('/submit', { method: 'POST', body: JSON.stringify(values) })
        },
      })
 
    
 
 
@@ -122,7 +122,8 @@ don't hesitate to open an appropriate issue and I will do my best to reply p
 
  • FieldOptions
    • 
 
  • UseFormOptions
    • 
 
  • UseFormReturn
    • 
-
  • MessageResolver
    • 
+
  • InputType
    • 
+
  • MessageResolver
    • 
 
  • Validator
    • 
 
  • useForm
    • diff --git a/interfaces/ErrorMessage.html b/interfaces/ErrorMessage.html index 51f0059..2e4cd71 100644 --- a/interfaces/ErrorMessage.html +++ b/interfaces/ErrorMessage.html @@ -33,7 +33,7 @@ under the field's key. Otherwise, it is undefined.

    +
  • Defined in types.ts:254
    • @@ -59,14 +59,14 @@ under the field's key. Otherwise, it is undefined.

    +
  • Defined in types.ts:263

    • message

    message: string

    The error message for the field.

    +
  • Defined in types.ts:268
    • diff --git a/interfaces/ErrorStrings.html b/interfaces/ErrorStrings.html index 3656e62..8db71f0 100644 --- a/interfaces/ErrorStrings.html +++ b/interfaces/ErrorStrings.html @@ -28,7 +28,7 @@
    • ErrorStrings
    +
  • Defined in types.ts:293
    • @@ -57,7 +57,7 @@
    +
  • Defined in types.ts:331

    • minLength

    minLength: string | MessageResolver<number>
    @@ -73,7 +73,7 @@
    +
  • Defined in types.ts:316

    • required

    required: string
    @@ -83,7 +83,7 @@

    See

    FieldOptions.required for defining a field as required

    +
  • Defined in types.ts:301
    • diff --git a/interfaces/FieldOptions.html b/interfaces/FieldOptions.html index 4131bd1..bf88e09 100644 --- a/interfaces/FieldOptions.html +++ b/interfaces/FieldOptions.html @@ -30,7 +30,7 @@
    • FieldOptions
    +
  • Defined in types.ts:133
    • @@ -41,6 +41,7 @@
    errorMessages? maxLength? minLength? +multiple? pattern? required? validate? @@ -68,7 +69,7 @@
    +
  • Defined in types.ts:189

    • Optional maxLength

    maxLength?: number
    @@ -78,7 +79,7 @@ be provided in UseFormReturn.errors.

    To provide a custom error message, use errorMessages.

    +
  • Defined in types.ts:169

    • Optional minLength

    minLength?: number
    @@ -88,7 +89,15 @@ be provided in UseFormReturn.errors.

    To provide a custom error message, use errorMessages.

    +
  • Defined in types.ts:159
    • +
    +

    Optional multiple

    +
    multiple?: boolean
    +

    If true, handlers will treat the field as an array and not a single value.

    +

    If you supply an array as the initial value, this will be set to true automatically.

    +

    Optional pattern

    pattern?: string | RegExp
    @@ -97,7 +106,7 @@ be provided in UseFormReturn.errors.

    error for a pattern, use validate instead.

    +
  • Defined in types.ts:177

    • Optional required

    required?: boolean
    @@ -107,7 +116,7 @@ error for a pattern, use validate inste

    To provide a custom error message, use errorMessages.

    +
  • Defined in types.ts:142

    • Optional validate

    validate?: Validator<T[K]>
    @@ -126,7 +135,7 @@ error for a pattern, use validate inste
    +
  • Defined in types.ts:204

    • Methods

    @@ -151,7 +160,7 @@ error for a pattern, use validate inste

    Returns void

    +
  • Defined in types.ts:240

    • Optional onChange

    Returns void

    +
  • Defined in types.ts:228

    • Optional parse

    +
  • Defined in types.ts:216
    • @@ -228,6 +237,7 @@ error for a pattern, use validate inste
  • errorMessages?
  • maxLength?
  • minLength?
    • +
  • multiple?
  • pattern?
  • required?
  • validate?
    • diff --git a/interfaces/UseFormOptions.html b/interfaces/UseFormOptions.html index 342ea18..eb788c1 100644 --- a/interfaces/UseFormOptions.html +++ b/interfaces/UseFormOptions.html @@ -30,7 +30,7 @@
    • UseFormOptions
    +
  • Defined in types.ts:8
    • @@ -60,7 +60,7 @@

    See

    validate for manual validation trigger

    +
  • Defined in types.ts:44

    • Optional errorMessages

    errorMessages?: Partial<ErrorStrings>
    @@ -76,7 +76,7 @@
    +
  • Defined in types.ts:29

    • Optional initialState

    initialState?: Partial<T>
    @@ -84,7 +84,7 @@ Any missing field will be empty.

    +
  • Defined in types.ts:13

    • Methods

    @@ -103,7 +103,7 @@ Any missing field will be empty.

    e: FormEvent<HTMLFormElement>

    Returns void

    +
  • Defined in types.ts:18
    • diff --git a/interfaces/UseFormReturn.html b/interfaces/UseFormReturn.html index aac4031..0c0a86c 100644 --- a/interfaces/UseFormReturn.html +++ b/interfaces/UseFormReturn.html @@ -28,7 +28,7 @@
    • UseFormReturn
    +
  • Defined in types.ts:50
    • @@ -36,7 +36,8 @@

    Properties

    -
    errors +
    dirty +errors isValid rawState state @@ -51,8 +52,16 @@

    Properties

    +
    +

    dirty

    +
    dirty: Partial<Record<keyof T, boolean>>
    +

    A mapping of all the fields that have been modified by the user.

    +

    If a field is dirty, its key will be true in this object.

    +
    -

    errors

    +

    errors

    errors: Partial<Record<keyof T, ErrorMessage>>

    A mapping of the error messages given for each field. Each property is the name of the field and the value is the error message, if any.

    @@ -61,28 +70,28 @@ Each property is the name of the field and the value is the error message, if an

    See

    ErrorMessage

    +
  • Defined in types.ts:72

    • isValid

    isValid: boolean

    Indicates whether the form is valid.

    +
  • Defined in types.ts:94

    • rawState

    -
    rawState: Partial<Record<keyof T, string | number | string[]>>
    +
    rawState: Partial<Record<keyof T, unknown>>

    The current form data, before parsing.

    +
  • Defined in types.ts:82

    • state

    state: Partial<T>

    The current form data, after parsing.

    +
  • Defined in types.ts:77

    • Methods

    @@ -121,7 +130,7 @@ See each of the options for more information.

    Returns FieldReturn<E>

    +
  • Defined in types.ts:62

    • handleSubmit

    Returns void

    +
  • Defined in types.ts:102

    • setValue

    Returns void

    +
  • Defined in types.ts:119

    • setValues

    Returns void

    +
  • Defined in types.ts:110

    • validate

    +
  • Defined in types.ts:128
    • @@ -230,6 +239,7 @@ You should inject this into the form's onSubmit prop.

    Type Aliases

    -
    MessageResolver +
    InputType +MessageResolver Validator
    @@ -65,6 +66,7 @@
  • FieldOptions
  • UseFormOptions
  • UseFormReturn
    • +
  • InputType
  • MessageResolver
  • Validator
  • useForm
    • diff --git a/modules/validator.html b/modules/validator.html index ef34637..029ffbd 100644 --- a/modules/validator.html +++ b/modules/validator.html @@ -16,7 +16,7 @@
  • validator

    • Namespace validator

    +
  • Defined in validators.ts:1

    • Index

    diff --git a/types/InputType.html b/types/InputType.html new file mode 100644 index 0000000..72c210c --- /dev/null +++ b/types/InputType.html @@ -0,0 +1,56 @@ +InputType | formplex-react
    +
    + +
    +
    +
    +
    + +

    Type alias InputType

    +
    InputType: unknown
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/types/MessageResolver.html b/types/MessageResolver.html index 3e46c9d..09e0548 100644 --- a/types/MessageResolver.html +++ b/types/MessageResolver.html @@ -42,7 +42,7 @@ and returns the error message for the field.

    Returns string

    +
  • Defined in types.ts:285
    • @@ -72,7 +72,8 @@ and returns the error message for the field.

  • FieldOptions
  • UseFormOptions
  • UseFormReturn
    • -
  • MessageResolver
    • +
  • InputType
    • +
  • MessageResolver
  • Validator
  • useForm
    • diff --git a/types/Validator-1.html b/types/Validator-1.html index 666ff71..2ca4b3e 100644 --- a/types/Validator-1.html +++ b/types/Validator-1.html @@ -39,7 +39,7 @@
    value: T

    Returns string | undefined | null

    +
  • Defined in types.ts:276
    • @@ -69,7 +69,8 @@
  • FieldOptions
  • UseFormOptions
  • UseFormReturn
    • -
  • MessageResolver
    • +
  • InputType
    • +
  • MessageResolver
  • Validator
  • useForm