@nativescript/core 8.9.0-next-01-17-2025-12834437745 → 8.9.0-next-01-22-2025-12918162303

package/ui/list-view/index.d.ts

@@ -0,0 +1,232 @@
+import { View, Template, KeyedTemplate } from '../core/view';
+import { Color } from '../../color';
+import { CoreTypes } from '../../core-types';
+import { EventData } from '../../data/observable';
+import { Length } from '../styling/style-properties';
+import { Style } from '../styling/style';
+import { Property, CssProperty } from '../core/properties';
+
+/**
+ * Represents a view that shows items in a vertically scrolling list.
+ *
+ * @nsView ListView
+ */
+export class ListView extends View {
+	/**
+	 * String value used when hooking to itemLoading event.
+	 *
+	 * @nsEvent {ItemEventData} itemLoading
+	 */
+	public static itemLoadingEvent: string;
+	/**
+	 * String value used when hooking to itemTap event.
+	 *
+	 * @nsEvent {ItemEventData} itemTap
+	 */
+	public static itemTapEvent: string;
+	/**
+	 * String value used when hooking to loadMoreItems event.
+	 *
+	 * @nsEvent itemLoading
+	 */
+	public static loadMoreItemsEvent: string;
+
+	/**
+	 * Gets the native [android widget](http://developer.android.com/reference/android/widget/ListView.html) that represents the user interface for this component. Valid only when running on Android OS.
+	 */
+	android: any /* android.widget.ListView */;
+
+	/**
+	 * Gets the native [iOS view](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITableView_Class/) that represents the user interface for this component. Valid only when running on iOS.
+	 */
+	ios: any /* UITableView */;
+
+	/**
+	 * Gets or set the items collection of the ListView.
+	 * The items property can be set to an array or an object defining length and getItem(index) method.
+	 *
+	 * @nsProperty
+	 */
+	items: any[] | ItemsSource;
+
+	/**
+	 * Gets or set the item template of the ListView.
+	 *
+	 * @nsProperty
+	 */
+	itemTemplate: string | Template;
+
+	/**
+	 * Gets or set the list of item templates for the item template selector
+	 *
+	 * @nsProperty
+	 */
+	itemTemplates: string | Array<KeyedTemplate>;
+
+	/**
+	 * A function that returns the appropriate ket template based on the data item.
+	 *
+	 * @nsProperty
+	 */
+	itemTemplateSelector: string | ((item: any, index: number, items: any) => string);
+
+	/**
+	 * Item id generator
+	 *
+	 * @nsProperty
+	 */
+	itemIdGenerator: (item: any, index: number, items: any) => number;
+
+	/**
+	 * Gets or set the items separator line color of the ListView.
+	 *
+	 * @nsProperty
+	 */
+	separatorColor: Color;
+
+	/**
+	 * Gets or set row height of the ListView.
+	 *
+	 * @nsProperty
+	 */
+	rowHeight: CoreTypes.LengthType;
+
+	/**
+	 * Gets or set the estimated height of rows in the ListView.
+	 * The default value is 44px.
+	 *
+	 * @nsProperty
+	 */
+	iosEstimatedRowHeight: CoreTypes.LengthType;
+
+	/**
+	 * Forces the ListView to reload all its items.
+	 */
+	refresh();
+
+	/**
+	 * Scrolls the specified item with index into view.
+	 * [iOS](https://developer.apple.com/library/prerelease/ios/documentation/UIKit/Reference/UITableView_Class/#//apple_ref/occ/instm/UITableView/scrollToRowAtIndexPath:atScrollPosition:animated:)
+	 * [Android](http://developer.android.com/reference/android/widget/ListView.html#setSelection(int))
+	 * @param index - Item index.
+	 */
+	scrollToIndex(index: number);
+
+	/**
+	 * Scrolls the specified item with index into view with animation.
+	 * [iOS](https://developer.apple.com/library/prerelease/ios/documentation/UIKit/Reference/UITableView_Class/#//apple_ref/occ/instm/UITableView/scrollToRowAtIndexPath:atScrollPosition:animated:)
+	 * [Android](https://developer.android.com/reference/android/widget/ListView.html#smoothScrollToPosition(int))
+	 * @param index - Item index.
+	 */
+	scrollToIndexAnimated(index: number);
+
+	/**
+	 * Checks if Specified item with index is visible.
+	 * @param index - Item index.
+	 */
+	isItemAtIndexVisible(index: number): boolean;
+
+	/**
+	 * 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 a View for the data at the specified index should be created.
+	 * The result should be returned trough the view property of the event data.
+	 * Note, that the view property of the event data can be pre-initialized with
+	 * an old instance of a view, so that it can be reused.
+	 */
+	on(event: 'itemLoading', callback: (args: ItemEventData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when an item inside the ListView is tapped.
+	 */
+	on(event: 'itemTap', callback: (args: ItemEventData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when the ListView is scrolled so that its last item is visible.
+	 */
+	on(event: 'loadMoreItems', callback: (args: EventData) => void, thisArg?: any): void;
+}
+
+/**
+ * Event data containing information for the index and the view associated to a list view item.
+ */
+export interface ItemEventData extends EventData {
+	/**
+	 * The index of the item, for which the event is raised.
+	 */
+	index: number;
+
+	/**
+	 * The view that is associated to the item, for which the event is raised.
+	 */
+	view: View;
+
+	/**
+	 * Gets the native [iOS view](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITableViewCell_Class/) that represents the user interface where the view is hosted. Valid only when running on iOS.
+	 */
+	ios: any /* UITableViewCell */;
+
+	/**
+	 * Gets the native [android widget](http://developer.android.com/reference/android/view/ViewGroup.html) that represents the user interface where the view is hosted. Valid only when running on Android OS.
+	 */
+	android: any /* android.view.ViewGroup */;
+}
+
+export interface ItemsSource {
+	length: number;
+	getItem(index: number): any;
+}
+
+export interface TemplatedItemsView {
+	items: any[] | ItemsSource;
+	itemTemplate: string | Template;
+	itemTemplates?: string | Array<KeyedTemplate>;
+	refresh(): void;
+	on(event: 'itemLoading', callback: (args: ItemEventData) => void, thisArg?: any): void;
+	off(event: 'itemLoading', callback: (args: EventData) => void, thisArg?: any): void;
+}
+
+/**
+ * Represents the property backing the items property of each ListView instance.
+ */
+export const itemsProperty: Property<ListView, any[] | ItemsSource>;
+
+/**
+ * Represents the item template property of each ListView instance.
+ */
+export const itemTemplateProperty: Property<ListView, string | Template>;
+
+/**
+ * Represents the items template property of each ListView instance.
+ */
+export const itemTemplatesProperty: Property<ListView, string | Array<KeyedTemplate>>;
+
+/**
+ * Represents the separator color backing property.
+ */
+export const separatorColor: Property<ListView, Color>;
+
+/**
+ * Represents the observable property backing the rowHeight property of each ListView instance.
+ */
+export const rowHeightProperty: Property<ListView, CoreTypes.LengthType>;
+
+/**
+ * Represents the observable property backing the iosEstimatedRowHeight property of each ListView instance.
+ */
+export const iosEstimatedRowHeightProperty: Property<ListView, CoreTypes.LengthType>;
+
+/**
+ * Backing property for separator color property.
+ */
+export const separatorColorProperty: CssProperty<Style, Color>;

package/ui/page/index.d.ts

@@ -0,0 +1,241 @@
+import { PageBase } from './page-common';
+import { CssProperty, Property } from '../core/properties';
+import { Style } from '../styling/style';
+import { EventData } from '../../data/observable';
+import { Frame } from '../frame';
+import { ActionBar } from '../action-bar';
+import { KeyframeAnimationInfo } from '../animation/keyframe-animation';
+import { Color } from '../../color';
+
+export * from './page-common';
+
+/**
+ * Defines the data for the page navigation events.
+ */
+export interface NavigatedData extends EventData {
+	/**
+	 * The navigation context (optional, may be undefined) passed to the page navigation events method.
+	 */
+	context: any;
+
+	/**
+	 * Represents if a navigation is forward or backward.
+	 */
+	isBackNavigation: boolean;
+}
+
+/**
+ * Represents a logical unit for navigation (inside Frame).
+ *
+ * @nsView Page
+ */
+export declare class Page extends PageBase {
+	/**
+	 * String value used when hooking to navigatingTo event.
+	 *
+	 * @nsEvent {NavigatedData} navigatingTo
+	 */
+	public static readonly navigatingToEvent = 'navigatingTo';
+
+	/**
+	 * String value used when hooking to navigatedTo event.
+	 *
+	 * @nsEvent {NavigatedData} navigatedTo
+	 */
+	public static readonly navigatedToEvent = 'navigatedTo';
+
+	/**
+	 * String value used when hooking to navigatingFrom event.
+	 *
+	 * @nsEvent {NavigatedData} navigatingFrom
+	 */
+	public static readonly navigatingFromEvent = 'navigatingFrom';
+
+	/**
+	 * String value used when hooking to navigatedFrom event.
+	 *
+	 * @nsEvent {NavigatedData} navigatedFrom
+	 */
+	public static readonly navigatedFromEvent = 'navigatedFrom';
+
+	/**
+	 * Gets or sets whether page background spans under status bar.
+	 *
+	 * @nsProperty
+	 */
+	public backgroundSpanUnderStatusBar: boolean;
+
+	/**
+	 * Gets or sets the style of the status bar.
+	 *
+	 * @nsProperty
+	 */
+	// @ts-ignore
+	public statusBarStyle: 'light' | 'dark';
+
+	/**
+	 * Gets or sets the color of the status bar in Android.
+	 *
+	 * @nsProperty
+	 */
+	// @ts-ignore
+	public androidStatusBarBackground: Color;
+
+	/**
+	 * Used to hide the Navigation Bar in iOS and the Action Bar in Android.
+	 *
+	 * @nsProperty
+	 */
+	// @ts-ignore
+	public actionBarHidden: boolean;
+
+	/**
+	 * Used to control if swipe back navigation in iOS is enabled.
+	 *
+	 * This property is iOS specific.
+	 * Default value: true
+	 *
+	 * @nsProperty
+	 */
+	public enableSwipeBackNavigation: boolean;
+
+	/**
+	 * Returns a CSS keyframe animation with the specified name, if it exists.
+	 */
+	public getKeyframeAnimationWithName(animationName: string): KeyframeAnimationInfo;
+
+	/**
+	 * A property that is used to pass a data from another page (while navigate to).
+	 *
+	 * @nsProperty
+	 */
+	// @ts-ignore
+	public navigationContext: any;
+
+	/**
+	 * Gets the Frame object controlling this instance.
+	 */
+	// @ts-ignore
+	public frame: Frame;
+
+	/**
+	 * Gets the ActionBar for this page.
+	 */
+	// @ts-ignore
+	public actionBar: ActionBar;
+
+	/**
+	 * iOS Only
+	 * Perform an action when user performans the "escape" gesture
+	 *
+	 * @nsProperty
+	 */
+	public onAccessibilityPerformEscape?: () => boolean;
+
+	/**
+	 * Should page changed be announced to the screen reader.
+	 *
+	 * @nsProperty
+	 */
+	public accessibilityAnnouncePageEnabled: boolean;
+
+	/**
+	 * 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.
+	 */
+	public on(eventName: string, callback: (data: EventData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when navigation to the page has started.
+	 */
+	public on(event: 'navigatingTo', callback: (args: NavigatedData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when navigation to the page has finished.
+	 */
+	public on(event: 'navigatedTo', callback: (args: NavigatedData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when navigation from the page has started.
+	 */
+	public on(event: 'navigatingFrom', callback: (args: NavigatedData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when navigation from the page has finished.
+	 */
+	public on(event: 'navigatedFrom', callback: (args: NavigatedData) => void, thisArg?: any): void;
+	//@private
+
+	/**
+	 * @private
+	 */
+	hasActionBar: boolean;
+
+	/**
+	 * A method called before navigating to the page.
+	 * @private
+	 * @param context - The data passed to the page through the NavigationEntry.context property.
+	 * @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
+	 * @param bindingContext - An object to become the binding context of the page navigating to. Optional.
+	 */
+	public onNavigatingTo(context: any, isBackNavigation: boolean, bindingContext?: any): void;
+
+	/**
+	 * A method called after navigated to the page.
+	 * @private
+	 * @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
+	 */
+	public onNavigatedTo(isBackNavigation: boolean): void;
+
+	/**
+	 * A method called before navigating from the page.
+	 * @private
+	 * @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
+	 */
+	public onNavigatingFrom(isBackNavigation: boolean): void;
+
+	/**
+	 * A method called after navigated from the page.
+	 * @private
+	 * @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
+	 */
+	public onNavigatedFrom(isBackNavigation: boolean): void;
+	//@endprivate
+
+	/**
+	 * Announce screen changed
+	 */
+	public accessibilityScreenChanged(refocus?: boolean): void;
+}
+
+/**
+ * Dependency property that specify if page background should span under status bar.
+ */
+export const backgroundSpanUnderStatusBarProperty: Property<Page, boolean>;
+
+/**
+ * Dependency property used to hide the Navigation Bar in iOS and the Action Bar in Android.
+ */
+export const actionBarHiddenProperty: Property<Page, boolean>;
+
+/**
+ * Dependency property used to control if swipe back navigation in iOS is enabled.
+ * This property is iOS specific. Default value: true
+ */
+export const enableSwipeBackNavigationProperty: Property<Page, boolean>;
+
+/**
+ * Property backing statusBarStyle.
+ */
+export const statusBarStyleProperty: CssProperty<Style, 'light' | 'dark'>;
+
+/**
+ * Property backing androidStatusBarBackground.
+ */
+export const androidStatusBarBackgroundProperty: CssProperty<Style, Color>;

package/ui/placeholder/index.d.ts

@@ -1,12 +1,50 @@
-import { View } from '../core/view';
-import { CreateViewEventData } from './placeholder-common';
+import { View } from '../core/view';
 import { EventData } from '../../data/observable';
+
 export * from './placeholder-common';
-export declare class Placeholder extends View {
-    static creatingViewEvent: string;
-    createNativeView(): any;
+
+/**
+ * Represents a Placeholder, which is used to add a native view to the visual tree.
+ *
+ * @nsView Placeholder
+ */
+export class Placeholder extends View {
+	/**
+	 * String value used when hooking to creatingView event.
+	 *
+	 * @nsEvent {CreateViewEventData} creatingView
+	 */
+	public static creatingViewEvent: string;
+
+	/**
+	 * 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: (args: EventData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised when a creatingView event occurs.
+	 */
+	on(event: 'creatingView', callback: (args: CreateViewEventData) => void, thisArg?: any): void;
 }
-export interface Placeholder {
-    on(eventNames: string, callback: (args: EventData) => void, thisArg?: any): void;
-    on(event: 'creatingView', callback: (args: CreateViewEventData) => void, thisArg?: any): void;
+
+/**
+ * Event data containing information for creating a native view that will be added to the visual tree.
+ */
+export interface CreateViewEventData extends EventData {
+	/**
+	 * The native view that should be added to the visual tree.
+	 */
+	view: any;
+
+	/**
+	 * An optional context for creating the view.
+	 */
+	context?: any;
 }

package/ui/progress/index.d.ts

@@ -0,0 +1,50 @@
+import { View } from '../core/view';
+import { Property } from '../core/properties';
+
+/**
+ * Represents a progress component.
+ *
+ * @nsView Progress
+ */
+export class Progress extends View {
+	/**
+	 * String value used when hooking to valueChange event.
+	 *
+	 * @nsEvent {PropertyChangeData} valueChange
+	 */
+	static readonly valueChangeEvent = 'valueChange';
+
+	/**
+	 * Gets the native [android widget](http://developer.android.com/reference/android/widget/ProgressBar.html) that represents the user interface for this component. Valid only when running on Android OS.
+	 */
+	android: any /* android.widget.ProgressBar */;
+
+	/**
+	 * Gets the native iOS [UIProgressView](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIProgressView_Class/) that represents the user interface for this component. Valid only when running on iOS.
+	 */
+	ios: any /* UIProgressView */;
+
+	/**
+	 * Gets or sets a progress current value.
+	 *
+	 * @nsProperty
+	 */
+	value: number;
+
+	/**
+	 * Gets or sets a progress max value.
+	 *
+	 * @nsProperty
+	 */
+	maxValue: number;
+}
+
+/**
+ * Represents the observable property backing the value property of each Progress instance.
+ */
+export const valueProperty: Property<Progress, number>;
+
+/**
+ * Represents the observable property backing the maxValue property of each Progress instance.
+ */
+export const maxValueProperty: Property<Progress, number>;

package/ui/scroll-view/index.d.ts

@@ -0,0 +1,99 @@
+import { ContentView } from '../content-view';
+import { Property } from '../core/properties';
+import { EventData } from '../../data/observable';
+import { CoreTypes } from '../../core-types';
+
+/**
+ * Represents a scrollable area that can have content that is larger than its bounds.
+ *
+ * @nsView ScrollView
+ */
+export class ScrollView extends ContentView {
+	/**
+	 * String value used when hooking to scroll event.
+	 *
+	 * @nsEvent {ScrollEventData} scroll
+	 */
+	public static scrollEvent: string;
+
+	/**
+	 * Gets or sets a value indicating whether scroll is enabled.
+	 *
+	 * @nsProperty
+	 */
+	isScrollEnabled: boolean;
+
+	/**
+	 * Gets a value that contains the vertical offset of the scrolled content.
+	 */
+	verticalOffset: number;
+
+	/**
+	 * Gets a value that contains the horizontal offset of the scrolled content.
+	 */
+	horizontalOffset: number;
+
+	/**
+	 * Gets the maximum value for the verticalOffset.
+	 */
+	scrollableHeight: number;
+
+	/**
+	 * Gets the maximum value for the horizontalOffset.
+	 */
+	scrollableWidth: number;
+
+	/**
+	 * Toggles scrollbar indicator visibility
+	 *
+	 * @nsProperty
+	 */
+	scrollBarIndicatorVisible: boolean;
+
+	/**
+	 * Scrolls the content the specified vertical offset position.
+	 * @param value The offset value
+	 * @param animated true for animated scroll, false for immediate scroll.
+	 */
+	scrollToVerticalOffset(value: number, animated: boolean);
+
+	/**
+	 * Scrolls the content the specified horizontal offset position.
+	 * @param value The offset value
+	 * @param animated true for animated scroll, false for immediate scroll.
+	 */
+	scrollToHorizontalOffset(value: number, animated: boolean);
+
+	/**
+	 * Gets or sets direction in which the content can be scrolled.
+	 *
+	 * @nsProperty
+	 */
+	orientation: CoreTypes.OrientationType;
+
+	/**
+	 * 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 a scroll event occurs.
+	 */
+	on(event: 'scroll', callback: (args: ScrollEventData) => void, thisArg?: any): void;
+
+	_onOrientationChanged(): void;
+}
+
+export interface ScrollEventData extends EventData {
+	scrollX: number;
+	scrollY: number;
+}
+
+export const orientationProperty: Property<ScrollView, CoreTypes.OrientationType>;