Package org.patternfly.component.icon

Class Icon

java.lang.Object

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

org.patternfly.component.icon.Icon

All Implemented Interfaces:

Container<HTMLElement,Icon>, Finder<HTMLElement>, HasElement<HTMLElement,Icon>, HasHTMLElement<HTMLElement,Icon>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Icon>, Component, WithProgress<HTMLElement,Icon>, Modifiers.Inline<HTMLElement,Icon>

public class Icon
extends BaseComponent<HTMLElement,Icon>
implements Modifiers.Inline<HTMLElement,Icon>, WithProgress<HTMLElement,Icon>

An icon component is a container that allows for icons of varying dimensions, as well as spinners, to seamlessly replace each other without shifting surrounding content.

icon(check());
icon(filter())
        .size(lg);
icon(exclamationTriangle())
        .inline()
        .status(warning);

See Also:

• https://www.patternfly.org/components/icon

Method Summary

Modifier and Type	Method	Description
static Icon	icon(Element icon)	Factory method to create a new instance of this component.
static Icon	icon(PredefinedIcon icon)	Factory method to create a new instance of this component.
Icon	iconSize(Size iconSize)
Icon	progress(boolean inProgress, String label, Consumer<Spinner> spinnerConsumer)
Icon	size(Size size)	Modifies the size of this component.
Icon	status(Status status)
Icon	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.Container

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

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

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.style.Modifiers.Inline

inline, inline

Methods inherited from interface org.patternfly.component.WithProgress

inProgress, progress, progress, progress, startProgress, stopProgress, toggleProgress

Method Details

icon

public static Icon icon(PredefinedIcon icon)

Factory method to create a new instance of this component.

icon

public static Icon icon(Element icon)

Factory method to create a new instance of this component.

size

public Icon size(Size size)

Modifies the size of this component.

iconSize

public Icon iconSize(Size iconSize)

status

public Icon status(Status status)

progress

public Icon progress(boolean inProgress,
 String label,
 Consumer<Spinner> spinnerConsumer)

Specified by:

progress in interface WithProgress<HTMLElement,Icon>

that

public Icon that()

Specified by:

that in interface TypedBuilder<HTMLElement,Icon>