woocommerce/plugins/woocommerce-blocks/packages/checkout/utils/validation/get-validity-message-for-in...

54 lines
1.4 KiB
TypeScript

/**
* External dependencies
*/
import { __, sprintf } from '@wordpress/i18n';
const defaultValidityMessage =
( label: string | undefined ) =>
( validity: ValidityState ): string | undefined => {
const fieldLabel = label
? label.toLowerCase()
: __( 'field', 'woocommerce' );
const invalidFieldMessage = sprintf(
/* translators: %s field label */
__( 'Please enter a valid %s', 'woocommerce' ),
fieldLabel
);
if (
validity.valueMissing ||
validity.badInput ||
validity.typeMismatch
) {
return invalidFieldMessage;
}
};
/**
* Converts an input's validityState to a string to display on the frontend.
*
* This returns custom messages for invalid/required fields. Other error types use defaults from the browser (these
* could be implemented in the future but are not currently used by the block checkout).
*/
const getValidityMessageForInput = (
label: string | undefined,
inputElement: HTMLInputElement,
customValidityMessage?: ( validity: ValidityState ) => string | undefined
): string => {
// No errors, or custom error - return early.
if ( inputElement.validity.valid || inputElement.validity.customError ) {
return inputElement.validationMessage;
}
const validityMessageCallback =
customValidityMessage || defaultValidityMessage( label );
return (
validityMessageCallback( inputElement.validity ) ||
inputElement.validationMessage
);
};
export default getValidityMessageForInput;