io.github.mmm.ui.api.widget.menu.UiNavigationBar Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-ui-api-menu Show documentation

API for menu widgets.

The newest version!

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.ui.api.widget.menu;

import io.github.mmm.ui.api.factory.UiWidgetFactoryNative;
import io.github.mmm.ui.api.widget.UiNativeWidget;
import io.github.mmm.ui.api.widget.UiRegularWidget;

/**
 * {@link UiAbstractMenuBar} that represents a vertical navigation bar. An example may look like this:

 * 
 * menuitem 1
 * 
menu 1

 * 
 * menuitem 2
 * 
menuitem 3
 * 
 * 
 *
 * @since 1.0.0
 */
public interface UiNavigationBar
    extends UiAbstractMenuBar, UiAbstractMenuWithItems, UiRegularWidget, UiNativeWidget {

  /** The {@link io.github.mmm.ui.api.datatype.UiStyles#add(String) style} or element name for this widget. */
  String STYLE = "ui-navbar";

  /**
   * @return the new {@link UiNavigationBar}.
   */
  static UiNavigationBar of() {

    return UiWidgetFactoryNative.get().create(UiNavigationBar.class);
  }
}