@trackunit/custom-field-components 1.12.0 → 1.12.2

package/index.cjs.js

@@ -129,10 +129,10 @@ const setupLibraryTranslations = () => {
 };
 
 /**
- * A component that can be used to render a boolean field
+ * A component that can be used to render a boolean field.
+ * See BooleanCustomFieldProps for prop documentation.
  *
- * @param options BooleanCustomFieldProps - options for the component
- * @returns {ReactElement }ReactElement - a component that can be used to render a boolean field
+ * @returns {ReactElement} A component that can be used to render a boolean field.
  */
 const BooleanCustomField = ({ defaultValue, "data-testid": dataTestId = "booleanField", onChange, value, id, setValue, register, validationRules, disabled = false, label, tip, isInvalid, errorMessage, helpAddon, maxLength, helpText, ...rest }) => {
     const initialValue = value !== undefined ? value : defaultValue ? defaultValue : false;
@@ -182,10 +182,10 @@ const convertToValueFormat = (value) => {
     return { label: value, value };
 };
 /**
- * A custom field that can be used to render a dropdown
+ * A custom field that can be used to render a dropdown.
+ * See DropdownCustomFieldProps for prop documentation.
  *
- * @param options DropdownCustomFieldProps - an object with all the props
- * @returns {ReactElement} - a dropdown component
+ * @returns {ReactElement} A dropdown component.
  */
 const DropdownCustomField = ({ defaultValue, "data-testid": dataTestId, onChange, onBlur, id, disabled = false, allValues, multiSelect = false, register, validationRules, setValue, label, tip, errorMessage, helpText, isInvalid = false, helpAddon, }) => {
     const renderAsInvalid = isInvalid || Boolean(errorMessage);

package/index.esm.js

@@ -127,10 +127,10 @@ const setupLibraryTranslations = () => {
 };
 
 /**
- * A component that can be used to render a boolean field
+ * A component that can be used to render a boolean field.
+ * See BooleanCustomFieldProps for prop documentation.
  *
- * @param options BooleanCustomFieldProps - options for the component
- * @returns {ReactElement }ReactElement - a component that can be used to render a boolean field
+ * @returns {ReactElement} A component that can be used to render a boolean field.
  */
 const BooleanCustomField = ({ defaultValue, "data-testid": dataTestId = "booleanField", onChange, value, id, setValue, register, validationRules, disabled = false, label, tip, isInvalid, errorMessage, helpAddon, maxLength, helpText, ...rest }) => {
     const initialValue = value !== undefined ? value : defaultValue ? defaultValue : false;
@@ -180,10 +180,10 @@ const convertToValueFormat = (value) => {
     return { label: value, value };
 };
 /**
- * A custom field that can be used to render a dropdown
+ * A custom field that can be used to render a dropdown.
+ * See DropdownCustomFieldProps for prop documentation.
  *
- * @param options DropdownCustomFieldProps - an object with all the props
- * @returns {ReactElement} - a dropdown component
+ * @returns {ReactElement} A dropdown component.
  */
 const DropdownCustomField = ({ defaultValue, "data-testid": dataTestId, onChange, onBlur, id, disabled = false, allValues, multiSelect = false, register, validationRules, setValue, label, tip, errorMessage, helpText, isInvalid = false, helpAddon, }) => {
     const renderAsInvalid = isInvalid || Boolean(errorMessage);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/custom-field-components",
-  "version": "1.12.0",
+  "version": "1.12.2",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,15 +10,15 @@
     "react": "19.0.0",
     "react-hook-form": "7.62.0",
     "react-select": "^5.10.2",
-    "@trackunit/react-form-components": "1.13.0",
-    "@trackunit/shared-utils": "1.13.19",
-    "@trackunit/custom-field-api": "1.12.0",
-    "@trackunit/iris-app-runtime-core": "1.13.0",
-    "@trackunit/react-components": "1.16.0",
-    "@trackunit/react-modal": "1.13.0",
-    "@trackunit/react-core-hooks": "1.12.0",
-    "@trackunit/i18n-library-translation": "1.12.0",
-    "@trackunit/iris-app-runtime-core-api": "1.12.0"
+    "@trackunit/react-form-components": "1.13.2",
+    "@trackunit/shared-utils": "1.13.21",
+    "@trackunit/custom-field-api": "1.12.2",
+    "@trackunit/iris-app-runtime-core": "1.13.2",
+    "@trackunit/react-components": "1.16.2",
+    "@trackunit/react-modal": "1.13.2",
+    "@trackunit/react-core-hooks": "1.12.2",
+    "@trackunit/i18n-library-translation": "1.12.2",
+    "@trackunit/iris-app-runtime-core-api": "1.12.2"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/BooleanCustomField.d.ts

@@ -72,9 +72,9 @@ export interface BooleanCustomFieldProps extends Omit<CheckboxProps, "value" | "
     errorMessage?: string;
 }
 /**
- * A component that can be used to render a boolean field
+ * A component that can be used to render a boolean field.
+ * See BooleanCustomFieldProps for prop documentation.
  *
- * @param options BooleanCustomFieldProps - options for the component
- * @returns {ReactElement }ReactElement - a component that can be used to render a boolean field
+ * @returns {ReactElement} A component that can be used to render a boolean field.
  */
 export declare const BooleanCustomField: ({ defaultValue, "data-testid": dataTestId, onChange, value, id, setValue, register, validationRules, disabled, label, tip, isInvalid, errorMessage, helpAddon, maxLength, helpText, ...rest }: BooleanCustomFieldProps) => ReactElement;

package/src/DropdownCustomField.d.ts

@@ -85,10 +85,10 @@ export interface DropdownCustomFieldProps extends FormGroupExposedProps {
 type OnChange = (event?: ChangeEvent<HTMLInputElement>) => void;
 type OnBlur = (event: FocusEvent<HTMLInputElement>) => void;
 /**
- * A custom field that can be used to render a dropdown
+ * A custom field that can be used to render a dropdown.
+ * See DropdownCustomFieldProps for prop documentation.
  *
- * @param options DropdownCustomFieldProps - an object with all the props
- * @returns {ReactElement} - a dropdown component
+ * @returns {ReactElement} A dropdown component.
  */
 export declare const DropdownCustomField: ({ defaultValue, "data-testid": dataTestId, onChange, onBlur, id, disabled, allValues, multiSelect, register, validationRules, setValue, label, tip, errorMessage, helpText, isInvalid, helpAddon, }: DropdownCustomFieldProps) => ReactElement;
 export {};