Hierarchy

Properties

thumbOffColor?: IColor

Gets/sets color of the thumb when Switch is OFF. It is set to gray by default. thumbOffColor deprecated 1.1.8 use android.thumbOffColor instead.

Property

Android

Deprecated

Since

1.1.8

toggleImage: string | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>

Gets/sets the toggle image of the switch. This property should be used before assigning colors.

Property

Android

Since

3.2.1

thumbImage: string | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>

Gets/sets the thumb image of the switch. This property should be used before assigning colors.

Property

Android

Since

3.2.1

toggleOffColor: IColor

Gets/sets the background of the switch when it is OFF. It is set to gray by default. This property works only for Android.

Example

import Switch from '@smartface/native/ui/switch';
import Color from '@smartface/native/ui/color';
var mySwitch = new Switch();
mySwitch.android.toggleOffColor = Color.DARKGRAY;

Property

Android

Deprecated

Since

0.1

yogaNode: any
overScrollMode: number

Gets/sets over-scroll mode for this view.

Property

= UI.Android.OverScrollMode.ALWAYS]

Android

Since

3.0.2

useForeground: boolean

Gets/sets foreground of the view for ripple effect. This property should be set before rippleColor. This property only supported for api level 23 and above.

Property

= false]

Android

Member

UI.View

Since

4.0.2

rippleEnabled: boolean

Gets/sets ripple effect enabled for view. You should set UI.View#rippleColor rippleColor to see the effect.

Property

= false]

Android

Member

UI.View

Since

3.2.1

rippleColor: IColor

Gets/sets ripple effect color for view.

Property

Android

Member

UI.View

Since

3.2.1

elevation: number

Gets/Sets the elevation of the view. For the views that has StateListAnimator natively like Button, will lost its own StateListAnimation when elevation value changed. For details : https://developer.android.com/training/material/shadows-clipping.html

Property

Android

Member

UI.View

See

Since

1.1.12

zIndex: number

Gets/sets the depth location of the view relative to its elevation. To put view over button, you have to change zIndex value after Android Lollipop. On android, default elevation value of button is bigger than other view. This property affects after Android Lollipop. No-op before api level 21.

Property

Android

Member

UI.View

Since

2.0.8

borderTopLeftRadius: number

Sets/gets top-left corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderTopRightRadius: number

Sets/gets top-right corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderTopStartRadius: number

Sets/gets top-start corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderTopEndRadius: number

Sets/gets top-end corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderBottomLeftRadius: number

Sets/gets bottom-left corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderBottomRightRadius: number

Sets/gets bottom-right corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderBottomStartRadius: number

Sets/gets bottom-start corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderBottomEndRadius: number

Sets/gets bottom-end corner radius of a view.

Property

= -1]

Android

Since

5.1.1

updateRippleEffectIfNeeded: (() => void)

Type declaration

    • (): void
    • Returns void

Generated using TypeDoc