@nativescript/core
Version:
A JavaScript library providing an easy to use api for interacting with iOS and Android platform APIs.
268 lines (234 loc) • 6.93 kB
TypeScript
import { View } from '../core/view';
import { ViewBase } from '../core/view-base';
import { EventData } from '../../data/observable';
/**
* Provides an abstraction over the ActionBar (android) and NavigationBar (iOS).
*/
export class ActionBar extends View {
/**
* Gets or sets the action bar title.
*/
title: string;
/**
* Gets or sets the title view. When set - replaces the title with a custom view.
*/
titleView: View;
/**
* Gets or sets the navigation button (a.k.a. the back button).
*/
navigationButton: NavigationButton;
/**
* Removes the shadow/border at the bottom of the ActionBar and removes translucency on iOS.
* Default false.
*/
flat: boolean;
/**
* Gets the collection of action items.
*/
actionItems: ActionItems;
/**
* Gets the android specific options of the action bar.
*/
android: AndroidActionBarSettings;
/**
* Gets the native iOS [UINavigationBar](https://developer.apple.com/documentation/uikit/uinavigationbar) that represents the user interface for this component. Valid only when running on iOS.
*/
ios: any /* UITabBarController */;
/**
* Gets or set the UIImageRenderingMode of the action bar icons in iOS. Defaults to "alwaysOriginal"
* Valid values are:
* - automatic
* - alwaysOriginal
* - alwaysTemplate
*/
iosIconRenderingMode: 'automatic' | 'alwaysOriginal' | 'alwaysTemplate';
public effectiveContentInsetLeft: number;
public effectiveContentInsetRight: number;
/**
* Updates the action bar.
*/
update();
//@private
/**
* @private
*/
_isEmpty(): boolean;
/**
* @private
*/
_getActualSize?: { width: number; height: number };
//@endprivate
}
/**
* Represents a collection of ActionItems.
*/
export class ActionItems {
/**
* Adds an item to the collection.
* @param item - the item to be added
*/
addItem(item: ActionItem): void;
/**
* Removes an item to the collection.
* @param item - The item to be removed.
*/
removeItem(item: ActionItem): void;
/**
* Gets an array of the current action items in the collection.
*/
getItems(): Array<ActionItem>;
/**
* Gets an item at a specified index.
* @param index - The index.
*/
getItemAt(index: number): ActionItem;
}
/**
* Represents an action item in the action bar.
*/
export class ActionItem extends ViewBase {
/**
* Gets or sets the text of the action item.
*/
text: string;
/**
* Gets or sets the icon of the action item.
*/
icon: string;
/**
* Gets or sets the custom action view of the action item.
*/
actionView: View;
/**
* Gets or sets the visibility of the action item.
*/
visibility: string;
/**
* Gets the action bar that contains the action item.
*/
actionBar: ActionBar;
/**
* 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): void;
/**
* Raised when a tap event occurs.
*/
on(event: 'tap', callback: (args: EventData) => void): void;
//@private
/**
* @private
*/
_raiseTap(): void;
//@endprivate
/**
* Gets the iOS specific options of the action item.
*/
// @ts-ignore
ios: IOSActionItemSettings;
/**
* Gets the Android specific options of the action item.
*/
// @ts-ignore
android: AndroidActionItemSettings;
}
/**
* Represents Android specific options of the action item.
*/
export interface AndroidActionItemSettings {
/**
* Gets or sets the position of the action item in the action bar.
* 1. actionBar - item is shown in the action bar.
* 2. actionBarIfRoom - item is shown in the action bar if there is room for it. Otherwise it is put in the popup menu.
* 3. popup - item is shown in the popup menu.
* Note: Property not applicable to NavigationButton
*/
position: 'actionBar' | 'actionBarIfRoom' | 'popup';
/**
* Gets or sets the name of the system drawable resource to be displayed.
* Use this property instead of ActionItem.icon if you want to diplsay a built-in Android system icon.
* The value should be a string such as 'ic_menu_search' if you want to display the built-in Android Menu Search icon for example.
* For a full list of Android drawable names, please visit http://androiddrawables.com
*/
systemIcon: string;
}
/**
* Represents iOS specific options of the action item.
*/
export interface IOSActionItemSettings {
/**
* Gets or sets the position of the action item in the action bar.
* 1. left - items is shown at the left part of the navigation bar. This is the default value.
* 2. right - items is shown at the right part of the navigation bar.
* Note: Property not applicable to NavigationButton
*/
position: 'left' | 'right';
/**
* Gets or sets a number representing the iOS system item to be displayed.
* Use this property instead of ActionItem.icon if you want to diplsay a built-in iOS system icon.
* Note: Property not applicable to NavigationButton
* The value should be a number from the UIBarButtonSystemItem enumeration
* (https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIBarButtonItem_Class/#//apple_ref/c/tdef/UIBarButtonSystemItem)
* 0: Done
* 1: Cancel
* 2: Edit
* 3: Save
* 4: Add
* 5: FlexibleSpace
* 6: FixedSpace
* 7: Compose
* 8: Reply
* 9: Action
* 10: Organize
* 11: Bookmarks
* 12: Search
* 13: Refresh
* 14: Stop
* 15: Camera
* 16: Trash
* 17: Play
* 18: Pause
* 19: Rewind
* 20: FastForward
* 21: Undo
* 22: Redo
* 23: PageCurl
*/
systemIcon: number;
}
/**
* Represents Android specific options of the action bar.
*/
export interface AndroidActionBarSettings {
/**
* Gets or sets the action bar icon.
*/
icon: string;
/**
* Gets or sets the visibility of the action bar icon.
* The icon is visible by default in pre-lollipop (API level < 20) versions of android and is hidden in lollipop (API level >= 20)
* The possible values are:
* 1. auto - the default behavior. This is the default value.
* 2. always - the icon is always shown.
* 3. never - the icon is always hidden.
*/
iconVisibility: string;
}
/**
* Represents the navigation (a.k.a. "back") button.
*/
export class NavigationButton extends ActionItem {
//@private
/**
* @private
*/
_navigationItem?: any;
//@endprivate
}
/** @internal */
export function _setNavBarColor(navBar: any /* UINavigationBar */, color: any /* UIColor */);
/** @internal */
export function _setNavBarBackgroundColor(navBar: any /* UINavigationBar */, color: any /* UIColor */);