NativeScript/tns-core-modules/ui/core/properties.d.ts

declare module "ui/core/properties" {
    import { ViewBase } from "ui/core/view-base";
    import { Style } from "ui/styling/style";
    
    export { Style };

    //@private
    export function _isSet(cssProperty: CssProperty<any, any>, instance: Style): boolean;
    //@endprivate

    /**
     * Value specifing that Property should be set to its initial value.
     */
    export const unsetValue: any;

    export interface PropertyOptions<T, U> {
        readonly name: string;
        readonly defaultValue?: U;
        readonly affectsLayout?: boolean;
        readonly equalityComparer?: (x: U, y: U) => boolean;
        readonly valueChanged?: (target: T, oldValue: U, newValue: U) => void;
        readonly valueConverter?: (value: string) => U;
    }

    export interface CoerciblePropertyOptions<T, U> extends PropertyOptions<T, U> {
        readonly coerceValue: (t: T, u: U) => U;
    }

    export interface CssPropertyOptions<T extends Style, U> extends PropertyOptions<T, U> {
        readonly cssName: string;
    }

    export interface CssAnimationPropertyOptions<T, U> {
        readonly name: string;
        readonly cssName?: string;
        readonly defaultValue?: U;
        readonly equalityComparer?: (x: U, y: U) => boolean;
        readonly valueChanged?: (target: T, oldValue: U, newValue: U) => void;
        readonly valueConverter?: (value: string) => U;
    }

    export class CssAnimationProperty<T extends Style, U> {
        constructor(options: CssAnimationPropertyOptions<T, U>);

        public readonly name: string;
        public readonly cssName: string;
        public readonly native: symbol;

        readonly keyframe: string;

        public register(cls: { prototype: T }): void;

        public _valueConverter?: (value: string) => any;
        public static _getByCssName(name: string): CssAnimationProperty<any, any>;
    }

    export class Property<T extends ViewBase, U> implements TypedPropertyDescriptor<U> {
        constructor(options: PropertyOptions<T, U>);

        public readonly native: symbol;
        public readonly defaultValue: U;
        public register(cls: { prototype: T }): void;
        public nativeValueChange(T, U): void;
    }

    export class CoercibleProperty<T extends ViewBase, U> extends Property<T, U> implements TypedPropertyDescriptor<U> {
        constructor(options: CoerciblePropertyOptions<T, U>);

        public readonly coerce: (target: T) => void;
    }

    export class InheritedProperty<T extends ViewBase, U> extends Property<T, U> {
        constructor(options: PropertyOptions<T, U>);
    }

    export class CssProperty<T extends Style, U> {
        constructor(options: CssPropertyOptions<T, U>);

        public readonly native: symbol;
        public readonly name: string;
        public readonly cssName: string;
        public readonly defaultValue: U;
        public register(cls: { prototype: T }): void;
    }

    export class InheritedCssProperty<T extends Style, U> extends CssProperty<T, U> {
        constructor(options: CssPropertyOptions<T, U>);
    }

    export interface ShorthandPropertyOptions<P> {
        readonly name: string,
        readonly cssName: string;
        readonly converter: (value: string | P) => [CssProperty<any, any>, any][],
        readonly getter: (this: Style) => string | P
    }

    export class ShorthandProperty<T extends Style, P> {
        constructor(options: ShorthandPropertyOptions<P>);

        public readonly native: symbol;
        public readonly name: string;
        public readonly cssName: string;
        public register(cls: { prototype: T }): void;
    }

    export function initNativeView(view: ViewBase): void;
    export function resetNativeView(view: ViewBase): void;
    export function resetCSSProperties(style: Style): void;
    export function propagateInheritableProperties(view: ViewBase): void;
    export function propagateInheritableCssProperties(style: Style): void;

    export function makeValidator<T>(...values: T[]): (value: any) => value is T;
    export function makeParser<T>(isValid: (value: any) => boolean): (value: any) => T;
}