Class BottomNavigationBar

Hierarchy

BottomNavigationBarBase
- BottomNavigationBar

Indexable

[key: symbol]: (value: number) => void

Constructors

constructor

new BottomNavigationBar(): BottomNavigationBar
Returns BottomNavigationBar
Inherited from BottomNavigationBarBase.constructor
- Defined in node_modules/@nativescript/core/ui/core/view-base/index.d.ts:359

Properties

`Protected`_items

_items: BottomNavigationTabBase[]

activeColor

activeColor: Color

`Readonly`android

android: any

Gets the android-specific native instance that lies behind this proxy. Will be available if running on an Android platform.

autoClearBadge

autoClearBadge: Boolean

backgroundColor

backgroundColor: Color

Gets or sets the background color of the view.

Ns Property

badgeColor

badgeColor: Color

badgeTextColor

badgeTextColor: Color

dynamicElevationOffset

dynamicElevationOffset: number

@nativescript-community/ui-material-core installMixins.

Gets or sets the dynamic elevation offset of the view.

elevation

elevation: number

@nativescript-community/ui-material-core installMixins.

Gets or sets the elevation of the view.

inactiveColor

inactiveColor: Color

`Readonly`ios

ios: any

Gets the ios-specific native instance that lies behind this proxy. Will be available if running on an iOS platform.

`Readonly`items

items: BottomNavigationTab[]

rippleColor

rippleColor: Color

@nativescript-community/ui-material-core installMixins.

Gets or sets the ripple-color of the view.

rippleColorAlpha

rippleColorAlpha: number

@nativescript-community/ui-material-core installMixins.

Gets or sets the ripple-color alpha of the view.

selectedTabIndex

selectedTabIndex: number

titleVisibility

titleVisibility: TitleVisibility

`Static`tabPressedEvent

tabPressedEvent: string

`Static`tabReselectedEvent

tabReselectedEvent: string

`Static`tabSelectedEvent

tabSelectedEvent: string

Methods

_addChildFromBuilder

_addChildFromBuilder(name: string, value: BottomNavigationTabBase): void
Parameters
- name: string
- value: BottomNavigationTabBase
Returns void
Inherited from BottomNavigationBarBase._addChildFromBuilder
- Defined in packages/bottomnavigationbar/bottomnavigationbar-common.d.ts:64

_emitTabPressed

_emitTabPressed(index: number): void
Parameters
- index: number
Returns void
Inherited from BottomNavigationBarBase._emitTabPressed
- Defined in packages/bottomnavigationbar/bottomnavigationbar-common.d.ts:61

_emitTabReselected

_emitTabReselected(index: number): void
Parameters
- index: number
Returns void
Inherited from BottomNavigationBarBase._emitTabReselected
- Defined in packages/bottomnavigationbar/bottomnavigationbar-common.d.ts:63

_emitTabSelected

_emitTabSelected(index: number): void
Parameters
- index: number
Returns void
Inherited from BottomNavigationBarBase._emitTabSelected
- Defined in packages/bottomnavigationbar/bottomnavigationbar-common.d.ts:62

_getRootFragmentManager

_getRootFragmentManager(): FragmentManager
Returns FragmentManager
Inherited from BottomNavigationBarBase._getRootFragmentManager
- Defined in packages/core/index.d.ts:10

clearFocus

clearFocus(): void
Returns void
Inherited from BottomNavigationBarBase.clearFocus
- Defined in packages/core/index.d.ts:11

closeBottomSheet

closeBottomSheet(...args: any): void
Parameters
- ...args: any
Returns void
Inherited from BottomNavigationBarBase.closeBottomSheet
- Defined in packages/bottomsheet/bottomsheet.d.ts:83

`Protected`createTabs

createTabs(tabs?: BottomNavigationTab[]): void
Parameters
- Optionaltabs: BottomNavigationTab[]
Returns void
Overrides BottomNavigationBarBase.createTabs
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:37

on

on(
    event: "tabPressed",
    callback: (args: TabPressedEventData) => void,
    thisArg?: any,
): void
Adds a listener for the specified event name.
Parameters
- event: "tabPressed"
- callback: (args: TabPressedEventData) => void
  The event listener to add. Will be called when an event of the given name is raised.
- OptionalthisArg: any
  An optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound.
Returns void
Overrides BottomNavigationBarBase.on
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:28
on(
    event: "tabSelected",
    callback: (args: TabSelectedEventData) => void,
    thisArg?: any,
): void
Raised when a loaded event occurs.
Parameters
- event: "tabSelected"
- callback: (args: TabSelectedEventData) => void
- OptionalthisArg: any
Returns void
Overrides BottomNavigationBarBase.on
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:29
on(
    event: "tabReselected",
    callback: (args: TabReselectedEventData) => void,
    thisArg?: any,
): void
Raised when an unloaded event occurs.
Parameters
- event: "tabReselected"
- callback: (args: TabReselectedEventData) => void
- OptionalthisArg: any
Returns void
Overrides BottomNavigationBarBase.on
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:30

onLoaded

onLoaded(): void
Returns void
Inherited from BottomNavigationBarBase.onLoaded
- Defined in packages/bottomnavigationbar/bottomnavigationbar-common.d.ts:59

onSelectedTabIndexChanged

onSelectedTabIndexChanged(oldIndex: number, newIndex: number): void
Parameters
- oldIndex: number
- newIndex: number
Returns void
Inherited from BottomNavigationBarBase.onSelectedTabIndexChanged
- Defined in packages/bottomnavigationbar/bottomnavigationbar-common.d.ts:69

removeBadge

removeBadge(index: number): void
Parameters
- index: number
Returns void
Overrides BottomNavigationBarBase.removeBadge
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:27

requestFocus

requestFocus(): void
Returns void
Inherited from BottomNavigationBarBase.requestFocus
- Defined in packages/core/index.d.ts:12

selectTab

selectTab(index: number): void
Parameters
- index: number
Returns void
Overrides BottomNavigationBarBase.selectTab
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:25

`Protected`selectTabNative

selectTabNative(index: number): void
Parameters
- index: number
Returns void
Overrides BottomNavigationBarBase.selectTabNative
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:38

showBadge

showBadge(index: number, value?: number): void
Parameters
- index: number
- Optionalvalue: number
Returns void
Overrides BottomNavigationBarBase.showBadge
- Defined in packages/bottomnavigationbar/bottomnavigationbar.d.ts:26

showBottomSheet

showBottomSheet(options: BottomSheetOptions): ViewBase
Parameters
- options: BottomSheetOptions
Returns ViewBase
Inherited from BottomNavigationBarBase.showBottomSheet
- Defined in packages/bottomsheet/bottomsheet.d.ts:84

Class BottomNavigationBar

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BottomNavigationBar

Properties

Protected_items

activeColor

Readonlyandroid

autoClearBadge

backgroundColor

Ns Property

badgeColor

badgeTextColor

dynamicElevationOffset

elevation

inactiveColor

Readonlyios

Readonlyitems

rippleColor

rippleColorAlpha

selectedTabIndex

titleVisibility

StatictabPressedEvent

StatictabReselectedEvent

StatictabSelectedEvent

Methods

_addChildFromBuilder

Parameters

Returns void

_emitTabPressed

Parameters

Returns void

_emitTabReselected

Parameters

Returns void

_emitTabSelected

Parameters

Returns void

_getRootFragmentManager

Returns FragmentManager

clearFocus

Returns void

closeBottomSheet

Parameters

Returns void

ProtectedcreateTabs

Parameters

Returns void

on

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

onLoaded

Returns void

onSelectedTabIndexChanged

Parameters

Returns void

removeBadge

Parameters

Returns void

requestFocus

Returns void

selectTab

Parameters

Returns void

ProtectedselectTabNative

Parameters

Returns void

showBadge

Parameters

Returns void

`Protected`_items

`Readonly`android

`Readonly`ios

`Readonly`items

`Static`tabPressedEvent

`Static`tabReselectedEvent

`Static`tabSelectedEvent

`Protected`createTabs

`Protected`selectTabNative