Package org.patternfly.component.help

Class HelperText

java.lang.Object

org.patternfly.component.BaseComponentFlat<elemental2.dom.HTMLElement,HelperText>

org.patternfly.component.help.HelperText

All Implemented Interfaces:

Finder<elemental2.dom.HTMLElement>, HasElement<elemental2.dom.HTMLElement,HelperText>, HasHTMLElement<elemental2.dom.HTMLElement,HelperText>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement,HelperText>, Component

public class HelperText
extends BaseComponentFlat<elemental2.dom.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 elemental2.dom.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.BaseComponentFlat

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.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, innerHtml, on, on, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

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()