Class HelperText

java.lang.Object
org.patternfly.component.BaseComponent<elemental2.dom.HTMLElement, HelperText>
org.patternfly.component.help.HelperText
All Implemented Interfaces:
ElementAttributeMethods<elemental2.dom.HTMLElement, HelperText>, ElementClassListMethods<elemental2.dom.HTMLElement, HelperText>, ElementConsumerMethods<elemental2.dom.HTMLElement, HelperText>, ElementContainerMethods<elemental2.dom.HTMLElement, HelperText>, ElementEventMethods<elemental2.dom.HTMLElement, HelperText>, ElementIdMethods<elemental2.dom.HTMLElement, HelperText>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, HelperText>, HTMLElementDataMethods<elemental2.dom.HTMLElement, HelperText>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, HelperText>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, HelperText>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, HelperText>, Component, OuiaSupport<elemental2.dom.HTMLElement, HelperText>

public class HelperText extends BaseComponent<elemental2.dom.HTMLElement, HelperText>
Helper text is an on-screen field guideline that helps provide context regarding field inputs.
See Also:
  • Method Details

    • helperText

      public static HelperText helperText()
    • helperText

      public static <E extends elemental2.dom.HTMLElement> HelperText helperText(HTMLContainerBuilder<E> builder)
    • helperText

      public static HelperText helperText(String text)
      Shortcut for a helper text with one item helperText().addItem(helperTextItem(text))
    • helperText

      public static HelperText helperText(String text, ValidationStatus status)
      Shortcut for a helper text with one item helperText().addItem(helperTextItem(text, status))
    • addItem

      public HelperText addItem(HelperTextItem item)
    • add

      public HelperText add(HelperTextItem item)
    • liveRegion

      public HelperText liveRegion()
      Flag for indicating whether the helper text container is a live region. Use this prop when you expect or intend for any helper text items within the container to be dynamically updated.
    • that

      public HelperText that()
    • firstItem

      public HelperTextItem firstItem()