@nativescript/core/ui/segmented-bar/index.d.ts

A JavaScript library providing an easy to use api for interacting with iOS and Android platform APIs.

import { View, AddChildFromBuilder, AddArrayFromBuilder } from '../core/view';
import { ViewBase } from '../core/view-base';
import { Property, CoercibleProperty, CssProperty } from '../core/properties';
import { EventData } from '../../data/observable';
import { Color } from '../../color';
import { Style } from '../styling/style';

/**
 * Represents a SegmentedBar item.
 *
 * @nsView SegmentedBarItem
 */
export class SegmentedBarItem extends ViewBase {
	/**
	 * Gets or sets the title of the SegmentedBarItem.
	 *
	 * @nsProperty
	 */
	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.
 *
 * @nsView SegmentedBar
 */
export class SegmentedBar extends View implements AddChildFromBuilder, AddArrayFromBuilder {
	/**
	 * String value used when hooking to the selectedIndexChanged event.
	 *
	 * @nsEvent {SelectedIndexChangedEventData} selectedIndexChanged
	 */
	public static selectedIndexChangedEvent;

	/**
	 * Gets or sets the selected index of the SegmentedBar component.
	 *
	 * @nsProperty
	 */
	selectedIndex: number;

	/**
	 * Gets or sets the selected background color of the SegmentedBar component.
	 *
	 * @nsProperty
	 */
	selectedBackgroundColor: Color;

	/**
	 * Gets or sets the selected text color of the SegmentedBar component.
	 *
	 * @nsProperty
	 */
	selectedTextColor: Color;

	/**
	 * Gets or sets the items of the SegmentedBar.
	 *
	 * @nsProperty
	 */
	items: Array<SegmentedBarItem>;

	/**
	 * Adds a listener for the specified event name.
	 *
	 * @param eventName The name of the event.
	 * @param callback The event listener to add. Will be called when an event of
	 * the given name is raised.
	 * @param thisArg 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.
	 */
	on(eventName: string, callback: (data: EventData) => void, thisArg?: any): void;

	/**
	 * Raised when the selected index changes.
	 */
	on(event: 'selectedIndexChanged', callback: (args: SelectedIndexChangedEventData) => void, thisArg?: any): void;

	/**
	 * 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[]>;

/**
 * Gets or sets the selected text color property of the SegmentedBar.
 */
export const selectedTextColorProperty: CssProperty<Style, Color>;