@bigbinary/neeto-form-frontend 1.0.21 → 1.0.23

package/README.md

@@ -156,6 +156,46 @@ const Component = () => {
 };
 ```
 
+`useForms` hook is used to fetch all the forms.
+
+`useForm` hook is used to fetch all details of a form.
+
+`useCreateForm` hooks is used to create a form.
+
+`useUpdateForm` hooks is used to update a form.
+
+`useDeleteForm` hooks is used to delete a form.
+
+The usage is as follows.
+
+
+```js
+import { useForm, useForm, useCreateForm, useUpdateForm, useDeleteForm  } from "@bigbinary/neeto-form-frontend";
+
+const Component = () => {
+  const { data: forms, isLoading } = useForms();
+  const { data: form, isLoading } = useForm({formId: "form-id"});
+
+  const { mutate: createForm, isLoading } = useCreateForm();
+  createForm(payload);
+
+  const { mutate: updateForm, isLoading } = useUpdateForm();
+  updateForm({id: "form-id", values: payload});
+
+  const { mutate: deleteForm, isLoading } = useDeleteForm();
+  deleteForm("form-id");
+
+  return <></>;
+};
+```
+
+ *`useCreate`, `useUpdate` & `useDelete` uses react-query's useMutation hook under the hood.*
+
+ *`useForm` & `useForms` uses react-query's useQuery hook under the hood.*
+
+*We can pass in extra options supported by react-query to these hooks.
+We can also destructure all react-query supported props from the response.*
+
 ## Development
 
 Install all the dependencies by executing the following command