SESL Material/com.google.android.material.navigation/NavigationBarView

NavigationBarView

abstract class NavigationBarView : FrameLayout

SESL Varaint Provides an abstract implementation of a navigation bar that can be used to implementation such as Bottom Navigation or Navigation rail.

Navigation bars make it easy for users to explore and switch between top-level views in a single tap.

The bar contents can be populated by specifying a menu resource file. Each menu item title, icon and enabled state will be used for displaying navigation bar items. Menu items can also be used for programmatically selecting which destination is currently active. It can be done using MenuItem#setChecked(true)

Inheritors

NavigationRailView

BottomNavigationView

Constructors

NavigationBarView

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, @AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int)

Types

LabelVisibility

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class LabelVisibility

Menu Label visibility mode enum for component provide an implementation of navigation bar view.

OnItemReselectedListener

interface OnItemReselectedListener

Listener for handling reselection events on navigation items.

OnItemSelectedListener

interface OnItemSelectedListener

Listener for handling selection events on navigation items.

Properties

itemRippleColor

@Nullable

@get:Nullable

open var itemRippleColor: ColorStateList

LABEL_VISIBILITY_AUTO

val LABEL_VISIBILITY_AUTO: Int = -1

Label behaves as "labeled" when there are 3 items or less, or "selected" when there are 4 items or more.

LABEL_VISIBILITY_LABELED

val LABEL_VISIBILITY_LABELED: Int = 1

Label is shown on all navigation items.

LABEL_VISIBILITY_SELECTED

val LABEL_VISIBILITY_SELECTED: Int = 0

Label is shown on the selected navigation item.

LABEL_VISIBILITY_UNLABELED

val LABEL_VISIBILITY_UNLABELED: Int = 2

Label is not shown on any navigation items.

presenter

@NonNull

@get:RestrictTo(value = LIBRARY_GROUP)

@get:NonNull

val presenter: NavigationBarPresenter

SESL_TYPE_ICON_LABEL

val SESL_TYPE_ICON_LABEL: Int = 1

SESL_TYPE_ICON_ONLY

val SESL_TYPE_ICON_ONLY: Int = 2

SESL_TYPE_LABEL_ONLY

val SESL_TYPE_LABEL_ONLY: Int = 3

Functions

getActiveIndicatorLabelPadding

@Px

open fun getActiveIndicatorLabelPadding(): Int

Get the distance between the active indicator container and the item's label.

getBadge

@Nullable

open fun getBadge(menuItemId: Int): BadgeDrawable

Returns an instance of BadgeDrawable associated with menuItemId, null if none was initialized.

getItemActiveIndicatorColor

@Nullable

open fun getItemActiveIndicatorColor(): ColorStateList

Get the color of the active indicator drawable.

getItemActiveIndicatorHeight

@Px

open fun getItemActiveIndicatorHeight(): Int

Get the width of an item's active indicator.

getItemActiveIndicatorMarginHorizontal

@Px

open fun getItemActiveIndicatorMarginHorizontal(): Int

Get the margin that will be maintained at the start and end of the active indicator away from the edges of its parent container.

getItemActiveIndicatorShapeAppearance

@Nullable

open fun getItemActiveIndicatorShapeAppearance(): ShapeAppearanceModel

Get the ShapeAppearanceModel of the active indicator drawable.

getItemActiveIndicatorWidth

@Px

open fun getItemActiveIndicatorWidth(): Int

Get the width of an item's active indicator.

getItemBackground

@Nullable

open fun getItemBackground(): Drawable

Returns the background drawable of the menu items.

getItemBackgroundResource

@DrawableRes

open fun ~~getItemBackgroundResource~~(): Int

Returns the background resource of the menu items.

getItemIconSize

@Dimension

open fun getItemIconSize(): Int

Returns the size provided for the menu item icons in pixels.

getItemIconTintList

@Nullable

open fun getItemIconTintList(): ColorStateList

Returns the tint which is applied to our menu items' icons.

getItemPaddingBottom

@Px

open fun getItemPaddingBottom(): Int

Get the distance from the bottom of an item's label to the bottom of the navigation bar item.

getItemPaddingTop

@Px

open fun getItemPaddingTop(): Int

Get the distance from the top of an item's icon/active indicator to the top of the navigation bar item.

getItemTextAppearanceActive

@StyleRes

open fun getItemTextAppearanceActive(): Int

Returns the text appearance used for the active menu item label.

getItemTextAppearanceInactive

@StyleRes

open fun getItemTextAppearanceInactive(): Int

Returns the text appearance used for inactive menu item labels.

getItemTextColor

@Nullable

open fun getItemTextColor(): ColorStateList

Returns colors used for the different states (normal, selected, focused, etc.) of the menu item text.

getLabelVisibilityMode

open fun getLabelVisibilityMode(): Int

Returns the current label visibility mode used by this NavigationBarView.

getMaxItemCount

abstract fun getMaxItemCount(): Int

Returns the maximum number of items that can be shown in NavigationBarView.

getMenu

@NonNull

open fun getMenu(): Menu

Returns the Menu instance associated with this navigation bar.

getMenuView

@RestrictTo(value = LIBRARY_GROUP)

@NonNull

open fun getMenuView(): MenuView

Returns the MenuView instance associated with this navigation bar.

getOrCreateBadge

@NonNull

open fun getOrCreateBadge(menuItemId: Int): BadgeDrawable

Creates an instance of BadgeDrawable associated with menuItemId if none exists.

getSelectedItemId

@IdRes

open fun getSelectedItemId(): Int

Returns the currently selected menu item ID, or zero if there is no menu.

inflateMenu

open fun inflateMenu(resId: Int)

Inflate a menu resource into this navigation view.

isItemActiveIndicatorEnabled

open fun isItemActiveIndicatorEnabled(): Boolean

Get whether or not a selected item should show an active indicator.

removeBadge

open fun removeBadge(menuItemId: Int)

Removes the BadgeDrawable associated with menuItemId.

seslGetLabelTextAppearance

@StyleRes

open fun seslGetLabelTextAppearance(): Int

seslGetOverflowMenu

open fun seslGetOverflowMenu(): MenuBuilder

seslHasOverflowButton

open fun seslHasOverflowButton(): Boolean

seslHideOverflowMenu

open fun seslHideOverflowMenu()

seslIsOverflowShowing

open fun seslIsOverflowShowing(): Boolean

seslSetGroupDividerEnabled

open fun seslSetGroupDividerEnabled(enabled: Boolean)

seslSetHasIcon

open fun ~~seslSetHasIcon~~(hasIcon: Boolean)

seslSetLabelTextAppearance

open fun seslSetLabelTextAppearance(@StyleRes textAppearanceRes: Int)

seslSetUpdateAnimation

open fun seslSetUpdateAnimation(enabled: Boolean)

seslSetViewType

open fun seslSetViewType(viewType: Int)

seslShowOverflowMenu

open fun seslShowOverflowMenu()

setActiveIndicatorLabelPadding

open fun setActiveIndicatorLabelPadding(@Px activeIndicatorLabelPadding: Int)

Set the distance between the active indicator container and the item's label.

setElevation

open fun setElevation(elevation: Float)

Sets the base elevation of this view, in pixels.

setItemActiveIndicatorColor

open fun setItemActiveIndicatorColor(@Nullable csl: ColorStateList)

Set the ColorStateList of the active indicator drawable.

setItemActiveIndicatorEnabled

open fun setItemActiveIndicatorEnabled(enabled: Boolean)

Set whether a selected item should show an active indicator.

setItemActiveIndicatorHeight

open fun setItemActiveIndicatorHeight(@Px height: Int)

Set the height of an item's active indicator.

setItemActiveIndicatorMarginHorizontal

open fun setItemActiveIndicatorMarginHorizontal(@Px horizontalMargin: Int)

Set the horizontal margin that will be maintained at the start and end of the active indicator, making sure the indicator remains the given distance from the edge of its parent container.

setItemActiveIndicatorShapeAppearance