mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-16 03:31:45 +08:00
82 lines
3.1 KiB
TypeScript
82 lines
3.1 KiB
TypeScript
/**
|
|
* Contains the BottomNavigation class, which represents a tab navigation widget with static tabs at the bottom.
|
|
* @module "ui/tab-navigation/bottom-navigation"
|
|
*/ /** */
|
|
|
|
import { TabNavigationBase } from "../tab-navigation-base/tab-navigation-base";
|
|
import { TabContentItem } from "../tab-navigation-base/tab-content-item";
|
|
import { TabStrip } from "../tab-navigation-base/tab-strip";
|
|
import { Property, CoercibleProperty, EventData } from "../core/view";
|
|
|
|
export * from "../tab-navigation-base/tab-content-item";
|
|
export * from "../tab-navigation-base/tab-navigation-base";
|
|
export * from "../tab-navigation-base/tab-strip";
|
|
export * from "../tab-navigation-base/tab-strip-item";
|
|
|
|
/**
|
|
* Defines the data for the TabView.selectedIndexChanged event.
|
|
*/
|
|
export interface SelectedIndexChangedEventData extends EventData {
|
|
/**
|
|
* The old selected index.
|
|
*/
|
|
oldIndex: number;
|
|
|
|
/**
|
|
* The new selected index.
|
|
*/
|
|
newIndex: number;
|
|
}
|
|
|
|
/**
|
|
* Represents a tab navigation widget with static tabs at the bottom.
|
|
*/
|
|
export class BottomNavigation extends TabNavigationBase {
|
|
/**
|
|
* Gets or sets the items of the BottomNavigation.
|
|
*/
|
|
items: Array<TabContentItem>;
|
|
|
|
/**
|
|
* Gets or sets the tab strip of the BottomNavigation.
|
|
*/
|
|
tabStrip: TabStrip;
|
|
|
|
/**
|
|
* Gets or sets the selectedIndex of the BottomNavigation.
|
|
*/
|
|
selectedIndex: number;
|
|
|
|
/**
|
|
* Gets the native [android widget](http://developer.android.com/reference/android/support/v4/view/ViewPager.html) that represents the user interface for this component. Valid only when running on Android OS.
|
|
*/
|
|
android: any /* android.view.View */; //android.support.v4.view.ViewPager;
|
|
|
|
/**
|
|
* Gets the native iOS [UITabBarController](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITabBarController_Class/) that represents the user interface for this component. Valid only when running on iOS.
|
|
*/
|
|
ios: any /* UITabBarController */;
|
|
|
|
/**
|
|
* String value used when hooking to the selectedIndexChanged event.
|
|
*/
|
|
public static selectedIndexChangedEvent: string;
|
|
|
|
/**
|
|
* A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
|
|
* @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
|
|
* @param callback - Callback function which will be executed when event is raised.
|
|
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
|
|
*/
|
|
on(eventNames: string, callback: (data: EventData) => void, thisArg?: any);
|
|
|
|
/**
|
|
* Raised when the selected index changes.
|
|
*/
|
|
on(event: "selectedIndexChanged", callback: (args: SelectedIndexChangedEventData) => void, thisArg?: any);
|
|
}
|
|
|
|
export const itemsProperty: Property<BottomNavigation, TabContentItem[]>;
|
|
export const tabStripProperty: Property<BottomNavigation, TabStrip>
|
|
export const selectedIndexProperty: CoercibleProperty<BottomNavigation, number>;
|