@nativescript/core 8.9.0-next-01-14-2025-12761272657 → 8.9.0-next-01-18-2025-12839190246

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

@@ -0,0 +1,41 @@
+import { View } from '../core/view';
+import { Property } from '../core/properties';
+
+/**
+ * Represents a view with html content. Use this component instead WebView when you want to show just static HTML content.
+ * [iOS support](https://developer.apple.com/documentation/foundation/nsattributedstring/1524613-initwithdata)
+ * [android support](http://developer.android.com/reference/android/text/Html.html)
+ *
+ * @nsView HtmlView
+ */
+export class HtmlView extends View {
+	/**
+	 * Gets the native [android widget](http://developer.android.com/reference/android/widget/TextView.html) that represents the user interface for this component. Valid only when running on Android OS.
+	 */
+	android: any /* android.widget.TextView */;
+
+	/**
+	 * Gets the native [UITextView](https://developer.apple.com/documentation/uikit/uitextview) that represents the user interface for this component. Valid only when running on iOS.
+	 */
+	ios: any /* UITextView */;
+
+	/** Gets or sets html string for the HtmlView.
+	 *
+	 * @nsProperty
+	 */
+	html: string;
+
+	/** Gets or sets a value indicating whether HtmlView is selectable.
+	 *
+	 * @nsProperty
+	 */
+	selectable: boolean;
+	/**
+	 * Gets of sets color of links in the rendered HTML.
+	 *
+	 * @nsProperty
+	 */
+	linkColor: Color;
+}
+
+export const htmlProperty: Property<HtmlView, string>;

package/ui/image/index.d.ts

@@ -0,0 +1,119 @@
+import { View } from '../core/view';
+import { Style } from '../styling/style';
+import { ImageSource, iosSymbolScaleType } from '../../image-source';
+import { ImageAsset } from '../../image-asset';
+import { Color } from '../../color';
+import { Property, InheritedCssProperty } from '../core/properties';
+import { CoreTypes } from '../../core-types';
+import { ImageSymbolEffect, ImageSymbolEffects } from './symbol-effects';
+import { PropertyChangeData } from '../../data/observable';
+
+export { ImageSymbolEffect, ImageSymbolEffects } from './image-common';
+
+/**
+ * Represents a class that provides functionality for loading and streching image(s).
+ *
+ * @nsView Image
+ */
+export class Image extends View {
+	/**
+	 * String value used when hooking to the isLoadingChange event.
+	 *
+	 * @nsEvent {PropertyChangeData} isLoading
+	 */
+	public static isLoadingChangeEvent: string;
+	/**
+	 * Gets the native [android widget](http://developer.android.com/reference/android/widget/ImageView.html) that represents the user interface for this component. Valid only when running on Android OS.
+	 */
+	android: any /* android.widget.ImageView */;
+
+	/**
+	 * Gets the native iOS [UIImageView](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIImageView_Class/) that represents the user interface for this component. Valid only when running on iOS.
+	 */
+	ios: any /* UIImageView */;
+
+	/**
+	 * Gets or sets the image source of the image.
+	 *
+	 * @nsProperty
+	 */
+	imageSource: ImageSource;
+
+	/**
+	 * Gets or sets the source of the Image. This can be either an URL string or a native image instance.
+	 *
+	 * @nsProperty
+	 */
+	src: string | ImageSource | ImageAsset;
+
+	/**
+	 * Gets a value indicating if the image is currently loading.
+	 */
+	readonly isLoading: boolean;
+
+	/**
+	 * Gets or sets the image stretch mode.
+	 *
+	 * @nsProperty
+	 */
+	stretch: CoreTypes.ImageStretchType;
+
+	/**
+	 * Gets or sets the loading strategy for images on the local file system:
+	 * - **sync** - blocks the UI if necessary to display immediately, good for small icons.
+	 * - **async** *(default)* - will load in the background, may appear with short delay, good for large images.
+	 * When loading images from web they are always loaded **async** no matter of loadMode value.
+	 *
+	 * @nsProperty
+	 */
+	loadMode: 'sync' | 'async';
+
+	/**
+	 * A color used to tint template images.
+	 *
+	 * @nsProperty
+	 */
+	tintColor: Color;
+
+	/**
+	 * Gets or sets the desired decode height of the image.
+	 * This property is Android specific.
+	 *
+	 *
+	 * @nsProperty
+	 */
+	decodeHeight: CoreTypes.LengthType;
+
+	/**
+	 * Gets or sets the desired decode width of the image.
+	 * This property is Android specific.
+	 *
+	 * @nsProperty
+	 */
+	decodeWidth: CoreTypes.LengthType;
+	/**
+	 * Get or set the symbol effect used to animate the SF symbol image
+	 * Symbol effects: https://developer.apple.com/documentation/symbols?language=objc
+	 *
+	 * @nsProperty
+	 */
+	iosSymbolEffect: ImageSymbolEffect | ImageSymbolEffects;
+
+	/**
+	 * Get or set the SF Symbol scale to use.
+	 *
+	 * @nsProperty
+	 */
+	iosSymbolScale: iosSymbolScaleType;
+}
+
+export const imageSourceProperty: Property<Image, ImageSource>;
+export const srcProperty: Property<Image, string | ImageSource | ImageAsset>;
+export const isLoadingProperty: Property<Image, string>;
+export const loadMode: Property<Image, 'sync' | 'async'>;
+export const stretchProperty: Property<Image, CoreTypes.ImageStretchType>;
+export const tintColorProperty: InheritedCssProperty<Style, Color>;
+export const decodeHeightProperty: Property<Image, CoreTypes.LengthType>;
+export const decodeWidthProperty: Property<Image, CoreTypes.LengthType>;
+export const iosSymbolScaleProperty: Property<Image, iosSymbolScaleType>;
+export const iosSymbolEffectProperty: Property<Image, ImageSymbolEffect | ImageSymbolEffects>;

package/ui/image/symbol-effects.d.ts

@@ -0,0 +1,13 @@
+export { ImageSymbolEffects } from './symbol-effects-common';
+
+/**
+ * iOS only
+ * Symbol effects: https://developer.apple.com/documentation/symbols?language=objc
+ */
+export class ImageSymbolEffect {
+	effect?: NSSymbolEffect;
+	options?: NSSymbolEffectOptions;
+	completion?: (context: UISymbolEffectCompletionContext) => void;
+	constructor(symbol: NSSymbolEffect);
+	static fromSymbol(symbol: string): ImageSymbolEffect | null;
+}

package/ui/image-cache/index.d.ts

@@ -0,0 +1,147 @@
+import { Observable, EventData } from '../../data/observable';
+import { ImageSource } from '../../image-source';
+
+/**
+ * Represents a single download request.
+ */
+export interface DownloadRequest {
+	/**
+	 * The url of the image.
+	 */
+	url: string;
+	/**
+	 * The key used to cache the image.
+	 */
+	key: string;
+	/**
+	 * An optional function to be called when the download is complete.
+	 */
+	completed?: (image: any, key: string) => void;
+	/**
+	 * An optional function to be called if the download errors.
+	 */
+	error?: (key: string) => void;
+}
+
+/**
+ * Represents a class that stores handles image download requests and caches the already downloaded images.
+ */
+export class Cache extends Observable {
+	/**
+	 * String value used when hooking to downloaded event.
+	 */
+	public static downloadedEvent: string;
+	/**
+	 * String value used when hooking to download error event.
+	 */
+	public static downloadErrorEvent: string;
+	/**
+	 * The image to be used to notify for a pending download request - e.g. loading indicator.
+	 */
+	placeholder: ImageSource;
+	/**
+	 * The maximum number of simultaneous download requests. Defaults to 5.
+	 */
+	maxRequests: number;
+
+	/**
+	 * Enables previously suspended download requests.
+	 */
+	enableDownload(): void;
+	/**
+	 * Temporary disables download requests.
+	 */
+	disableDownload(): void;
+
+	/**
+	 * Adds a new download request at the top of the download queue. This will be the next immediate download to start.
+	 */
+	push(request: DownloadRequest);
+	/**
+	 * Adds a new download request at the end of the download queue. This will be the last download to start.
+	 */
+	enqueue(request: DownloadRequest);
+
+	/**
+	 * Gets the image for the specified key. May be undefined if the key is not present in the cache.
+	 */
+	get(key: string): any;
+	/**
+	 * Sets the image for the specified key.
+	 */
+	set(key: string, image: any): void;
+	/**
+	 * Removes the cache for the specified key.
+	 */
+	remove(key: string): void;
+	/**
+	 * Removes all the previously cached images.
+	 */
+	clear(): void;
+
+	/**
+	 * 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 the image has been downloaded.
+	 */
+	on(event: 'downloaded', callback: (args: DownloadedData) => void, thisArg?: any): void;
+
+	/**
+	 * Raised if the image download errors.
+	 */
+	on(event: 'downloadError', callback: (args: DownloadError) => void, thisArg?: any): void;
+
+	//@private
+	/**
+	 * @private
+	 */
+	_downloadCore(request: DownloadRequest);
+	/**
+	 * @private
+	 */
+	_onDownloadCompleted(key: string, image: any);
+	//@endprivate
+	/**
+	 * @private
+	 */
+	_onDownloadError(key: string, err: Error);
+	//@endprivate
+}
+
+/**
+ * Provides data for downloaded event.
+ */
+export interface DownloadedData extends EventData {
+	/**
+	 * A string indentifier of the cached image.
+	 */
+	key: string;
+	/**
+	 * Gets the cached image.
+	 */
+	image: ImageSource;
+}
+
+/**
+ * Provides data for download error.
+ */
+export interface DownloadError extends EventData {
+	/**
+	 * A string indentifier of the cached image.
+	 */
+	key: string;
+	/**
+	 * Gets the error.
+	 */
+	error: Error;
+}

package/ui/label/index.d.ts

@@ -0,0 +1,25 @@
+import { TextBase } from '../text-base';
+
+/**
+ * Represents a text label.
+ *
+ * @nsView Label
+ */
+export class Label extends TextBase {
+	/**
+	 * Gets the native [android widget](http://developer.android.com/reference/android/widget/TextView.html) that represents the user interface for this component. Valid only when running on Android OS.
+	 */
+	android: any /* android.widget.TextView */;
+
+	/**
+	 * Gets the native [UILabel](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UILabel_Class/) that represents the user interface for this component. Valid only when running on iOS.
+	 */
+	ios: any /* UILabel */;
+
+	/**
+	 * Gets or sets whether the Label wraps text or not.
+	 *
+	 * @nsProperty
+	 */
+	textWrap: boolean;
+}

package/ui/layouts/absolute-layout/index.d.ts

@@ -0,0 +1,42 @@
+import { LayoutBase } from '../layout-base';
+import { Property } from '../../core/properties';
+import { View } from '../../core/view';
+import { Length } from '../../styling/style-properties';
+import { CoreTypes } from '../../../core-types';
+
+/**
+ *  A layout that lets you specify exact locations (left/top coordinates) of its children.
+ *
+ * @nsView AbsoluteLayout
+ */
+export class AbsoluteLayout extends LayoutBase {
+	/**
+	 * Gets the value of the Left property from a given View.
+	 */
+	static getLeft(view: View): CoreTypes.LengthType;
+
+	/**
+	 * Sets the value of the Left property from a given View.
+	 */
+	static setLeft(view: View, value: CoreTypes.LengthType): void;
+
+	/**
+	 * Gets the value of the Top property from a given View.
+	 */
+	static getTop(view: View): CoreTypes.LengthType;
+
+	/**
+	 * Sets the value of the Top property from a given View.
+	 */
+	static setTop(view: View, value: CoreTypes.LengthType): void;
+}
+
+/**
+ * Represents the observable property backing the left property.
+ */
+export const leftProperty: Property<View, CoreTypes.LengthType>;
+
+/**
+ * Represents the observable property backing the top property.
+ */
+export const topProperty: Property<View, CoreTypes.LengthType>;

package/ui/layouts/dock-layout/index.d.ts

@@ -0,0 +1,39 @@
+import { LayoutBase } from '../layout-base';
+import { Property } from '../../core/properties';
+import { View } from '../../core/view';
+import { CoreTypes } from '../../../core-types';
+
+/**
+ * A Layout that arranges its children at its outer edges, and allows its last child to take up the remaining space.
+ *
+ * @nsView DockLayout
+ */
+export class DockLayout extends LayoutBase {
+	/**
+	 * Gets the value of the Dock property from a given View.
+	 */
+	static getDock(view: View): CoreTypes.DockType;
+
+	/**
+	 * Sets the value of the Dock property from a given View.
+	 */
+	static setDock(view: View, value: CoreTypes.DockType): void;
+
+	/**
+	 * Gets or sets a value that indicates whether the last child element within a DockLayout stretches to fill the remaining available space.
+	 * The default value is true.
+	 *
+	 * @nsProperty
+	 */
+	stretchLastChild: boolean;
+}
+
+/**
+ * Represents the observable property backing the dock property.
+ */
+export const dockProperty: Property<View, CoreTypes.DockType>;
+
+/**
+ * Represents the observable property backing the stretchLastChild property of each DockLayout instance.
+ */
+export const stretchLastChildProperty: Property<DockLayout, boolean>;

package/ui/layouts/flexbox-layout/index.d.ts

@@ -0,0 +1,98 @@
+import { LayoutBase } from '../layout-base';
+import { Style } from '../../styling/style';
+import { CssProperty } from '../../core/properties';
+import { View } from '../../core/view';
+
+export type FlexDirection = 'row' | 'row-reverse' | 'column' | 'column-reverse';
+export type FlexWrap = 'nowrap' | 'wrap' | 'wrap-reverse';
+export type JustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
+export type AlignItems = 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch';
+export type AlignContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'stretch';
+export type FlexFlow = `${FlexDirection} ${FlexWrap}`;
+export type Flex = number | 'initial' | 'auto' | 'none' | `${FlexGrow} ${FlexShrink}`;
+
+/**
+ * A flex order integer.
+ */
+export type Order = number;
+
+/**
+ * A flex-grow number. Negative values are invalid.
+ */
+export type FlexGrow = number;
+
+/**
+ * A flex-shrink number. Negative values are invalid.
+ */
+export type FlexShrink = number;
+
+/**
+ * A flex-wrap-before value. True, false or their string presentations "true" or "false".
+ */
+export type FlexWrapBefore = boolean;
+
+export type AlignSelf = 'auto' | AlignItems;
+
+/**
+ * @nsView FlexboxLayout
+ */
+export class FlexboxLayout extends LayoutBase {
+	/**
+	 * Gets or set the direction of childern on the main axis.
+	 *
+	 * @nsProperty
+	 */
+	public flexDirection: FlexDirection;
+	/**
+	 * Gets or sets whether children can wrap into multiple lines
+	 *
+	 * @nsProperty
+	 */
+	public flexWrap: FlexWrap;
+	/**
+	 * Gets or sets alignment of childern on the main axis
+	 *
+	 * @nsProperty
+	 */
+	public justifyContent: JustifyContent;
+	/**
+	 * Gets or sets alignment of the childern on cross axis
+	 *
+	 * @nsProperty
+	 */
+	public alignItems: AlignItems;
+	/**
+	 * Gets or sets alignment of items along the cross axis
+	 *
+	 * @nsProperty
+	 */
+	public alignContent: AlignContent;
+
+	public static setOrder(view: View, order: number);
+	public static getOrder(view: View): number;
+
+	public static setFlexGrow(view: View, grow: number);
+	public static getFlexGrow(view: View);
+
+	public static setFlexShrink(view: View, shrink: number);
+	public static getFlexShrink(view: View): number;
+
+	public static setAlignSelf(view: View, align: AlignSelf);
+	public static getAlignSelf(view: View): AlignSelf;
+
+	public static setFlexWrapBefore(view: View, wrap: boolean);
+	public static getFlexWrapBefore(view: View): boolean;
+}
+
+export const flexDirectionProperty: CssProperty<Style, FlexDirection>;
+export const flexWrapProperty: CssProperty<Style, FlexWrap>;
+export const justifyContentProperty: CssProperty<Style, JustifyContent>;
+export const alignItemsProperty: CssProperty<Style, AlignItems>;
+
+export const orderProperty: CssProperty<Style, Order>;
+export const flexGrowProperty: CssProperty<Style, FlexGrow>;
+export const flexShrinkProperty: CssProperty<Style, FlexShrink>;
+export const flexWrapBeforeProperty: CssProperty<Style, FlexWrapBefore>;
+export const alignSelfProperty: CssProperty<Style, AlignSelf>;
+export const flexFlowProperty: CssProperty<Style, FlexFlow>;
+export const flexProperty: CssProperty<Style, Flex>;