@commercetools-uikit/number-field 19.9.0 → 19.11.0

package/dist/commercetools-uikit-number-field.cjs.dev.js

@@ -241,7 +241,7 @@ NumberField.propTypes = process.env.NODE_ENV !== "production" ? {
 var NumberField$1 = NumberField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 exports["default"] = NumberField$1;
 exports.version = version;

package/dist/commercetools-uikit-number-field.cjs.prod.js

@@ -210,7 +210,7 @@ NumberField.propTypes = {};
 var NumberField$1 = NumberField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 exports["default"] = NumberField$1;
 exports.version = version;

package/dist/commercetools-uikit-number-field.esm.js

@@ -216,6 +216,6 @@ NumberField.propTypes = process.env.NODE_ENV !== "production" ? {
 var NumberField$1 = NumberField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 export { NumberField$1 as default, version };

package/dist/declarations/src/number-field.d.ts

@@ -6,32 +6,127 @@ type TCustomFormErrors<Values> = {
     [K in keyof Values]?: TFieldErrors;
 };
 export type TNumberFieldProps = {
+    /**
+     * Used as HTML id property. An id is auto-generated when it is not specified.
+     */
     id?: string;
+    /**
+     * Horizontal size limit of the input fields.
+     */
     horizontalConstraint?: 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
+    /**
+     * A map of errors. Error messages for known errors are rendered automatically.
+     * <br />
+     * Unknown errors will be forwarded to `renderError`
+     */
     errors?: TFieldErrors;
+    /**
+     * A map of warnings. Warning messages for known warnings are rendered automatically.
+     * <br/>
+     * Unknown warnings will be forwarded to renderWarning.
+     */
     warnings?: TFieldWarnings;
+    /**
+     * Called with custom errors. This function can return a message which will be wrapped in an ErrorMessage. It can also return null to show no error.
+     */
     renderError?: TErrorRenderer;
+    /**
+     * Called with custom warnings, as renderWarning(key, warning). This function can return a message which will be wrapped in a WarningMessage.
+     * <br />
+     * It can also return null to show no warning.
+     */
     renderWarning?: (key: string, warning?: boolean) => ReactNode;
+    /**
+     * Indicates if the value is required. Shows an the "required asterisk" if so.
+     */
     isRequired?: boolean;
+    /**
+     * Indicates whether the field was touched. Errors will only be shown when the field was touched.
+     */
     touched?: boolean;
+    /**
+     * Used as HTML name of the input component. property
+     */
     name?: string;
+    /**
+     * Value of the input component.
+     */
     value: string | number;
+    /**
+     * Used as HTML `autocomplete` of the input component. property
+     */
     autoComplete?: string;
+    /**
+     * Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value.
+     */
     onChange?: ChangeEventHandler<HTMLInputElement>;
+    /**
+     * Called when input is blurred
+     */
     onBlur?: FocusEventHandler<HTMLInputElement>;
+    /**
+     * Called when input is focused
+     */
     onFocus?: FocusEventHandler<HTMLInputElement>;
+    /**
+     * Focus the input on initial render
+     */
     isAutofocussed?: boolean;
+    /**
+     * Indicates that the input cannot be modified (e.g not authorized, or changes currently saving).
+     */
     isDisabled?: boolean;
+    /**
+     * Indicates that the field is displaying read-only content
+     */
     isReadOnly?: boolean;
+    /**
+     * Placeholder text for the input
+     */
     placeholder?: string;
+    /**
+     * Value is used as `min` property on input field
+     */
     min?: number;
+    /**
+     * Value is used as `max` property on input field
+     */
     max?: number;
+    /**
+     * Value is used as `step` property on input field.
+     * <br />
+     * Use the value `any` for inputs which accept an unpredictable amount of decimals.
+     */
     step?: number | 'any';
+    /**
+     * Title of the label
+     */
     title: string | ReactNode;
+    /**
+     * Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas `description` can describe it in more depth. Can also receive a `hintIcon`.
+     */
     hint?: string | ReactNode;
+    /**
+     * Provides a description for the title.
+     */
     description?: string | ReactNode;
+    /**
+     * Function called when info button is pressed.
+     * <br />
+     * Info button will only be visible when this prop is passed.
+     */
     onInfoButtonClick?: (event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>) => void;
+    /**
+     * Icon to be displayed beside the hint text.
+     * <br />
+     * Will only get rendered when `hint` is passed as well.
+     */
     hintIcon?: ReactElement;
+    /**
+     * Badge to be displayed beside the label.
+     * <br />
+     * Might be used to display additional information about the content of the field (E.g verified email)
+     */
     badge?: ReactNode;
 };
 type TNumberFieldState = Pick<TNumberFieldProps, 'id'>;
@@ -44,6 +139,11 @@ declare class NumberField extends Component<TNumberFieldProps, TNumberFieldState
     static getDerivedStateFromProps: (props: TNumberFieldProps, state: TNumberFieldState) => {
         id: string;
     };
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
     static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     renderError(key?: string): ReactNode | null;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/number-field",
   "description": "A controlled input component for numbers with validation states and a label.",
-  "version": "19.9.0",
+  "version": "19.11.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,14 +21,14 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",
-    "@commercetools-uikit/constraints": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/field-errors": "19.9.0",
-    "@commercetools-uikit/field-label": "19.9.0",
-    "@commercetools-uikit/field-warnings": "19.9.0",
-    "@commercetools-uikit/number-input": "19.9.0",
-    "@commercetools-uikit/spacings-stack": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/constraints": "19.11.0",
+    "@commercetools-uikit/design-system": "19.11.0",
+    "@commercetools-uikit/field-errors": "19.11.0",
+    "@commercetools-uikit/field-label": "19.11.0",
+    "@commercetools-uikit/field-warnings": "19.11.0",
+    "@commercetools-uikit/number-input": "19.11.0",
+    "@commercetools-uikit/spacings-stack": "19.11.0",
+    "@commercetools-uikit/utils": "19.11.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "prop-types": "15.8.1",