Package org.patternfly.component.help

Class HelperText

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement,HelperText>

org.patternfly.component.help.HelperText

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement,HelperText>, ElementClassListMethods<HTMLElement,HelperText>, ElementConsumerMethods<HTMLElement,HelperText>, ElementContainerMethods<HTMLElement,HelperText>, ElementEventMethods<HTMLElement,HelperText>, ElementIdMethods<HTMLElement,HelperText>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement,HelperText>, HTMLElementDataMethods<HTMLElement,HelperText>, HTMLElementStyleMethods<HTMLElement,HelperText>, HTMLElementVisibilityMethods<HTMLElement,HelperText>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,HelperText>, Component

public class HelperText
extends BaseComponent<HTMLElement,HelperText>

Helper text is an on-screen field guideline that helps provide context regarding field inputs.

See Also:

• https://www.patternfly.org/components/helper-text

Method Summary

Modifier and Type	Method	Description
HelperText	add(HelperTextItem item)
HelperText	addItem(HelperTextItem item)
HelperTextItem	firstItem()
static HelperText	helperText()
static HelperText	helperText(String text)	Shortcut for a helper text with one item helperText().addItem(helperTextItem(text))
static HelperText	helperText(String text, ValidationStatus status)	Shortcut for a helper text with one item helperText().addItem(helperTextItem(text, status))
static <E extends HTMLElement> HelperText	helperText(HTMLContainerBuilder<E> builder)
HelperText	liveRegion()	Flag for indicating whether the helper text container is a live region.
HelperText	that()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Method Details

helperText

public static HelperText helperText()

helperText

public static <E extends 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()