@commercetools-uikit/password-field 19.8.0 → 19.10.0

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

@@ -197,7 +197,7 @@ PasswordField.toFieldErrors = function toFieldErrors(errors) {
 var PasswordField$1 = PasswordField;
 
 // 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"] = PasswordField$1;
 exports.version = version;

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

@@ -166,7 +166,7 @@ PasswordField.toFieldErrors = function toFieldErrors(errors) {
 var PasswordField$1 = PasswordField;
 
 // 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"] = PasswordField$1;
 exports.version = version;

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

@@ -171,6 +171,6 @@ PasswordField.toFieldErrors = function toFieldErrors(errors) {
 var PasswordField$1 = PasswordField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.8.0";
+var version = "19.10.0";
 
 export { PasswordField$1 as default, version };

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

@@ -6,36 +6,128 @@ type TCustomFormErrors<Values> = {
 };
 type TErrorRenderer = (key: string, error?: boolean) => ReactNode;
 export type TPasswordField = {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Password autocomplete mode
+     */
     autoComplete?: 'on' | 'off' | 'current-password' | 'new-password';
+    /**
+     * 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;
+    /**
+     * Determines whether to render the "Show/Hide" button for the password field.
+     */
     renderShowHideButton?: boolean;
 };
 declare const PasswordField: {
     (props: TPasswordField): import("@emotion/react/jsx-runtime").JSX.Element;
     displayName: string;
     defaultProps: Pick<TPasswordField, "horizontalConstraint" | "renderShowHideButton">;
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
     toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
 };
 export default PasswordField;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/password-field",
   "description": "A controlled text input component for passwords with validation states.",
-  "version": "19.8.0",
+  "version": "19.10.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,18 +21,18 @@
   "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/flat-button": "19.8.0",
-    "@commercetools-uikit/hooks": "19.8.0",
-    "@commercetools-uikit/icons": "19.8.0",
-    "@commercetools-uikit/password-input": "19.8.0",
-    "@commercetools-uikit/spacings-inline": "19.8.0",
-    "@commercetools-uikit/spacings-stack": "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/flat-button": "19.10.0",
+    "@commercetools-uikit/hooks": "19.10.0",
+    "@commercetools-uikit/icons": "19.10.0",
+    "@commercetools-uikit/password-input": "19.10.0",
+    "@commercetools-uikit/spacings-inline": "19.10.0",
+    "@commercetools-uikit/spacings-stack": "19.10.0",
+    "@commercetools-uikit/utils": "19.10.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "prop-types": "15.8.1"