@bigbinary/neeto-fields-frontend 1.3.9 → 1.3.10

package/README.md

@@ -18,6 +18,7 @@ referred as custom fields) for the resources across neeto products.
     - [FieldsPane](#2-fieldspane)
     - [FieldValuesContainer](#3-fieldvaluescontainer)
     - [FieldInputs](#4-fieldinputs)
+    - [InlineFieldValueInputProps](#5-inlinefieldvalueinput)
   - [Functions](#functions)
     - [mergeInitialValues](#1-neetofieldsutilsmergeinitialvalues)
     - [transformValues](#2-neetofieldsutilstransformvalues)
@@ -478,6 +479,46 @@ const HostForm = () => {
 };
 ```
 
+### 5. `InlineFieldValueInput`
+
+The InlineFieldValueInput component render the field value input UI. It accepts
+the following props:
+
+#### Props:
+
+1. `fields`: An array of all the fetched fields.
+2. `fieldValues`: Field values associated with the resource.
+3. `resourceType`: The type of resource.
+4. `resourceId`: The ID of the resource.
+5. `ownerId`: The ID of the owner in case the owner is not an organization.
+6. `onMutationSuccess`: The callback function which is triggered on the success
+   of mutation functions of field value.
+
+#### Usage:
+
+Usually this is used as a component for inline editing of field values in
+tables. The example shows one such usage of building the `columnData` for table
+with inline editable field value inputs in cell.
+
+```jsx
+const buildColumnDataForFields = (fields, onFieldValueUpdateSuccess) =>
+  fields.map(field => ({
+    dataIndex: "field.id",
+    key: field.id,
+    title: field.name,
+    width: 250,
+    render: (_, user) => (
+      <InlineFieldValueInput
+        {...{ field }}
+        fieldValues={user.fieldValues}
+        resourceId={user.id}
+        resourceType="users"
+        onMutationSuccess={onFieldValueUpdateSuccess}
+      />
+    ),
+  }));
+```
+
 ## Functions
 
 The package exports the `neetoFieldsUtils`, which contains two utility
@@ -640,9 +681,9 @@ In order to customize the engine's default behavior, we have several ways.
   `NeetoFieldsEngine::Fields::Customizable` or
   `NeetoFieldsEngine::FieldValues::Customizable` depending on the context.
 
-> _Eg: If you want to do something before the update action of `FieldsController`,
-> then define it in `before_update_process` method inside the
-> `NeetoFieldsEngine::Fields::Customizable` concern._
+> _Eg: If you want to do something before the update action of
+> `FieldsController`, then define it in `before_update_process` method inside
+> the `NeetoFieldsEngine::Fields::Customizable` concern._
 
 # Development instructions