@vaadin/field-base/src/validate-mixin.d.ts

Vaadin field base mixins

/**
 * @license
 * Copyright (c) 2021 - 2025 Vaadin Ltd.
 * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
 */
import type { Constructor } from '@open-wc/dedupe-mixin';

/**
 * A mixin to provide required state and validation logic.
 */
export declare function ValidateMixin<T extends Constructor<HTMLElement>>(base: T): Constructor<ValidateMixinClass> & T;

export declare class ValidateMixinClass {
  /**
   * Set to true when the field is invalid.
   */
  invalid: boolean;

  /**
   * Set to true to enable manual validation mode. This mode disables automatic
   * constraint validation, allowing you to control the validation process yourself.
   * You can still trigger constraint validation manually with the `validate()` method
   * or use `checkValidity()` to assess the component's validity without affecting
   * the invalid state. In manual validation mode, you can also manipulate
   * the `invalid` property directly through your application logic without conflicts
   * with the component's internal validation.
   *
   * @attr {boolean} manual-validation
   */
  manualValidation: boolean;

  /**
   * Specifies that the user must fill in a value.
   */
  required: boolean;

  /**
   * Returns true if field is valid, and sets `invalid` based on the field validity.
   */
  validate(): boolean;

  /**
   * Returns true if the field value satisfies all constraints (if any).
   */
  checkValidity(): boolean;

  protected _requestValidation(): void;
}