mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-15 19:26:42 +08:00
108 lines
3.7 KiB
TypeScript
108 lines
3.7 KiB
TypeScript
/**
|
|
* Contains the TabView class, which represents a standard content component with tabs.
|
|
*/
|
|
declare module "ui/tab-view" {
|
|
import view = require("ui/core/view");
|
|
import dependencyObservable = require("ui/core/dependency-observable");
|
|
import observable = require("data/observable");
|
|
import bindable = require("ui/core/bindable");
|
|
import color = require("color");
|
|
|
|
/**
|
|
* Represents a tab view entry.
|
|
*/
|
|
class TabViewItem extends bindable.Bindable {
|
|
/**
|
|
* Gets or sets the title of the TabViewItem.
|
|
*/
|
|
public title: string;
|
|
|
|
/**
|
|
* Gets or sets the view of the TabViewItem.
|
|
*/
|
|
public view: view.View;
|
|
|
|
/**
|
|
* Gets or sets the icon source of the TabViewItem. This could either be a a file name or resource id.
|
|
*/
|
|
public iconSource: string;
|
|
}
|
|
|
|
/**
|
|
* Defines the data for the TabView.selectedIndexChanged event.
|
|
*/
|
|
export interface SelectedIndexChangedEventData extends observable.EventData {
|
|
/**
|
|
* The old selected index.
|
|
*/
|
|
oldIndex: number;
|
|
|
|
/**
|
|
* The new selected index.
|
|
*/
|
|
newIndex: number;
|
|
}
|
|
|
|
/**
|
|
* Represents a tab view.
|
|
*/
|
|
class TabView extends view.View {
|
|
public static itemsProperty: dependencyObservable.Property;
|
|
public static selectedIndexProperty: dependencyObservable.Property;
|
|
public static selectedColorProperty: dependencyObservable.Property;
|
|
|
|
/**
|
|
* Gets or sets the items of the TabView.
|
|
*/
|
|
items: Array<TabViewItem>;
|
|
|
|
/**
|
|
* Gets or sets the selectedIndex of the TabView.
|
|
*/
|
|
selectedIndex: number;
|
|
|
|
/**
|
|
* Gets or sets the color used for selected item.
|
|
*/
|
|
selectedColor: color.Color;
|
|
|
|
/**
|
|
* Gets or sets the color used for background of the tab items.
|
|
*/
|
|
tabsBackgroundColor: color.Color;
|
|
|
|
/**
|
|
* 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: observable.EventData) => void, thisArg?: any);
|
|
|
|
/**
|
|
* Raised when the selected index changes.
|
|
*/
|
|
on(event: "selectedIndexChanged", callback: (args: SelectedIndexChangedEventData) => void, thisArg?: any);
|
|
|
|
//@private
|
|
_getAndroidTabView(): any /* org.nativescript.widgets.TabLayout */;
|
|
_updateIOSTabBarColorsAndFonts(): void;
|
|
//@endprivate
|
|
}
|
|
}
|