@react-fabric/form 1.0.0-beta.6 → 1.0.0-beta.60

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.
Files changed (187) hide show
  1. package/{src/input/ArrayInput.module.css → css/_arrayInput.css} +8 -8
  2. package/css/_colorPicker.css +65 -0
  3. package/{src/internal/Field.module.css → css/_field.css} +66 -30
  4. package/{src/input/File.module.css → css/_file.css} +21 -6
  5. package/css/styles.css +27 -0
  6. package/dist/cjs/builder/FileField.js +40 -28
  7. package/dist/cjs/builder/FormField.js +50 -34
  8. package/dist/cjs/builder/SchemaEditor.js +72 -0
  9. package/dist/cjs/builder/components/AddSchemaFields.js +62 -0
  10. package/dist/cjs/builder/components/SchemaArrayForm.js +145 -0
  11. package/dist/cjs/builder/components/SchemaField.js +414 -0
  12. package/dist/cjs/form/Controller.js +46 -1
  13. package/dist/cjs/form/Form.js +70 -9
  14. package/dist/cjs/hooks/useFileUploader.js +16 -0
  15. package/dist/cjs/hooks/useFormBuilder.js +57 -15
  16. package/dist/cjs/i18n/ar.json.js +5 -4
  17. package/dist/cjs/i18n/en.json.js +5 -5
  18. package/dist/cjs/index.js +12 -2
  19. package/dist/cjs/input/ArrayInput.js +126 -36
  20. package/dist/cjs/input/AvatarInput.js +43 -23
  21. package/dist/cjs/input/Checkbox.js +16 -6
  22. package/dist/cjs/input/ColorInput.js +113 -58
  23. package/dist/cjs/input/ColorPicker.js +60 -76
  24. package/dist/cjs/input/DateInput.js +197 -0
  25. package/dist/cjs/input/Field.js +10 -4
  26. package/dist/cjs/input/File.js +14 -7
  27. package/dist/cjs/input/Hidden.js +13 -2
  28. package/dist/cjs/input/Input.js +24 -10
  29. package/dist/cjs/input/Number.js +22 -10
  30. package/dist/cjs/input/Password.js +22 -12
  31. package/dist/cjs/input/Radio.js +12 -3
  32. package/dist/cjs/input/RadioGroup.js +10 -1
  33. package/dist/cjs/input/{Range.js → RangeSlider.js} +16 -8
  34. package/dist/cjs/input/Search.js +30 -19
  35. package/dist/cjs/input/Slider.js +12 -6
  36. package/dist/cjs/input/Switch.js +20 -9
  37. package/dist/cjs/input/Textarea.js +29 -8
  38. package/dist/cjs/internal/ErrorIcon.js +1 -1
  39. package/dist/cjs/internal/FieldWrapper.js +11 -4
  40. package/dist/cjs/internal/InputWrapper.js +27 -20
  41. package/dist/cjs/select/AutoComplete.js +21 -11
  42. package/dist/cjs/select/DualList.js +34 -12
  43. package/dist/cjs/select/List.js +68 -22
  44. package/dist/cjs/select/Options.js +49 -42
  45. package/dist/cjs/select/Select.js +40 -10
  46. package/dist/cjs/select/useSelect.js +22 -11
  47. package/dist/cjs/types/schema.js +43 -0
  48. package/dist/cjs/utils/eventHandlers.js +15 -5
  49. package/dist/esm/builder/FileField.js +42 -30
  50. package/dist/esm/builder/FormField.js +50 -34
  51. package/dist/esm/builder/SchemaEditor.js +72 -0
  52. package/dist/esm/builder/components/AddSchemaFields.js +62 -0
  53. package/dist/esm/builder/components/SchemaArrayForm.js +145 -0
  54. package/dist/esm/builder/components/SchemaField.js +414 -0
  55. package/dist/esm/form/Controller.js +46 -1
  56. package/dist/esm/form/Form.js +72 -12
  57. package/dist/esm/hooks/useFileUploader.js +16 -0
  58. package/dist/esm/hooks/useFormBuilder.js +55 -13
  59. package/dist/esm/i18n/ar.json.js +5 -4
  60. package/dist/esm/i18n/en.json.js +5 -5
  61. package/dist/esm/index.js +6 -2
  62. package/dist/esm/input/ArrayInput.js +126 -36
  63. package/dist/esm/input/AvatarInput.js +44 -24
  64. package/dist/esm/input/Checkbox.js +16 -6
  65. package/dist/esm/input/ColorInput.js +115 -60
  66. package/dist/esm/input/ColorPicker.js +60 -76
  67. package/dist/esm/input/DateInput.js +197 -0
  68. package/dist/esm/input/Field.js +11 -5
  69. package/dist/esm/input/File.js +16 -9
  70. package/dist/esm/input/Hidden.js +13 -2
  71. package/dist/esm/input/Input.js +26 -12
  72. package/dist/esm/input/Number.js +24 -12
  73. package/dist/esm/input/Password.js +24 -14
  74. package/dist/esm/input/Radio.js +12 -3
  75. package/dist/esm/input/RadioGroup.js +11 -2
  76. package/dist/esm/input/{Range.js → RangeSlider.js} +16 -8
  77. package/dist/esm/input/Search.js +32 -21
  78. package/dist/esm/input/Slider.js +12 -6
  79. package/dist/esm/input/Switch.js +20 -9
  80. package/dist/esm/input/Textarea.js +30 -9
  81. package/dist/esm/internal/ErrorIcon.js +1 -1
  82. package/dist/esm/internal/FieldWrapper.js +11 -4
  83. package/dist/esm/internal/InputWrapper.js +27 -20
  84. package/dist/esm/select/AutoComplete.js +21 -11
  85. package/dist/esm/select/DualList.js +34 -12
  86. package/dist/esm/select/List.js +69 -23
  87. package/dist/esm/select/Options.js +49 -42
  88. package/dist/esm/select/Select.js +40 -10
  89. package/dist/esm/select/useSelect.js +23 -12
  90. package/{src/input/ColorPicker.module.css → dist/esm/types/schema.js} +18 -27
  91. package/dist/esm/utils/eventHandlers.js +15 -5
  92. package/dist/types/builder/FileField.d.ts +4 -2
  93. package/dist/types/builder/FormField.d.ts +3 -1
  94. package/dist/types/builder/SchemaEditor.d.ts +9 -0
  95. package/dist/types/builder/components/AddSchemaFields.d.ts +2 -0
  96. package/dist/types/builder/components/SchemaArrayForm.d.ts +2 -0
  97. package/dist/types/builder/components/SchemaField.d.ts +10 -0
  98. package/dist/types/form/Controller.d.ts +47 -2
  99. package/dist/types/form/Form.d.ts +48 -2
  100. package/dist/types/hooks/useFileUploader.d.ts +16 -0
  101. package/dist/types/hooks/useFormBuilder.d.ts +32 -1
  102. package/dist/types/index.d.ts +6 -3
  103. package/dist/types/input/ArrayInput.d.ts +69 -12
  104. package/dist/types/input/AvatarInput.d.ts +23 -3
  105. package/dist/types/input/Checkbox.d.ts +13 -4
  106. package/dist/types/input/ColorInput.d.ts +15 -2
  107. package/dist/types/input/ColorPicker.d.ts +11 -1
  108. package/dist/types/input/DateInput.d.ts +28 -0
  109. package/dist/types/input/Field.d.ts +5 -1
  110. package/dist/types/input/File.d.ts +9 -0
  111. package/dist/types/input/Hidden.d.ts +13 -1
  112. package/dist/types/input/Input.d.ts +9 -1
  113. package/dist/types/input/Number.d.ts +9 -1
  114. package/dist/types/input/Password.d.ts +7 -1
  115. package/dist/types/input/Radio.d.ts +9 -1
  116. package/dist/types/input/RadioGroup.d.ts +8 -1
  117. package/dist/types/input/RangeSlider.d.ts +67 -0
  118. package/dist/types/input/Search.d.ts +14 -1
  119. package/dist/types/input/Slider.d.ts +8 -2
  120. package/dist/types/input/Switch.d.ts +10 -2
  121. package/dist/types/input/Textarea.d.ts +15 -1
  122. package/dist/types/internal/FieldWrapper.d.ts +1 -1
  123. package/dist/types/internal/InputWrapper.d.ts +1 -1
  124. package/dist/types/ranger/index.d.ts +2 -2
  125. package/dist/types/select/AutoComplete.d.ts +8 -1
  126. package/dist/types/select/DualList.d.ts +17 -2
  127. package/dist/types/select/List.d.ts +9 -1
  128. package/dist/types/select/Options.d.ts +4 -3
  129. package/dist/types/select/Select.d.ts +9 -1
  130. package/dist/types/select/useSelect.d.ts +10 -6
  131. package/dist/types/types/index.d.ts +34 -5
  132. package/dist/types/types/schema.d.ts +78 -33
  133. package/dist/types/utils/eventHandlers.d.ts +2 -2
  134. package/package.json +22 -20
  135. package/src/builder/FileField.tsx +62 -30
  136. package/src/builder/FormField.tsx +52 -32
  137. package/src/builder/SchemaEditor.tsx +79 -0
  138. package/src/builder/components/AddSchemaFields.tsx +74 -0
  139. package/src/builder/components/SchemaArrayForm.tsx +161 -0
  140. package/src/builder/components/SchemaField.tsx +436 -0
  141. package/src/form/Controller.tsx +48 -3
  142. package/src/form/Form.tsx +80 -8
  143. package/src/hooks/useFileUploader.ts +16 -0
  144. package/src/hooks/useFormBuilder.tsx +58 -15
  145. package/src/i18n/ar.json +5 -4
  146. package/src/i18n/en.json +5 -5
  147. package/src/index.ts +12 -3
  148. package/src/input/ArrayInput.tsx +199 -64
  149. package/src/input/AvatarInput.tsx +67 -19
  150. package/src/input/Checkbox.tsx +16 -6
  151. package/src/input/ColorInput.tsx +131 -71
  152. package/src/input/ColorPicker.tsx +54 -72
  153. package/src/input/DateInput.tsx +260 -0
  154. package/src/input/Field.tsx +15 -11
  155. package/src/input/File.tsx +16 -14
  156. package/src/input/Hidden.tsx +17 -2
  157. package/src/input/Input.tsx +27 -13
  158. package/src/input/Number.tsx +22 -13
  159. package/src/input/Password.tsx +24 -16
  160. package/src/input/Radio.tsx +12 -3
  161. package/src/input/RadioGroup.tsx +12 -3
  162. package/src/input/{Range.tsx → RangeSlider.tsx} +17 -9
  163. package/src/input/Search.tsx +33 -22
  164. package/src/input/Slider.tsx +20 -11
  165. package/src/input/Switch.tsx +17 -6
  166. package/src/input/Textarea.tsx +34 -9
  167. package/src/internal/ErrorIcon.tsx +1 -1
  168. package/src/internal/FieldWrapper.tsx +8 -4
  169. package/src/internal/InputWrapper.tsx +49 -27
  170. package/src/select/AutoComplete.tsx +14 -3
  171. package/src/select/DualList.tsx +31 -16
  172. package/src/select/List.tsx +52 -8
  173. package/src/select/Options.tsx +50 -46
  174. package/src/select/Select.tsx +25 -5
  175. package/src/select/useSelect.tsx +26 -9
  176. package/src/types/index.ts +37 -6
  177. package/src/types/schema.ts +96 -41
  178. package/src/utils/eventHandlers.ts +14 -4
  179. package/dist/cjs/input/ArrayInput.module.css +0 -1
  180. package/dist/cjs/input/ColorPicker.module.css +0 -1
  181. package/dist/cjs/input/File.module.css +0 -1
  182. package/dist/cjs/internal/Field.module.css +0 -1
  183. package/dist/esm/input/ArrayInput.module.css +0 -1
  184. package/dist/esm/input/ColorPicker.module.css +0 -1
  185. package/dist/esm/input/File.module.css +0 -1
  186. package/dist/esm/internal/Field.module.css +0 -1
  187. package/dist/types/input/Range.d.ts +0 -59
@@ -7,8 +7,9 @@ import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProper
7
7
  import _regeneratorRuntime from '@babel/runtime/regenerator';
8
8
  import { yupResolver } from '@hookform/resolvers/yup';
9
9
  import { useDebounce } from '@react-fabric/core';
10
+ import { EMPTY_OBJECT } from '@react-fabric/utilities';
10
11
  import { useRef, useTransition, useEffect, useCallback, useImperativeHandle } from 'react';
11
- import { useForm, FormProvider } from 'react-hook-form';
12
+ import { useForm as useForm$1, FormProvider, useFormContext, useWatch } from 'react-hook-form';
12
13
  import { jsx, jsxs } from 'react/jsx-runtime';
13
14
 
14
15
  var _excluded = ["formRef", "schema", "children", "defaultValues", "onSubmit", "onChange"];
@@ -17,17 +18,50 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
17
18
  var DEFAULT_SUBMIT = function DEFAULT_SUBMIT() {
18
19
  return undefined;
19
20
  };
21
+
22
+ /**
23
+ * Form component for managing form state and validation using react-hook-form and yup.
24
+ * It provides a simple interface for form handling, including submission, validation, and value management.
25
+ * It supports nested form structures and allows for custom validation schemas using Yup.
26
+ *
27
+ * @param {FormProps<K>} props - The properties for the Form component.
28
+ * @returns {JSX.Element} The rendered Form component.
29
+ *
30
+ * @example
31
+ * ```jsx
32
+ * <Form
33
+ * formRef={formRef}
34
+ * schema={yup.object().shape({
35
+ * name: yup.string().required("Name is required"),
36
+ * email: yup.string().email("Invalid email").required("Email is required"),
37
+ * })}
38
+ * defaultValues={{ name: "", email: "" }}
39
+ * onSubmit={(values) => {
40
+ * console.log("Form submitted with values:", values);
41
+ * }}
42
+ * >
43
+ * <input name="name" ref={form.register} placeholder="Name" />
44
+ * <input name="email" ref={form.register} placeholder="Email" />
45
+ * <button type="submit">Submit</button>
46
+ * </Form>
47
+ * ```
48
+ *
49
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/form-form--docs} for the properties that can be passed to this component.
50
+ * @see {@link https://react-hook-form.com/docs/useform} for more details on the properties.
51
+ * @see {@link https://github.com/jquense/yup} for more details on the Yup validation schema.
52
+ */
20
53
  var Form = function Form(_ref) {
21
54
  var formRef = _ref.formRef,
22
55
  schema = _ref.schema,
23
56
  children = _ref.children,
24
- defaultValues = _ref.defaultValues,
57
+ _ref$defaultValues = _ref.defaultValues,
58
+ defaultValues = _ref$defaultValues === void 0 ? EMPTY_OBJECT : _ref$defaultValues,
25
59
  _ref$onSubmit = _ref.onSubmit,
26
- onSubmit = _ref$onSubmit === void 0 ? DEFAULT_SUBMIT : _ref$onSubmit,
60
+ _onSubmit = _ref$onSubmit === void 0 ? DEFAULT_SUBMIT : _ref$onSubmit,
27
61
  onChange = _ref.onChange,
28
62
  rest = _objectWithoutProperties(_ref, _excluded);
29
63
  var ref = useRef(null);
30
- var form = useForm({
64
+ var form = useForm$1({
31
65
  shouldFocusError: true,
32
66
  resolver: schema && yupResolver(schema),
33
67
  defaultValues: defaultValues
@@ -35,7 +69,7 @@ var Form = function Form(_ref) {
35
69
  var _useTransition = useTransition(),
36
70
  _useTransition2 = _slicedToArray(_useTransition, 2),
37
71
  startTransition = _useTransition2[1];
38
- var changeHandler = useDebounce(onChange, [onChange]);
72
+ var changeHandler = useDebounce(onChange, [onChange], 300);
39
73
  useEffect(function () {
40
74
  var subscription = form.watch(function (value) {
41
75
  startTransition(function () {
@@ -63,15 +97,15 @@ var Form = function Form(_ref) {
63
97
  return handleReset();
64
98
  },
65
99
  submit: function submit() {
66
- return form.handleSubmit(onSubmit);
100
+ return form.handleSubmit(_onSubmit);
67
101
  },
68
102
  validate: function () {
69
- var _validate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
103
+ var _validate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(fields) {
70
104
  return _regeneratorRuntime.wrap(function _callee$(_context) {
71
105
  while (1) switch (_context.prev = _context.next) {
72
106
  case 0:
73
107
  _context.next = 2;
74
- return form.trigger();
108
+ return form.trigger(fields);
75
109
  case 2:
76
110
  return _context.abrupt("return", _context.sent);
77
111
  case 3:
@@ -80,7 +114,7 @@ var Form = function Form(_ref) {
80
114
  }
81
115
  }, _callee);
82
116
  }));
83
- function validate() {
117
+ function validate(_x) {
84
118
  return _validate.apply(this, arguments);
85
119
  }
86
120
  return validate;
@@ -102,7 +136,7 @@ var Form = function Form(_ref) {
102
136
  }, 50);
103
137
  }
104
138
  };
105
- }, [onSubmit, form, form.formState, defaultValues]);
139
+ }, [_onSubmit, form, form.formState, defaultValues]);
106
140
  var onInvalid = useCallback(function (_, e) {
107
141
  var el = e.target;
108
142
  setTimeout(function () {
@@ -116,7 +150,10 @@ var Form = function Form(_ref) {
116
150
  onReset: function onReset() {
117
151
  return handleReset(defaultValues);
118
152
  },
119
- onSubmit: form.handleSubmit(onSubmit, onInvalid),
153
+ onSubmit: function onSubmit(e) {
154
+ e.stopPropagation();
155
+ void form.handleSubmit(_onSubmit, onInvalid)(e);
156
+ },
120
157
  "data-loading": form.formState.isSubmitting,
121
158
  className: "contents",
122
159
  autoComplete: "off"
@@ -128,5 +165,28 @@ var Form = function Form(_ref) {
128
165
  }))
129
166
  }));
130
167
  };
168
+ var useForm = function useForm() {
169
+ var _useFormContext = useFormContext(),
170
+ formState = _useFormContext.formState,
171
+ getValues = _useFormContext.getValues,
172
+ setValue = _useFormContext.setValue,
173
+ watch = _useFormContext.watch,
174
+ reset = _useFormContext.reset,
175
+ resetField = _useFormContext.resetField,
176
+ setError = _useFormContext.setError,
177
+ setFocus = _useFormContext.setFocus;
178
+ var values = useWatch();
179
+ return {
180
+ values: _objectSpread(_objectSpread({}, values), getValues()),
181
+ formState: formState,
182
+ getValues: getValues,
183
+ setValue: setValue,
184
+ watch: watch,
185
+ reset: reset,
186
+ resetField: resetField,
187
+ setError: setError,
188
+ setFocus: setFocus
189
+ };
190
+ };
131
191
 
132
- export { Form };
192
+ export { Form, useForm };
@@ -12,6 +12,22 @@ var _excluded = ["progress", "abort"],
12
12
  _excluded2 = ["file", "progress", "abort"];
13
13
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
14
14
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
15
+ /**
16
+ * useFileUploader hook provides a way to handle file uploads
17
+ * with progress tracking, error handling, and file management.
18
+ * It uses a reducer to manage the state of uploaded files and their statuses.
19
+ *
20
+ * @param uploader - The function that handles the file upload.
21
+ * @param initialList - Initial list of files to be managed by the uploader.
22
+ * @param multiple - Whether to allow multiple file uploads or not.
23
+ * @returns An object containing methods to upload, remove, retry files,
24
+ * and the current state of the uploader including pending uploads and file list.
25
+ *
26
+ * @example
27
+ * ```jsx
28
+ * const { upload, remove, retry, state } = useFileUploader(uploader, initialList, multiple);
29
+ * ```
30
+ */
15
31
  var useFileUploader = function useFileUploader(uploader, initialList) {
16
32
  var multiple = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
17
33
  var _useReducer = useReducer(function (state, action) {
@@ -1,33 +1,42 @@
1
1
  'use client';
2
2
 
3
3
  import _defineProperty from '@babel/runtime/helpers/defineProperty';
4
+ import { EmptyContent } from '@react-fabric/core';
4
5
  import { yup, isNil, isEmpty } from '@react-fabric/utilities';
5
6
  import { useMemo, Fragment } from 'react';
6
7
  import { FormField } from '../builder/FormField.js';
7
- import { jsx } from 'react/jsx-runtime';
8
+ import { DATA_TYPES } from '../types/schema.js';
9
+ import { jsxs, jsx } from 'react/jsx-runtime';
8
10
 
9
11
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
10
12
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
11
13
  var makeYupField = function makeYupField(field) {
12
- var yupField = yup.string();
13
- if (field.datatype === "schema") {
14
+ var yupField = yup.string().trim();
15
+ if (field.datatype === DATA_TYPES.SCHEMA) {
14
16
  var child = Object.fromEntries(field.schema.map(function (field) {
15
17
  return [field.id, makeYupField(field)];
16
18
  }));
17
19
  yupField = yup.object(child);
18
20
  }
19
- if (field.datatype === "boolean") yupField = yup["boolean"]();
20
- if (field.datatype === "decimal" || field.datatype === "number" || field.datatype === "range") {
21
+ if (field.datatype === DATA_TYPES.BOOL) {
22
+ yupField = yup["boolean"]();
23
+ if (field.required) yupField = yupField.test({
24
+ test: function test(value) {
25
+ return !!value;
26
+ }
27
+ });
28
+ }
29
+ if (field.datatype === DATA_TYPES.NUMBER || field.datatype === DATA_TYPES.RANGE) {
21
30
  yupField = yup.number();
22
31
  !isNil(field.min) && (yupField = yupField.min(field.min));
23
32
  !isNil(field.max) && (yupField = yupField.max(field.max));
24
- if (field.datatype === "range") yupField = yup.array(yupField);
33
+ if (field.datatype === DATA_TYPES.RANGE) yupField = yup.array(yupField);
25
34
  }
26
- if (field.datatype === "string") {
27
- field.options && (yupField = yupField.oneOf(field.options));
35
+ if (field.datatype === DATA_TYPES.STRING) {
36
+ field.options && !field.allowCustom && (yupField = yupField.oneOf(field.options));
28
37
  field.regex && (yupField = yupField.matches(new RegExp(field.regex)));
29
38
  }
30
- if (field.datatype === "file") {
39
+ if (field.datatype === DATA_TYPES.FILE) {
31
40
  yupField = yup.object({
32
41
  filename: yup.string().required(),
33
42
  path: yup.string().required()
@@ -53,6 +62,36 @@ var makeYupField = function makeYupField(field) {
53
62
  }
54
63
  return yupField.label(field.label);
55
64
  };
65
+
66
+ /**
67
+ * useFormBuilder hook to create a form definition based on a schema.
68
+ * It generates a Yup validation schema and a form definition component.
69
+ *
70
+ * @param {FormSchema} schema - The schema defining the form fields.
71
+ * @param {Object} options - Optional parameters for the form builder.
72
+ * @returns An object containing the form definition and the Yup validation schema.
73
+ *
74
+ * @example
75
+ * ```jsx
76
+ * const { formDef, schemaDef } = useFormBuilder(schema, {
77
+ * prefix: "form",
78
+ * inline: true,
79
+ * fileUrl: (path) => `/files/${path}`,
80
+ * uploadHandler: async (file) => {
81
+ * // handle file upload
82
+ * },
83
+ * optionLists: {
84
+ * // define option lists for select fields
85
+ * }
86
+ * * });
87
+ * <FormBuilder
88
+ * schema={schemaDef}
89
+ * onSubmit={(data) => console.log(data)}
90
+ * >
91
+ * {formDef}
92
+ * </FormBuilder>
93
+ * ```
94
+ */
56
95
  var useFormBuilder = function useFormBuilder(schema) {
57
96
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
58
97
  var filteredSchema = useMemo(function () {
@@ -64,19 +103,22 @@ var useFormBuilder = function useFormBuilder(schema) {
64
103
  var schemaDef = yup.object(Object.fromEntries(filteredSchema.map(function (field) {
65
104
  return [field.id, makeYupField(field)];
66
105
  })));
67
- var formDef = /*#__PURE__*/jsx(Fragment, {
68
- children: filteredSchema.map(function (field, idx) {
106
+ var formDef = /*#__PURE__*/jsxs(Fragment, {
107
+ children: [filteredSchema.map(function (field, idx) {
69
108
  return /*#__PURE__*/jsx("div", {
70
109
  className: "mb-4",
71
- children: field.datatype === "schema" ? null : /*#__PURE__*/jsx(FormField, _objectSpread(_objectSpread({}, field), {}, {
110
+ children: field.datatype === DATA_TYPES.SCHEMA ? null : /*#__PURE__*/jsx(FormField, _objectSpread(_objectSpread({}, field), {}, {
72
111
  autoFocus: idx === 0,
73
112
  fileUrl: options.fileUrl,
113
+ optionLists: options.optionLists,
74
114
  uploadHandler: options.uploadHandler,
75
115
  inline: options.inline,
76
116
  prefix: options.prefix
77
117
  }))
78
118
  }, field.id);
79
- })
119
+ }), filteredSchema.length === 0 && /*#__PURE__*/jsx(EmptyContent, {
120
+ message: "No schema defined"
121
+ })]
80
122
  });
81
123
  return {
82
124
  formDef: formDef,
@@ -2,17 +2,18 @@
2
2
 
3
3
  var addArray = "اضافة عنصر";
4
4
  var password = {
5
- show: "عرض كلمة المرور",
6
- hide: "اخفاء كلمة المرور"
5
+ hide: "اخفاء كلمة المرور",
6
+ show: "عرض كلمة المرور"
7
7
  };
8
8
  var select = {
9
+ createOption: "إنشاء خيار جديد ل ",
9
10
  emptyList: "لا توجد خيارات متاحة",
10
- notFound: "لم يتم العثور على خيارات ل ",
11
- createOption: "إنشاء خيار جديد ل "
11
+ notFound: "لم يتم العثور على خيارات ل "
12
12
  };
13
13
  var yup = {
14
14
  arrayMax: "{{label}} حدد ما يصل {{max}} غرض",
15
15
  arrayMin: "{{label}} اختر على الأقل {{min}} غرض",
16
+ empty: "{{label}} يجب ألا يكون فارغًا",
16
17
  invalid: "{{label}} نوع بيانات غير صالح",
17
18
  invalidType: "{{label}} غير صالح",
18
19
  numberMax: "{{label}} الحد الأقصى {{max}}",
@@ -2,19 +2,19 @@
2
2
 
3
3
  var addArray = "Add Item";
4
4
  var password = {
5
- show: "Show password",
6
- hide: "Hide password"
5
+ hide: "Hide password",
6
+ show: "Show password"
7
7
  };
8
8
  var select = {
9
+ createOption: "Create new option for <0>{{query}}</0>",
9
10
  emptyList: "No options available",
10
- notFound: "No options found for <0>{{query}}</0>",
11
- createOption: "Create new option for <0>{{query}}</0>"
11
+ notFound: "No options found for <0>{{query}}</0>"
12
12
  };
13
13
  var yup = {
14
14
  arrayMax: "{{label}} must contain upto {{max}} item",
15
15
  arrayMin: "{{label}} must contain atleast {{min}} item",
16
- invalid: "{{label}} invalid",
17
16
  empty: "{{label}} must not be empty",
17
+ invalid: "{{label}} invalid",
18
18
  invalidType: "{{label}} invalid datatype",
19
19
  numberMax: "{{label}} maximum {{max}}",
20
20
  numberMin: "{{label}} minimum {{min}}",
package/dist/esm/index.js CHANGED
@@ -2,13 +2,17 @@
2
2
 
3
3
  import './i18n/index.js';
4
4
  export { Controller } from './form/Controller.js';
5
- export { Form } from './form/Form.js';
5
+ export { Form, useForm } from './form/Form.js';
6
+ export { SchemaEditor } from './builder/SchemaEditor.js';
6
7
  export { useFileUploader } from './hooks/useFileUploader.js';
7
8
  export { useFormBuilder } from './hooks/useFormBuilder.js';
9
+ export { DATA_TYPES, SCHEMA_CUSTOM_LIST } from './types/schema.js';
8
10
  export { ArrayInput } from './input/ArrayInput.js';
11
+ export { AvatarInput } from './input/AvatarInput.js';
9
12
  export { Checkbox } from './input/Checkbox.js';
10
13
  export { ColorInput } from './input/ColorInput.js';
11
14
  export { ColorPicker } from './input/ColorPicker.js';
15
+ export { DateInput } from './input/DateInput.js';
12
16
  export { Field } from './input/Field.js';
13
17
  export { FileInput } from './input/File.js';
14
18
  export { HiddenInput } from './input/Hidden.js';
@@ -17,7 +21,7 @@ export { Number } from './input/Number.js';
17
21
  export { Password } from './input/Password.js';
18
22
  export { Radio } from './input/Radio.js';
19
23
  export { RadioGroup } from './input/RadioGroup.js';
20
- export { Range } from './input/Range.js';
24
+ export { RangeSlider } from './input/RangeSlider.js';
21
25
  export { Search } from './input/Search.js';
22
26
  export { Slider } from './input/Slider.js';
23
27
  export { Switch } from './input/Switch.js';
@@ -1,33 +1,75 @@
1
1
  'use client';
2
2
 
3
3
  import _defineProperty from '@babel/runtime/helpers/defineProperty';
4
+ import _slicedToArray from '@babel/runtime/helpers/slicedToArray';
4
5
  import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
5
6
  import { DndContext } from '@dnd-kit/core';
6
7
  import { SortableContext, useSortable } from '@dnd-kit/sortable';
7
- import { Icon, CoreIcons, Button, Tooltip } from '@react-fabric/core';
8
- import { isString } from '@react-fabric/utilities';
8
+ import { Icon, CoreIcons, Tooltip, Button, cloneChildren } from '@react-fabric/core';
9
+ import { isFalse, isString } from '@react-fabric/utilities';
9
10
  import classNames from 'classnames';
10
- import { useMemo, useCallback, useImperativeHandle, Children, cloneElement } from 'react';
11
+ import { useState, useEffect, useMemo, useCallback, useImperativeHandle, cloneElement } from 'react';
11
12
  import { useFormContext, useFieldArray } from 'react-hook-form';
12
13
  import { useTranslation } from 'react-i18next';
13
14
  import { FieldWrapper } from '../internal/FieldWrapper.js';
14
- import classes from './ArrayInput.module.css';
15
15
  import { restrictToVerticalAxis } from '@dnd-kit/modifiers';
16
16
  import { CSS } from '@dnd-kit/utilities';
17
17
  import { jsx, jsxs } from 'react/jsx-runtime';
18
18
 
19
- var _excluded = ["name", "children", "addLabel", "fixedList", "focusName", "onAdd", "arrayRef", "enableSorting", "disabled", "readOnly", "minItems"];
19
+ var _excluded = ["name", "children", "addLabel", "focusName", "buttonPosition", "onAdd", "onRemove", "onBeforeRemove", "canRemove", "arrayRef", "enableSorting", "disabled", "readOnly", "minItems", "maxItems"];
20
20
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
21
21
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
22
+ /**
23
+ * ArrayInput component for managing an array of items in a form.
24
+ * It allows adding, removing, and sorting items within the array.
25
+ * It integrates with react-hook-form for form state management and validation.
26
+ * It supports fixed-length lists, custom add/remove handlers, and can display validation errors.
27
+ * It also provides options for inline display and custom button positioning.
28
+ *
29
+ * It uses the `useFieldArray` hook from `react-hook-form` to manage the array state and provides a simple interface for adding and removing items.
30
+ *
31
+ * It also supports drag-and-drop sorting using `@dnd-kit/core` and `@dnd-kit/sortable` for a better user experience when reordering items.
32
+ *
33
+ * @param {ArrayInputProps<T>} props - The properties for the ArrayInput component.
34
+ * @returns {JSX.Element} The rendered ArrayInput component.
35
+ *
36
+ * @example
37
+ * ```jsx
38
+ * <ArrayInput
39
+ * name="items"
40
+ * label="Items"
41
+ * addLabel="Add Item"
42
+ * onAdd={() => ({ name: "", value: "" })}
43
+ * onRemove={(item, index) => console.log("Removed item:", item, "at index:", index)}
44
+ * onBeforeRemove={(item, index) => confirm(`Are you sure you want to remove item at index ${index}?`)}
45
+ * canRemove={({ item, index, lastItem }) => !lastItem} // Prevent removing the last item
46
+ * >
47
+ * {({ index, name }) => (
48
+ * <Input
49
+ * name={name}
50
+ * label={`Item ${index + 1}`}
51
+ * placeholder="Enter item value"
52
+ * required={index === 0} // Make the first item required
53
+ * />
54
+ * )}
55
+ * </ArrayInput>
56
+ * ```
57
+ *
58
+ * @see {@link https://react-hook-form.com/api/usefieldarray} for more details on `useFieldArray`.
59
+ * @see {@link https://react-dnd.github.io/react-dnd/about} for more details on DnD context and sorting.
60
+ */
22
61
  var ArrayInput = function ArrayInput(_ref) {
23
- var _error$values$label, _error$values, _error$values2;
24
62
  var name = _ref.name,
25
63
  children = _ref.children,
26
64
  addLabel = _ref.addLabel,
27
- fixedList = _ref.fixedList,
28
65
  _ref$focusName = _ref.focusName,
29
66
  focusName = _ref$focusName === void 0 ? "" : _ref$focusName,
67
+ _ref$buttonPosition = _ref.buttonPosition,
68
+ buttonPosition = _ref$buttonPosition === void 0 ? "bottom" : _ref$buttonPosition,
30
69
  onAdd = _ref.onAdd,
70
+ onRemove = _ref.onRemove,
71
+ onBeforeRemove = _ref.onBeforeRemove,
72
+ canRemove = _ref.canRemove,
31
73
  arrayRef = _ref.arrayRef,
32
74
  enableSorting = _ref.enableSorting,
33
75
  _ref$disabled = _ref.disabled,
@@ -36,6 +78,8 @@ var ArrayInput = function ArrayInput(_ref) {
36
78
  readOnly = _ref$readOnly === void 0 ? false : _ref$readOnly,
37
79
  _ref$minItems = _ref.minItems,
38
80
  minItems = _ref$minItems === void 0 ? 0 : _ref$minItems,
81
+ _ref$maxItems = _ref.maxItems,
82
+ maxItems = _ref$maxItems === void 0 ? Number.MAX_SAFE_INTEGER : _ref$maxItems,
39
83
  rest = _objectWithoutProperties(_ref, _excluded);
40
84
  var _useTranslation = useTranslation("form"),
41
85
  t = _useTranslation.t;
@@ -43,34 +87,70 @@ var ArrayInput = function ArrayInput(_ref) {
43
87
  if (!(form !== null && form !== void 0 && form.control)) throw new Error("ArrayInput must be contained within a Form element");
44
88
  var _useFieldArray = useFieldArray({
45
89
  name: name,
90
+ keyName: "__ID__",
46
91
  control: form.control
47
92
  }),
48
93
  fields = _useFieldArray.fields,
49
94
  append = _useFieldArray.append,
50
95
  remove = _useFieldArray.remove,
51
96
  move = _useFieldArray.move;
97
+ var _useState = useState([]),
98
+ _useState2 = _slicedToArray(_useState, 2),
99
+ initialList = _useState2[0],
100
+ setInitialList = _useState2[1];
101
+ useEffect(function () {
102
+ setInitialList(fields.map(function (f) {
103
+ return f.__ID__;
104
+ }));
105
+ }, []);
52
106
  var error = useMemo(function () {
53
107
  var _form$formState$error, _form$formState$error2, _form$formState$error3;
54
108
  return (_form$formState$error = (_form$formState$error2 = form.formState.errors[name]) === null || _form$formState$error2 === void 0 ? void 0 : _form$formState$error2.message) !== null && _form$formState$error !== void 0 ? _form$formState$error : (_form$formState$error3 = form.formState.errors[name]) === null || _form$formState$error3 === void 0 || (_form$formState$error3 = _form$formState$error3.root) === null || _form$formState$error3 === void 0 ? void 0 : _form$formState$error3.message;
55
109
  }, [form.formState.errors]);
110
+ var removeCheck = useCallback(function (item, index) {
111
+ if (canRemove === false) return false;
112
+ if (canRemove === "newonly") {
113
+ return !initialList.includes(item.__ID__);
114
+ }
115
+ if (typeof canRemove === "function") {
116
+ return canRemove({
117
+ item: item,
118
+ index: index,
119
+ lastItem: index + 1 === fields.length
120
+ });
121
+ }
122
+ return true;
123
+ }, [canRemove, initialList, fields]);
56
124
  var handleAdd = useCallback(function (item) {
125
+ if (!item) return;
57
126
  append(item);
58
127
  setTimeout(function () {
59
128
  form.setFocus("".concat(name, ".").concat(fields.length).concat(focusName ? "." + focusName : ""));
60
129
  }, 100);
61
130
  }, [name, fields, focusName]);
131
+ var handleRemove = useCallback(function (item, index) {
132
+ var ret = onBeforeRemove === null || onBeforeRemove === void 0 ? void 0 : onBeforeRemove(item, index);
133
+ void Promise.resolve(ret).then(function (b) {
134
+ if (!isFalse(b)) {
135
+ remove(index);
136
+ onRemove === null || onRemove === void 0 || onRemove(item, index);
137
+ }
138
+ });
139
+ }, [remove, onRemove, onBeforeRemove]);
62
140
  useImperativeHandle(arrayRef, function () {
63
141
  return {
64
142
  addItem: handleAdd,
65
143
  removeItem: remove
66
144
  };
67
145
  });
68
- var Wrapper = useCallback(function (_ref2) {
146
+ var Wrapper = useCallback(
147
+ // eslint-disable-next-line @typescript-eslint/promise-function-async
148
+ function (_ref2) {
69
149
  var children = _ref2.children;
70
150
  if (enableSorting) {
71
151
  // pass id list to dnd context
72
152
  var idMap = fields.map(function (item) {
73
- return item.id;
153
+ return item.__ID__;
74
154
  });
75
155
  var handleDragEnd = function handleDragEnd(e) {
76
156
  if (e.over && e.active.id !== e.over.id) {
@@ -127,18 +207,47 @@ var ArrayInput = function ArrayInput(_ref) {
127
207
  }, [enableSorting]);
128
208
  // @ts-expect-error ignore
129
209
  SortableItem.displayName = "SortableItem";
210
+ var addButton = useMemo(function () {
211
+ var _error$values$label, _error$values, _error$values2;
212
+ return /*#__PURE__*/jsx("div", {
213
+ className: "flex justify-end",
214
+ children: /*#__PURE__*/jsx(Tooltip, {
215
+ color: "danger-200",
216
+ content: isString(error) ? "".concat(error) : t(error === null || error === void 0 ? void 0 : error.key, error !== null && error !== void 0 && error.values ? _objectSpread(_objectSpread({}, error === null || error === void 0 ? void 0 : error.values), {}, {
217
+ label: t((_error$values$label = (_error$values = error.values) === null || _error$values === void 0 ? void 0 : _error$values.label) !== null && _error$values$label !== void 0 ? _error$values$label : "form:badkey", (_error$values2 = error.values) === null || _error$values2 === void 0 ? void 0 : _error$values2.path)
218
+ }) : {}),
219
+ children: /*#__PURE__*/jsx(Button, {
220
+ size: "sm",
221
+ "aria-label": "Add item",
222
+ icon: CoreIcons.insert,
223
+ onClick: function onClick() {
224
+ return handleAdd(onAdd === null || onAdd === void 0 ? void 0 : onAdd());
225
+ },
226
+ "data-invalid": !!error,
227
+ disabled: !!disabled || readOnly || fields.length > maxItems,
228
+ className: classNames("fabric-addButton", canRemove !== false && "me-10"),
229
+ children: addLabel !== null && addLabel !== void 0 ? addLabel : t("form:addArray")
230
+ })
231
+ })
232
+ });
233
+ }, [error, fields, handleAdd, canRemove, disabled, readOnly, addLabel, maxItems]);
130
234
  return /*#__PURE__*/jsxs("div", {
131
- className: classes.arrayInput,
235
+ className: "fabric-arrayInput",
132
236
  children: [/*#__PURE__*/jsx(FieldWrapper, _objectSpread(_objectSpread({}, rest), {}, {
237
+ appendLabel: /*#__PURE__*/jsx("div", {
238
+ className: "-me-2",
239
+ children: onAdd && buttonPosition !== "bottom" && addButton
240
+ }),
133
241
  children: /*#__PURE__*/jsx(Wrapper, {
134
242
  children: fields.map(function (item, index) {
135
243
  return /*#__PURE__*/jsxs(SortableItem, {
136
- id: item.id,
244
+ id: item.__ID__,
137
245
  className: "flex items-center flex-nowrap gap-2 mb-1",
138
246
  children: [typeof children === "function" ? children({
139
247
  index: index,
248
+ item: item,
140
249
  name: "".concat(name, ".").concat(index)
141
- }) : Children.map(children, function (child) {
250
+ }) : cloneChildren(children, function (child) {
142
251
  return /*#__PURE__*/cloneElement(child, Object.assign({
143
252
  disabled: disabled,
144
253
  readOnly: readOnly,
@@ -149,40 +258,21 @@ var ArrayInput = function ArrayInput(_ref) {
149
258
  required: undefined,
150
259
  appendLabel: undefined
151
260
  }));
152
- }), !fixedList && /*#__PURE__*/jsx(Button, {
261
+ }), canRemove !== false && /*#__PURE__*/jsx(Button, {
153
262
  "aria-label": "Remove item",
154
263
  icon: CoreIcons.remove,
155
264
  color: "danger",
156
265
  variant: "link",
157
266
  className: "self-end",
158
- disabled: disabled || readOnly || fields.length <= minItems,
267
+ disabled: disabled || readOnly || fields.length <= minItems || !removeCheck(item, index),
159
268
  onClick: function onClick() {
160
- return remove(index);
269
+ return handleRemove(item, index);
161
270
  }
162
271
  })]
163
- }, item.id);
164
- })
165
- })
166
- })), !fixedList && onAdd && /*#__PURE__*/jsx("div", {
167
- className: "flex justify-end",
168
- children: /*#__PURE__*/jsx(Tooltip, {
169
- color: "danger",
170
- content: isString(error) ? "".concat(error) : t(error === null || error === void 0 ? void 0 : error.key, error !== null && error !== void 0 && error.values ? _objectSpread(_objectSpread({}, error === null || error === void 0 ? void 0 : error.values), {}, {
171
- label: t((_error$values$label = (_error$values = error.values) === null || _error$values === void 0 ? void 0 : _error$values.label) !== null && _error$values$label !== void 0 ? _error$values$label : "form:badkey", (_error$values2 = error.values) === null || _error$values2 === void 0 ? void 0 : _error$values2.path)
172
- }) : {}),
173
- children: /*#__PURE__*/jsx(Button, {
174
- "aria-label": "Add item",
175
- icon: CoreIcons.insert,
176
- onClick: function onClick() {
177
- return handleAdd(onAdd());
178
- },
179
- "data-invalid": !!error,
180
- disabled: !!disabled || readOnly,
181
- className: classNames(classes.addButton, "me-10"),
182
- children: addLabel !== null && addLabel !== void 0 ? addLabel : t("addArray")
272
+ }, item.__ID__);
183
273
  })
184
274
  })
185
- })]
275
+ })), onAdd && buttonPosition !== "top" && addButton]
186
276
  });
187
277
  };
188
278