@bigbinary/neeto-fields-frontend 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -10
- package/dist/index.cjs.js +208 -196
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.js +193 -181
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/types.d.ts +4 -0
package/README.md
CHANGED
|
@@ -300,25 +300,31 @@ specific resource.
|
|
|
300
300
|
1. `resourceType`: The type of resource.
|
|
301
301
|
2. `fieldValues`: Field values associated with the resource obtained from the
|
|
302
302
|
response.
|
|
303
|
-
3. `
|
|
304
|
-
|
|
303
|
+
3. `fields`: Fields associated with resource type. This is an optional prop. If
|
|
304
|
+
not provided the component will fetch the fields internally.
|
|
305
|
+
4. `resourceId`: The ID of the resource.
|
|
306
|
+
5. `ownerId`:The ID of the owner. This prop is required only if the owner is not
|
|
305
307
|
an organization.
|
|
306
|
-
|
|
308
|
+
6. `queryKeysToBeInvalidatedOnSuccess`: An array of queryKeys that should be
|
|
307
309
|
invalidated when changing the field value.
|
|
308
|
-
|
|
310
|
+
7. `customComponents`: If the host application has any extra `kind` other than
|
|
309
311
|
the supported ones, you can specify the component to be displayed
|
|
310
312
|
corresponding to that kind using this prop. It takes the `kind` name as the
|
|
311
313
|
key and the component rendering callback function as the value. The callback
|
|
312
314
|
function can expect the `field` object as argument.
|
|
313
|
-
|
|
314
|
-
|
|
315
|
+
8. `className`: Class names for styling.
|
|
316
|
+
9. `showBorder`: Boolean value to specify whether to show or hide borders.
|
|
315
317
|
Default true.
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
318
|
+
10. `formRefs`: A React Ref object that can be used to access the Formik context
|
|
319
|
+
of the forms corresponding to each field as key value pairs.
|
|
320
|
+
11. `disabled`: Boolean value to specify whether to disable all fields.
|
|
321
|
+
12. `isRequiredColumnName`: The name of column which holds the value which
|
|
320
322
|
suggests if a field value is a `required` one or not. Default is
|
|
321
323
|
`isRequired` column.
|
|
324
|
+
13. `fieldContainerClassName`: Class names for styling the `div` containing the
|
|
325
|
+
input field.
|
|
326
|
+
14. `fieldClassName`: Class names for styling the field.
|
|
327
|
+
15. `labelClassName`: Class names for styling the label for fields.
|
|
322
328
|
|
|
323
329
|
#### Usage:
|
|
324
330
|
|