@trackunit/react-form-components 1.13.0 → 1.13.1

package/index.cjs.js

@@ -374,8 +374,10 @@ const GenericActionsRenderer = ({ genericAction, disabled, fieldSize, innerRef,
  * If locked, a permission lacks but the input **can** sometimes be edited.
  * If disabled, the input **cannot** be edited and is only ever for displaying information.
  *
- * @param {LockedForReasons} props - The reasons for the disabled state.
- * @param {LockedKind} kind - The kind of disabled state. If locked, the input can sometimes be edited. If disabled, the input cannot be edited.
+ * @param props - The component props.
+ * @param props.kind - The kind of disabled state. If locked, the input can sometimes be edited. If disabled, the input cannot be edited.
+ * @param props.reasons - The reasons for the disabled state (optional).
+ * @returns {ReactElement} The tooltip icon component.
  */
 const InputLockReasonTooltip = ({ reasons, kind }) => {
     const [t] = useTranslation();
@@ -603,12 +605,9 @@ const getCountryAbbreviation = (callCode) => {
 const DEFAULT_COUNTRY_CODE = undefined;
 /**
  * A component for inputting phone numbers with an optional action button for initiating a phone call.
+ * See PhoneBaseInputProps for prop documentation.
  *
- * @param {string} [dataTestId] - The data test ID for the component.
- * @param {string|number} [value] - The value of the input field. The value should include the country code as well.
- * @param {boolean} [disabled=false] - Whether the component is disabled or not.
- * @param {string} [fieldSize="medium"] - The size of the input field.
- * @param {boolean} [disableAction=false] - Whether the action button is disabled or not.
+ * @returns {ReactElement} The phone input component.
  */
 const PhoneBaseInput = ({ "data-testid": dataTestId, isInvalid, disabled = false, value, defaultValue, fieldSize = "medium", disableAction = false, onChange, readOnly, onFocus, onBlur, name, ref, ...rest }) => {
     const [innerValue, setInnerValue] = react.useState(() => {

package/index.esm.js

@@ -373,8 +373,10 @@ const GenericActionsRenderer = ({ genericAction, disabled, fieldSize, innerRef,
  * If locked, a permission lacks but the input **can** sometimes be edited.
  * If disabled, the input **cannot** be edited and is only ever for displaying information.
  *
- * @param {LockedForReasons} props - The reasons for the disabled state.
- * @param {LockedKind} kind - The kind of disabled state. If locked, the input can sometimes be edited. If disabled, the input cannot be edited.
+ * @param props - The component props.
+ * @param props.kind - The kind of disabled state. If locked, the input can sometimes be edited. If disabled, the input cannot be edited.
+ * @param props.reasons - The reasons for the disabled state (optional).
+ * @returns {ReactElement} The tooltip icon component.
  */
 const InputLockReasonTooltip = ({ reasons, kind }) => {
     const [t] = useTranslation();
@@ -602,12 +604,9 @@ const getCountryAbbreviation = (callCode) => {
 const DEFAULT_COUNTRY_CODE = undefined;
 /**
  * A component for inputting phone numbers with an optional action button for initiating a phone call.
+ * See PhoneBaseInputProps for prop documentation.
  *
- * @param {string} [dataTestId] - The data test ID for the component.
- * @param {string|number} [value] - The value of the input field. The value should include the country code as well.
- * @param {boolean} [disabled=false] - Whether the component is disabled or not.
- * @param {string} [fieldSize="medium"] - The size of the input field.
- * @param {boolean} [disableAction=false] - Whether the action button is disabled or not.
+ * @returns {ReactElement} The phone input component.
  */
 const PhoneBaseInput = ({ "data-testid": dataTestId, isInvalid, disabled = false, value, defaultValue, fieldSize = "medium", disableAction = false, onChange, readOnly, onFocus, onBlur, name, ref, ...rest }) => {
     const [innerValue, setInnerValue] = useState(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-form-components",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -14,12 +14,12 @@
     "zod": "^3.23.8",
     "react-hook-form": "7.62.0",
     "tailwind-merge": "^2.0.0",
-    "@trackunit/css-class-variance-utilities": "1.11.19",
-    "@trackunit/react-components": "1.16.0",
-    "@trackunit/ui-icons": "1.11.18",
-    "@trackunit/shared-utils": "1.13.19",
-    "@trackunit/ui-design-tokens": "1.11.19",
-    "@trackunit/i18n-library-translation": "1.12.0",
+    "@trackunit/css-class-variance-utilities": "1.11.20",
+    "@trackunit/react-components": "1.16.1",
+    "@trackunit/ui-icons": "1.11.19",
+    "@trackunit/shared-utils": "1.13.20",
+    "@trackunit/ui-design-tokens": "1.11.20",
+    "@trackunit/i18n-library-translation": "1.12.1",
     "string-ts": "^2.0.0",
     "@js-temporal/polyfill": "^0.5.1",
     "es-toolkit": "^1.39.10",

package/src/components/BaseInput/InputLockReasonTooltip.d.ts

@@ -1,3 +1,4 @@
+import { ReactElement } from "react";
 type LockedKind = "locked" | "disabled";
 export type LockedForReasons = {
     kind: LockedKind;
@@ -8,8 +9,10 @@ export type LockedForReasons = {
  * If locked, a permission lacks but the input **can** sometimes be edited.
  * If disabled, the input **cannot** be edited and is only ever for displaying information.
  *
- * @param {LockedForReasons} props - The reasons for the disabled state.
- * @param {LockedKind} kind - The kind of disabled state. If locked, the input can sometimes be edited. If disabled, the input cannot be edited.
+ * @param props - The component props.
+ * @param props.kind - The kind of disabled state. If locked, the input can sometimes be edited. If disabled, the input cannot be edited.
+ * @param props.reasons - The reasons for the disabled state (optional).
+ * @returns {ReactElement} The tooltip icon component.
  */
-export declare const InputLockReasonTooltip: ({ reasons, kind }: LockedForReasons) => import("react/jsx-runtime").JSX.Element;
+export declare const InputLockReasonTooltip: ({ reasons, kind }: LockedForReasons) => ReactElement;
 export {};

package/src/components/PhoneField/PhoneBaseInput/PhoneBaseInput.d.ts

@@ -19,12 +19,9 @@ export interface PhoneBaseInputProps extends BaseInputExposedProps {
 }
 /**
  * A component for inputting phone numbers with an optional action button for initiating a phone call.
+ * See PhoneBaseInputProps for prop documentation.
  *
- * @param {string} [dataTestId] - The data test ID for the component.
- * @param {string|number} [value] - The value of the input field. The value should include the country code as well.
- * @param {boolean} [disabled=false] - Whether the component is disabled or not.
- * @param {string} [fieldSize="medium"] - The size of the input field.
- * @param {boolean} [disableAction=false] - Whether the action button is disabled or not.
+ * @returns {ReactElement} The phone input component.
  */
 export declare const PhoneBaseInput: ({ "data-testid": dataTestId, isInvalid, disabled, value, defaultValue, fieldSize, disableAction, onChange, readOnly, onFocus, onBlur, name, ref, ...rest }: PhoneBaseInputProps) => ReactElement;
 export {};