@commercetools-uikit/time-field 19.8.0 → 19.10.0

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

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

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

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

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

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

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

@@ -5,30 +5,118 @@ type TCustomFormErrors<Values> = {
     [K in keyof Values]?: TFieldErrors;
 };
 export type TTimeFieldProps = {
+    /**
+     * 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, as renderError(key, error). This function can return a message which will be wrapped in an ErrorMessage.
+     * <br />
+     * It can also return null to show no error.
+     */
     renderError?: (key: string, error?: boolean) => ReactNode;
+    /**
+     * 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.
+     */
     name?: string;
+    /**
+     * Used as HTML autocomplete of the input component.
+     */
     autoComplete?: string;
+    /**
+     * Value of the input
+     */
     value: string;
+    /**
+     * Called with an event holding the new 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 input is read only (no changes allowed).
+     */
     isReadOnly?: boolean;
+    /**
+     * Placeholder text for the input
+     */
     placeholder?: string;
+    /**
+     * Use this property to reduce the paddings of the component for a ui compact variant
+     */
     isCondensed?: boolean;
+    /**
+     * Title of the label
+     */
     title: 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?: ReactNode;
+    /**
+     * Provides a description for the title.
+     */
     description?: 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. 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 TTimeFieldState = Pick<TTimeFieldProps, 'id'>;
@@ -41,6 +129,11 @@ declare class TimeField extends Component<TTimeFieldProps, TTimeFieldState> {
     static getDerivedStateFromProps: (props: TTimeFieldProps, state: TTimeFieldState) => {
         id: string;
     };
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarily useful when using TypeScript.
+     */
     static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/time-field",
   "description": "A controlled date input component for single date.",
-  "version": "19.8.0",
+  "version": "19.10.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.8.0",
-    "@commercetools-uikit/design-system": "19.8.0",
-    "@commercetools-uikit/field-errors": "19.8.0",
-    "@commercetools-uikit/field-label": "19.8.0",
-    "@commercetools-uikit/field-warnings": "19.8.0",
-    "@commercetools-uikit/spacings-stack": "19.8.0",
-    "@commercetools-uikit/time-input": "19.8.0",
-    "@commercetools-uikit/utils": "19.8.0",
+    "@commercetools-uikit/constraints": "19.10.0",
+    "@commercetools-uikit/design-system": "19.10.0",
+    "@commercetools-uikit/field-errors": "19.10.0",
+    "@commercetools-uikit/field-label": "19.10.0",
+    "@commercetools-uikit/field-warnings": "19.10.0",
+    "@commercetools-uikit/spacings-stack": "19.10.0",
+    "@commercetools-uikit/time-input": "19.10.0",
+    "@commercetools-uikit/utils": "19.10.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "prop-types": "15.8.1",