1. Domino UI
  2. Components
  3. Boards Pro
Top Column List Docs

Boards

Base class for a board UI component that organizes draggable items into groups.

D

The type of data associated with items.

S

The category type that groups items.

C

The type of board group.

I

The type of board item.

B

The concrete board type.

Represents a board that organizes items into columns.

D

The type of data associated with board items.

S

The category type that groups items into columns.

Represents a board that organizes items into lists.

D

The type of data associated with board items.

S

The category type that groups items into lists.

Anatomy

boards-column-anatomy. boards-list-anatomy.
  1. Boards header which is a NavBar.
  2. Board group.
  3. Board group header.
  4. Board group item.

Examples

Columns board Kanban like board

List board Uses lists instead of columns

API Docs: BaseBoard

Constructors

public void BaseBoard(GroupFactory<C, S> groupFactory, ItemFactory<I, D> itemFactory)
Creates a new board instance.

groupFactory

Factory to create board groups.

itemFactory

Factory to create board items.

Public methods

public B appendChild(C boardColumn)
Appends a board group to the board.

boardColumn

The board group to add.



Returns:

This board instance.

public B withHeader()
Ensures the board has a header.

Returns:

This board instance.

public B withHeader(ChildHandler<B, NavBar> handler)
Adds a header with a custom handler.

handler

The handler to configure the header.



Returns:

This board instance.

public B withBody(ChildHandler<B, DivElement> handler)
Configures the board body with a custom handler.

handler

The handler to configure the body.



Returns:

This board instance.

public B addDndListener(BoardDndListener<C, I> listener)
Adds a drag-and-drop event listener.

listener

The listener to add.



Returns:

This board instance.

public B removeDndListener(BoardDndListener<C, I> listener)
Removes a drag-and-drop event listener.

listener

The listener to remove.



Returns:

This board instance.

public Set<C> getGroups()
Gets the board groups.

Returns:

A set of board groups.

public B addGroup(S category)
Adds a group to the board.

category

The category representing the group.



Returns:

This board instance.

public B addGroup(S[] categories)
Adds multiple groups to the board using the specified categories.

categories

The categories representing the groups to add.



Returns:

This board instance.

public B addGroup(Collection<S> categories)
Adds multiple groups to the board using the specified collection of categories.

categories

The collection of categories representing the groups to add.



Returns:

This board instance.

public B addItem(HasBoardCategory<D, S> item)
Adds an item to the board.

item

The item to add.



Returns:

This board instance.

public B addItem(HasBoardCategory [] items)
Adds multiple items to the board.

items

The items to add.



Returns:

This board instance.

public B addItem(Collection<HasBoardCategory<D, S>> items)
Adds multiple items to the board using the specified collection.

items

The collection of items to add.



Returns:

This board instance.

API Docs: ColumnsBoard

Constructors

public void ColumnsBoard(GroupFactory<BoardColumn<D, S>, S> groupFactory, ItemFactory<BoardCard<D>, D> itemFactory)
Creates a new columns board with the specified group and item factories.

groupFactory

Factory for creating board columns.

itemFactory

Factory for creating board cards.

Static methods

public static ColumnsBoard<D, S> create(GroupFactory<BoardColumn<D, S>, S> groupFactory, ItemFactory<BoardCard<D>, D> itemFactory)
Creates a new ColumnsBoard instance.

groupFactory

Factory for creating board columns.

itemFactory

Factory for creating board cards.

D

The type of data.

S

The category type.



Returns:

A new ColumnsBoard instance.

API Docs: ListsBoard

Constructors

public void ListsBoard(GroupFactory<BoardList<D, S>, S> groupFactory, ItemFactory<BoardListItem<D>, D> itemFactory)
Creates a new lists board with the specified group and item factories.

groupFactory

Factory for creating board lists.

itemFactory

Factory for creating board list items.

Static methods

public static ListsBoard<D, S> create(GroupFactory<BoardList<D, S>, S> groupFactory, ItemFactory<BoardListItem<D>, D> itemFactory)
Creates a new ListsBoard instance.

groupFactory

Factory for creating board lists.

itemFactory

Factory for creating board list items.

D

The type of data.

S

The category type.



Returns:

A new ListsBoard instance.

We are a group of passionate people who love what we do

Donate & Support Us