Package org.patternfly.component.navigation

Class Navigation

java.lang.Object

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

org.patternfly.component.navigation.Navigation

All Implemented Interfaces:

Iterable<NavigationItem>, Attachable, Container<HTMLElement,Navigation>, Finder<HTMLElement>, HasElement<HTMLElement,Navigation>, HasHTMLElement<HTMLElement,Navigation>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Navigation>, Component, HasItems<HTMLElement,Navigation,NavigationItem>

public class Navigation
extends BaseComponent<HTMLElement,Navigation>
implements HasItems<HTMLElement,Navigation,NavigationItem>, Attachable

A navigation organizes an application's structure and content, making it easy to find information and accomplish tasks. Navigation communicates relationships, context, and actions a user can take within an application.

navigation(primary)
        .addItem(navigationItem("itm-1", "Item 1", "#itm-1"))
        .addItem(navigationItem("itm-2", "Item 2", "#itm-2"))
        .addItem(navigationItem("itm-3", "Item 3", "#itm-3"));

navigation(grouped)
        .addGroup(navigationGroup("grp-1", "Group 1")
                .addItem(navigationItem("grp-1-itm-1", "Item 1", "#grp-1-itm-1"))
                .addItem(navigationItem("grp-1-itm-2", "Item 2", "#grp-1-itm-2"))
                .addItem(navigationItem("grp-1-itm-3", "Item 3", "#grp-1-itm-3")))
        .addGroup(navigationGroup("grp-2", "Group 2")
                .addItem(navigationItem("grp-2-itm-1", "Item 1", "#grp-2-itm-1"))
                .addItem(navigationItem("grp-2-itm-2", "Item 2", "#grp-2-itm-2"))
                .addDivider()
                .addItem(navigationItem("grp-2-itm-3", "Item 3", "#grp-2-itm-3")));

navigation(expandable)
        .addItem(navigationItem("itm-1", "Item 1", "#itm-1"))
        .addDivider()
        .addGroup(expandableNavigationGroup("grp-1", "Group 1")
                .addItem(navigationItem("grp-1-itm-1", "Item 1", "#grp-1-itm-1"))
                .addItem(navigationItem("grp-1-itm-2", "Item 2", "#grp-1-itm-2"))
                .addDivider()
                .addItem(navigationItem("grp-1-itm-3", "Item 3", "#grp-1-itm-3")))
        .addItem(navigationItem("itm-2", "Item 2", "#itm-2"))
        .addItem(navigationItem("itm-3", "Item 3", "#itm-3"))
        .addGroup(expandableNavigationGroup("grp-2", "Group 2")
                .addItem(navigationItem("grp-2-itm-1", "Item 1", "#grp-2-itm-1"))
                .addItem(navigationItem("grp-2-itm-2", "Item 2", "#grp-2-itm-2"))
                .addGroup(expandableNavigationGroup("nested-grp-1", "Nested Group")
                        .addItem(navigationItem("nested-grp-1-itm-1", "Item 1", "#nested-grp-1-itm-1"))
                        .addDivider()
                        .addItem(navigationItem("nested-grp-1-itm-2", "Item 2", "#nested-grp-1-itm-2"))));

See Also:

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

Method Summary

Modifier and Type	Method	Description
Navigation	add(Divider divider)
Navigation	add(ExpandableNavigationGroup group)
Navigation	add(NavigationGroup group)
Navigation	add(NavigationItem item)
Navigation	addDivider()
Navigation	addGroup(ExpandableNavigationGroup group)
Navigation	addGroup(NavigationGroup group)
Navigation	addItem(NavigationItem item)
<T> Navigation	addItems(Iterable<T> items, Function<T,NavigationItem> display)
Navigation	ariaScrollBackLabel(String label)	Aria-label for the back scroll button
Navigation	ariaScrollForwardLabel(String label)	Aria-label for the forward scroll button
void	attach(MutationRecord mutationRecord)
void	clear()
void	detach(MutationRecord mutationRecord)
Navigation	insertGroupAfter(ExpandableNavigationGroup group, String afterIdentifier)
Navigation	insertGroupAfter(NavigationGroup group, String afterIdentifier)
Navigation	insertGroupBefore(ExpandableNavigationGroup group, String beforeIdentifier)
Navigation	insertGroupBefore(NavigationGroup group, String beforeIdentifier)
Navigation	insertItemAfter(NavigationItem item, String afterIdentifier)
Navigation	insertItemBefore(NavigationItem item, String beforeIdentifier)
boolean	isEmpty()
Iterator<NavigationItem>	iterator()
static Navigation	navigation(NavigationType type)
Navigation	onSelect(SelectHandler<NavigationItem> selectHandler)
Navigation	onToggle(ToggleHandler<ExpandableNavigationGroup> toggleHandler)
void	select(String itemId)
void	select(String itemId, boolean fireEvent)
void	select(NavigationItem item)
void	select(NavigationItem item, boolean fireEvent)
int	size()
Navigation	that()
Navigation	theme(Brightness theme)

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.patternfly.component.HasItems

items

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

navigation

public static Navigation navigation(NavigationType type)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addItems

public <T> Navigation addItems(Iterable<T> items,
 Function<T,NavigationItem> display)

Specified by:

addItems in interface HasItems<HTMLElement,Navigation,NavigationItem>

addItem

public Navigation addItem(NavigationItem item)

Specified by:

addItem in interface HasItems<HTMLElement,Navigation,NavigationItem>

add

public Navigation add(NavigationItem item)

Specified by:

add in interface HasItems<HTMLElement,Navigation,NavigationItem>

addGroup

public Navigation addGroup(NavigationGroup group)

add

public Navigation add(NavigationGroup group)

addGroup

public Navigation addGroup(ExpandableNavigationGroup group)

add

public Navigation add(ExpandableNavigationGroup group)

addDivider

public Navigation addDivider()

add

public Navigation add(Divider divider)

insertItemBefore

public Navigation insertItemBefore(NavigationItem item,
 String beforeIdentifier)

insertItemAfter

public Navigation insertItemAfter(NavigationItem item,
 String afterIdentifier)

insertGroupBefore

public Navigation insertGroupBefore(NavigationGroup group,
 String beforeIdentifier)

insertGroupAfter

public Navigation insertGroupAfter(NavigationGroup group,
 String afterIdentifier)

insertGroupBefore

public Navigation insertGroupBefore(ExpandableNavigationGroup group,
 String beforeIdentifier)

insertGroupAfter

public Navigation insertGroupAfter(ExpandableNavigationGroup group,
 String afterIdentifier)

theme

public Navigation theme(Brightness theme)

that

public Navigation that()

Specified by:

that in interface TypedBuilder<HTMLElement,Navigation>

ariaScrollBackLabel

public Navigation ariaScrollBackLabel(String label)

Aria-label for the back scroll button

ariaScrollForwardLabel

public Navigation ariaScrollForwardLabel(String label)

Aria-label for the forward scroll button

onSelect

public Navigation onSelect(SelectHandler<NavigationItem> selectHandler)

onToggle

public Navigation onToggle(ToggleHandler<ExpandableNavigationGroup> toggleHandler)

select

public void select(String itemId)

select

public void select(String itemId,
 boolean fireEvent)

select

public void select(NavigationItem item)

select

public void select(NavigationItem item,
 boolean fireEvent)

iterator

public Iterator<NavigationItem> iterator()

Specified by:

iterator in interface Iterable<NavigationItem>

size

public int size()

Specified by:

size in interface HasItems<HTMLElement,Navigation,NavigationItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement,Navigation,NavigationItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement,Navigation,NavigationItem>