@bigbinary/neeto-fields-frontend 1.3.21 → 1.3.23

package/README.md

@@ -520,6 +520,42 @@ const buildColumnDataForFields = (fields, onFieldValueUpdateSuccess) =>
   }));
 ```
 
+### 6. `FieldDeleteAlert`
+
+<div align="center">
+  <img src="https://github.com/bigbinary/neeto-fields-nano/assets/35305344/6518b206-58f3-4375-bc68-7134ad68c168" alt="Field delete alert" width="500"/>
+</div>
+
+The `FieldDeleteAlert` component handles delete operation on fields. It accepts the following props:
+
+#### Props:
+
+1. `selectedField`: The field that needs to be deleted.
+2. `ownerId`: The ID of the owner in case the owner is not an organization.
+3. `resourceTypeName`: The type of resource.
+4. `isDeleteAlertOpen`: Boolean state which specifies whether the alert is open.
+5. `isDeleting`: Boolean state indicating whether the field is being deleted.
+6. `handleDelete`: The callback function responsible for deleting the specified field.
+7. `handleAlertClose`: The callback function to be executed on closing the alert.
+
+#### Usage:
+
+```jsx
+import { FieldDeleteAlert } from "@biginary/neeto-fields-frontend";
+
+const [isDeleteAlertOpen, setIsDeleteAlertOpen] = useState(false);
+
+<FieldDeleteAlert
+  selectedField={field}
+  ownerId={formId}
+  resourceTypeName="submission"
+  isDeleteAlertOpen={isDeleteAlertOpen}
+  isDeleting={isDeleting}
+  handleDelete={handleDelete}
+  handleAlertClose={() => setIsDeleteAlertOpen(false)}
+/>;
+```
+
 ## Functions
 
 The package exports the `neetoFieldsUtils`, which contains two utility
@@ -722,6 +758,8 @@ https://www.youtube.com/watch?v=QBiYGP0Rhe0
     ```shell
     yarn release
     ```
+### Instructions for development
+Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step instructions to develop the frontend package.
 
 ### Setup dummy host app