mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-15 19:26:42 +08:00
97 lines
2.9 KiB
TypeScript
97 lines
2.9 KiB
TypeScript
/**
|
|
* @module "ui/segmented-bar"
|
|
*
|
|
* Contains the SegmentedBar class, which represents a SegmentedBar component.
|
|
*/ /** */
|
|
|
|
import {
|
|
ViewBase, View, AddChildFromBuilder, AddArrayFromBuilder,
|
|
Property, CoercibleProperty, EventData, Color, CssProperty, Style
|
|
} from "../core/view";
|
|
|
|
/**
|
|
* Represents a SegmentedBar item.
|
|
*/
|
|
export class SegmentedBarItem extends ViewBase {
|
|
/**
|
|
* Gets or sets the title of the SegmentedBarItem.
|
|
*/
|
|
public title: string;
|
|
}
|
|
|
|
/**
|
|
* Defines the data for the SegmentedBar.selectedIndexChanged event.
|
|
*/
|
|
export interface SelectedIndexChangedEventData extends EventData {
|
|
/**
|
|
* The old selected index.
|
|
*/
|
|
oldIndex: number;
|
|
|
|
/**
|
|
* The new selected index.
|
|
*/
|
|
newIndex: number;
|
|
}
|
|
|
|
/**
|
|
* Represents a UI SegmentedBar component.
|
|
*/
|
|
export class SegmentedBar extends View implements AddChildFromBuilder, AddArrayFromBuilder {
|
|
/**
|
|
* Gets or sets the selected index of the SegmentedBar component.
|
|
*/
|
|
selectedIndex: number;
|
|
|
|
/**
|
|
* Gets or sets the selected background color of the SegmentedBar component.
|
|
*/
|
|
selectedBackgroundColor: Color;
|
|
|
|
/**
|
|
* Gets or sets the items of the SegmentedBar.
|
|
*/
|
|
items: Array<SegmentedBarItem>;
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* Called for every child element declared in xml.
|
|
* @param name - Name of the element.
|
|
* @param value - Value of the element.
|
|
*/
|
|
public _addChildFromBuilder(name: string, value: any): void;
|
|
public _addArrayFromBuilder(name: string, value: Array<any>): void;
|
|
}
|
|
|
|
/**
|
|
* Gets or sets the selected index dependency property of the SegmentedBar.
|
|
*/
|
|
export const selectedIndexProperty: CoercibleProperty<SegmentedBar, number>;
|
|
|
|
/**
|
|
* Gets or sets the selected background color property of the SegmentedBar.
|
|
*/
|
|
export const selectedBackgroundColorProperty: CssProperty<Style, Color>;
|
|
|
|
/**
|
|
* Gets or sets the items dependency property of the SegmentedBar.
|
|
*/
|
|
export const itemsProperty: Property<SegmentedBar, SegmentedBarItem[]>;
|