Package com.vaadin.flow.component

Interface HasHelper

All Superinterfaces:
HasElement, Serializable
All Known Implementing Classes:
AbstractNumberField, BigDecimalField, CheckboxGroup, ComboBox, ComboBoxBase, CustomField, DatePicker, DateTimePicker, EmailField, IntegerField, MultiSelectComboBox, NumberField, PasswordField, RadioButtonGroup, Select, TextArea, TextField, TextFieldBase, TimePicker
public interface HasHelper extends HasElement
Mixin interface for field components that have helper text as property and slots for inserting components.

Root element should be a web component that uses slot for example in the following way: 


     <field-with-helper>
         <shadow-root>
             ...
             <slot name="helper"></slot>
             ...
         </shadow-root>
         <span slot="helper">${helperText}</span>
     </field-with-helper>
Since:
2.4
Author:
Vaadin Ltd

  • Method Summary

    Modifier and Type
    Method
    Description
    default Component
    getHelperComponent()
    Gets the component in the helper slot of this field.
    default String
    getHelperText()
    String used for the helper text.
    default void
    setHelperComponent(Component component)
    Adds the given component into helper slot of component, replacing any existing helper component.
    default void
    setHelperText(String helperText)
    String used for the helper text.

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

  • Method Details

    • getHelperText

      default String getHelperText()
      String used for the helper text.
      Returns:
      the helperText property from the web component

    • setHelperText

      default void setHelperText(String helperText)

      String used for the helper text. It shows a text adjacent to the field that can be used, e.g., to inform to the users which values it expects. Example: a text "The password must contain numbers" for the PasswordField.

      In case both setHelperText(String) and setHelperComponent(Component) are used, only the element defined by setHelperComponent(Component) will be visible, regardless of the order on which they are defined.

      Parameters:
      helperText - the String value to set

    • setHelperComponent

      default void setHelperComponent(Component component)
      Adds the given component into helper slot of component, replacing any existing helper component. It adds the component adjacent to the field that can be used, e.g., to inform to the users which values it expects. Example: a component that shows the password strength for the PasswordField.
      Parameters:
      component - the component to set, can be null to remove existing helper component
      See Also:

    • getHelperComponent

      default Component getHelperComponent()
      Gets the component in the helper slot of this field.
      Returns:
      the helper component of this field, or null if no helper component has been set
      See Also: