@nativescript/core
- Version 8.8.6
- Published
- 25.2 MB
- 7 dependencies
- Apache-2.0 license
Install
npm i @nativescript/core
yarn add @nativescript/core
pnpm add @nativescript/core
Overview
A JavaScript library providing an easy to use api for interacting with iOS and Android platform APIs.
Index
Variables
- addCss
- android
- androidDynamicElevationOffsetProperty
- androidElevationProperty
- AnimationCurve
- Application
- autocapitalizationTypeProperty
- autocorrectProperty
- backgroundColorProperty
- backgroundEvent
- backgroundImageProperty
- backgroundInternalProperty
- backgroundPositionProperty
- backgroundProperty
- backgroundRepeatProperty
- backgroundSizeProperty
- borderBottomColorProperty
- borderBottomLeftRadiusProperty
- borderBottomRightRadiusProperty
- borderBottomWidthProperty
- borderColorProperty
- borderLeftColorProperty
- borderLeftWidthProperty
- borderRadiusProperty
- borderRightColorProperty
- borderRightWidthProperty
- borderTopColorProperty
- borderTopLeftRadiusProperty
- borderTopRightRadiusProperty
- borderTopWidthProperty
- borderWidthProperty
- clipPathProperty
- colorProperty
- CSSHelper
- Device
- Dialogs
- discardedErrorEvent
- displayedEvent
- editableProperty
- Enums
- exitEvent
- fontFamilyProperty
- fontInternalProperty
- fontScaleChangedEvent
- fontScaleInternalProperty
- fontSizeProperty
- fontStyleProperty
- fontVariationSettingsProperty
- fontWeightProperty
- foregroundEvent
- getCssFileName
- getMainEntry
- getNativeApplication
- getResources
- getRootView
- hasLaunched
- hasListeners
- heightProperty
- hintProperty
- horizontalAlignmentProperty
- inBackground
- ios
- isAndroid
- isIOS
- isUserInteractionEnabledProperty
- keyboardTypeProperty
- launchEvent
- letterSpacingProperty
- lineHeightProperty
- loadAppCss
- lowMemoryEvent
- marginBottomProperty
- marginLeftProperty
- marginProperty
- marginRightProperty
- marginTopProperty
- maxLengthProperty
- minHeightProperty
- minWidthProperty
- notify
- off
- on
- opacityProperty
- orientation
- orientationChangedEvent
- paddingBottomProperty
- paddingLeftProperty
- paddingProperty
- paddingRightProperty
- paddingTopProperty
- placeholderColorProperty
- platformNames
- resetRootView
- resumeEvent
- returnKeyTypeProperty
- rotateProperty
- run
- scaleXProperty
- scaleYProperty
- setAutoSystemAppearanceChanged
- setCssFileName
- setMaxRefreshRate
- setResources
- suspended
- suspendEvent
- systemAppearance
- systemAppearanceChanged
- systemAppearanceChangedEvent
- textAlignmentProperty
- textDecorationProperty
- textOverflowProperty
- textShadowProperty
- textStrokeProperty
- textTransformProperty
- translateXProperty
- translateYProperty
- uncaughtErrorEvent
- unsetValue
- updateTextTriggerProperty
- verticalAlignmentProperty
- visibilityProperty
- whiteSpaceProperty
- widthProperty
- zeroLength
- zIndexProperty
Functions
- action()
- addTaggedAdditionalCSS()
- addWeakEventListener()
- alert()
- animationTimingFunctionConverter()
- booleanConverter()
- confirm()
- CSSType()
- eachDescendant()
- fromObject()
- fromObjectRecursive()
- getAncestor()
- getCurrentPage()
- getFileAccess()
- getRootLayout()
- getTransformedText()
- getViewById()
- isEmbedded()
- login()
- makeParser()
- makeValidator()
- parseCSSShadow()
- parseKeyframeDeclarations()
- profile()
- profilingDisable()
- profilingDumpProfiles()
- profilingEnable()
- profilingIsRunning()
- profilingResetProfiles()
- profilingStart()
- profilingStartCPU()
- profilingStop()
- profilingStopCPU()
- profilingTime()
- profilingUptime()
- prompt()
- PseudoClassHandler()
- querySelectorAll()
- removeTaggedAdditionalCSS()
- removeWeakEventListener()
- resolveFileNameFromUrl()
- sanitizeModuleName()
- setActivityCallbacks()
- timeConverter()
- transformConverter()
Classes
AndroidApplication
- activityBackPressedEvent
- activityBackPressedEvent
- activityCreatedEvent
- activityCreatedEvent
- activityDestroyedEvent
- activityDestroyedEvent
- activityNewIntentEvent
- activityNewIntentEvent
- activityPausedEvent
- activityPausedEvent
- activityRequestPermissionsEvent
- activityRequestPermissionsEvent
- activityResultEvent
- activityResultEvent
- activityResumedEvent
- activityResumedEvent
- activityStartedEvent
- activityStartedEvent
- activityStoppedEvent
- activityStoppedEvent
- backgrounded
- context
- foregroundActivity
- getNativeApplication()
- getRegisteredBroadcastReceiver()
- nativeApp
- on()
- packageName
- paused
- registerBroadcastReceiver()
- saveActivityStateEvent
- saveActivityStateEvent
- startActivity
- unregisterBroadcastReceiver()
ApplicationCommon
- addCss()
- android
- AndroidApplication
- applyCssClass()
- autoSystemAppearanceChanged
- backgroundEvent
- createRootView()
- cssChangedEvent
- discardedErrorEvent
- displayedEvent
- exitEvent
- fontScaleChangedEvent
- foregroundEvent
- getCssFileName()
- getMainEntry()
- getNativeApplication()
- getOrientation()
- getResources()
- getRootView()
- getSystemAppearance()
- hasLaunched()
- hasListeners
- hasListeners
- inBackground
- initRootView()
- initRootViewEvent
- ios
- iOSApplication
- launchEvent
- livesyncEvent
- loadAppCss()
- loadAppCssEvent
- lowMemoryEvent
- mainEntry
- notify
- notify
- notifyLaunch()
- off
- off
- on
- on
- once
- once
- orientation()
- orientationChanged()
- orientationChangedEvent
- resetRootView()
- resumeEvent
- run()
- setAutoSystemAppearanceChanged()
- setCssFileName()
- setInBackground()
- setMaxRefreshRate()
- setOrientation()
- setResources()
- setSuspended()
- setSystemAppearance()
- started
- suspended
- suspendEvent
- systemAppearance()
- systemAppearanceChanged()
- systemAppearanceChangedEvent
- uncaughtErrorEvent
Background
- borderBottomColor
- borderBottomLeftRadius
- borderBottomRightRadius
- borderBottomWidth
- borderLeftColor
- borderLeftWidth
- borderRightColor
- borderRightWidth
- borderTopColor
- borderTopLeftRadius
- borderTopRightRadius
- borderTopWidth
- boxShadow
- clearFlags
- clipPath
- color
- default
- equals()
- getBoxShadow()
- getUniformBorderColor()
- getUniformBorderRadius()
- getUniformBorderWidth()
- hasBorder()
- hasBorderColor()
- hasBorderRadius()
- hasBorderWidth()
- hasBoxShadow()
- hasUniformBorder()
- hasUniformBorderColor()
- hasUniformBorderRadius()
- hasUniformBorderWidth()
- image
- isEmpty()
- position
- repeat
- size
- toString()
- withBorderBottomColor()
- withBorderBottomLeftRadius()
- withBorderBottomRightRadius()
- withBorderBottomWidth()
- withBorderLeftColor()
- withBorderLeftWidth()
- withBorderRightColor()
- withBorderRightWidth()
- withBorderTopColor()
- withBorderTopLeftRadius()
- withBorderTopRightRadius()
- withBorderTopWidth()
- withBoxShadow()
- withClipPath()
- withColor()
- withImage()
- withPosition()
- withRepeat()
- withSize()
Frame
- actionBarVisibility
- android
- animated
- backStack
- canGoBack()
- currentEntry
- currentPage
- defaultAnimatedNavigation
- defaultTransition
- getFrameById()
- goBack()
- ios
- iosNavigationBarClass
- iosToolBarClass
- isCurrent()
- navigate()
- navigatedToEvent
- navigatingToEvent
- navigationBarHeight
- navigationQueueIsEmpty()
- on()
- performNavigation()
- reloadPage()
- setCurrent()
- topmost()
- transition
ImageSource
- android
- fromAsset()
- fromBase64()
- fromBase64Sync()
- fromData()
- fromDataSync()
- fromFile()
- fromFileOrResourceSync()
- fromFileSync()
- fromFontIconCodeSync()
- fromResource()
- fromResourceSync()
- fromSystemImage()
- fromSystemImageSync()
- fromUrl()
- height
- ios
- iosSymbolScaleFor()
- loadFromBase64()
- loadFromData()
- loadFromFile()
- loadFromFontIconCode()
- loadFromResource()
- resize()
- resizeAsync()
- rotationAngle
- saveToFile()
- saveToFileAsync()
- setNativeSource()
- toBase64String()
- toBase64StringAsync()
- width
Page
- accessibilityAnnouncePageEnabled
- accessibilityScreenChanged()
- actionBar
- actionBarHidden
- androidStatusBarBackground
- backgroundSpanUnderStatusBar
- enableSwipeBackNavigation
- frame
- getKeyframeAnimationWithName()
- hasActionBar
- navigatedFromEvent
- navigatedToEvent
- navigatingFromEvent
- navigatingToEvent
- navigationContext
- on()
- onAccessibilityPerformEscape
- onNavigatedFrom()
- onNavigatedTo()
- onNavigatingFrom()
- onNavigatingTo()
- statusBarStyle
PageBase
- accessibilityAnnouncePageEnabled
- accessibilityScreenChanged()
- actionBar
- actionBarHidden
- androidStatusBarBackground
- backgroundSpanUnderStatusBar
- eachChildView()
- enableSwipeBackNavigation
- frame
- getKeyframeAnimationWithName()
- hasActionBar
- navigatedFromEvent
- navigatedToEvent
- navigatingFromEvent
- navigatingToEvent
- navigationContext
- onNavigatedFrom()
- onNavigatedTo()
- onNavigatingFrom()
- onNavigatingTo()
- page
- statusBarStyle
Style
- accessibilityHidden
- accessibilityLanguage
- accessibilityLiveRegion
- accessibilityMediaSession
- accessibilityRole
- accessibilityState
- accessibilityStep
- accessible
- alignContent
- alignItems
- alignSelf
- androidContentInset
- androidContentInsetLeft
- androidContentInsetRight
- androidDynamicElevationOffset
- androidElevation
- androidSelectedTabHighlightColor
- androidStatusBarBackground
- background
- backgroundColor
- backgroundImage
- backgroundInternal
- backgroundPosition
- backgroundRepeat
- backgroundSize
- borderBottomColor
- borderBottomLeftRadius
- borderBottomRightRadius
- borderBottomWidth
- borderColor
- borderLeftColor
- borderLeftWidth
- borderRadius
- borderRightColor
- borderRightWidth
- borderTopColor
- borderTopLeftRadius
- borderTopRightRadius
- borderTopWidth
- borderWidth
- boxShadow
- clipPath
- color
- flexDirection
- flexGrow
- flexShrink
- flexWrap
- flexWrapBefore
- font
- fontFamily
- fontInternal
- fontScaleInternal
- fontSize
- fontStyle
- fontVariationSettings
- fontWeight
- getCssVariable()
- height
- horizontalAlignment
- iosAccessibilityAdjustsFontSize
- iosAccessibilityMaxFontScale
- iosAccessibilityMinFontScale
- justifyContent
- letterSpacing
- lineHeight
- margin
- marginBottom
- marginLeft
- marginRight
- marginTop
- maxLines
- minHeight
- minWidth
- opacity
- order
- padding
- paddingBottom
- paddingLeft
- paddingRight
- paddingTop
- perspective
- placeholderColor
- PropertyBag
- removeScopedCssVariable()
- removeUnscopedCssVariable()
- resetScopedCssVariables()
- resetUnscopedCssVariables()
- rotate
- rotateX
- rotateY
- scaleX
- scaleY
- selectedBackgroundColor
- selectedTabTextColor
- selectedTextColor
- separatorColor
- setScopedCssVariable()
- setUnscopedCssVariable()
- statusBarStyle
- tabBackgroundColor
- tabTextColor
- tabTextFontSize
- textAlignment
- textDecoration
- textOverflow
- textShadow
- textStroke
- textTransform
- tintColor
- toString()
- translateX
- translateY
- verticalAlignment
- view
- viewRef
- visibility
- whiteSpace
- width
- zIndex
Transition
- androidFragmentTransactionCallback()
- AndroidTransitionType
- animateIOSTransition()
- createAndroidAnimator()
- getCurve()
- getDuration()
- id
- interactiveController
- iosDismissedController()
- iosInteractionDismiss()
- iosInteractionPresented()
- iosNavigatedController()
- iosPresentedController()
- name
- presented
- presenting
- setDuration()
- setupInteractiveGesture()
- sharedElements
- transitionController
View
- accessibilityAnnouncement()
- accessibilityBlurEvent
- accessibilityFocusChangedEvent
- accessibilityFocusEvent
- accessibilityHidden
- accessibilityHint
- accessibilityIdentifier
- accessibilityLabel
- accessibilityLanguage
- accessibilityLiveRegion
- accessibilityMediaSession
- accessibilityRole
- accessibilityScreenChanged()
- accessibilityState
- accessibilityValue
- accessible
- addCss()
- addCssFile()
- android
- androidDynamicElevationOffset
- androidElevation
- animate()
- automationText
- background
- backgroundColor
- backgroundImage
- bindingContext
- borderBottomColor
- borderBottomLeftRadius
- borderBottomRightRadius
- borderBottomWidth
- borderColor
- borderLeftColor
- borderLeftWidth
- borderRadius
- borderRightColor
- borderRightWidth
- borderTopColor
- borderTopLeftRadius
- borderTopRightRadius
- borderTopWidth
- borderWidth
- boxShadow
- changeCssFile()
- color
- combineMeasuredStates()
- createAnimation()
- css
- cssClasses
- cssPseudoClasses
- cssType
- eachChildView()
- focus()
- getActualSize()
- getGestureObservers()
- getLocationInWindow()
- getLocationOnScreen()
- getLocationRelativeTo()
- getMeasuredHeight()
- getMeasuredState()
- getMeasuredWidth()
- getSafeAreaInsets()
- hasGestureObservers()
- height
- horizontalAlignment
- ios
- iosAccessibilityAdjustsFontSize
- iosAccessibilityMaxFontScale
- iosAccessibilityMinFontScale
- iosIgnoreSafeArea
- iosOverflowSafeArea
- iosOverflowSafeAreaEnabled
- isEnabled
- isLayoutRequired
- isLayoutValid
- isUserInteractionEnabled
- layout()
- layoutChangedEvent
- layoutChild()
- layoutNativeView()
- margin
- marginBottom
- marginLeft
- marginRight
- marginTop
- measure()
- measureChild()
- minHeight
- minWidth
- modal
- needsNativeDrawableFill
- off()
- on()
- onBackPressed()
- onLayout()
- onMeasure()
- opacity
- originX
- originY
- perspective
- resolveSizeAndState()
- rotate
- rotateX
- rotateY
- scaleX
- scaleY
- sendAccessibilityEvent()
- setMeasuredDimension()
- setOnTouchListener()
- showingModallyEvent
- shownModallyEvent
- translateX
- translateY
- verticalAlignment
- visibility
- width
ViewBase
- ['class']
- addPseudoClass()
- alignSelf
- android
- bind()
- bindingContext
- callLoaded()
- callUnloaded()
- className
- closeModal()
- col
- colSpan
- column
- columnSpan
- createdEvent
- createNativeView()
- cssClasses
- cssPseudoClasses
- defaultVisualState
- deletePseudoClass()
- destroyNode()
- disposeNativeView()
- disposeNativeViewEvent
- dock
- domNode
- eachChild()
- effectiveBorderBottomWidth
- effectiveBorderLeftWidth
- effectiveBorderRightWidth
- effectiveBorderTopWidth
- effectiveHeight
- effectiveLeft
- effectiveMarginBottom
- effectiveMarginLeft
- effectiveMarginRight
- effectiveMarginTop
- effectiveMinHeight
- effectiveMinWidth
- effectivePaddingBottom
- effectivePaddingLeft
- effectivePaddingRight
- effectivePaddingTop
- effectiveTop
- effectiveWidth
- ensureDomNode()
- flexGrow
- flexShrink
- flexWrapBefore
- getViewByDomId()
- getViewById()
- id
- initNativeView()
- ios
- isCollapsed
- isLoaded
- left
- loadedEvent
- loadView()
- mIsRootView
- nativeView
- nativeViewProtected
- onLoaded()
- onResumeNativeUpdates()
- onUnloaded()
- order
- page
- parent
- parentNode
- recycleNativeView
- requestLayout()
- resetNativeView()
- reusable
- row
- rowSpan
- set()
- setInlineStyle()
- setNativeView()
- sharedTransitionIgnore
- sharedTransitionTag
- showModal()
- style
- top
- toString()
- typeName
- unbind()
- unloadedEvent
- unloadView()
- viewController
- visualState
Interfaces
Enums
ImageSymbolEffects
- Appear
- AppearDown
- AppearUp
- Bounce
- BounceDown
- BounceUp
- Breathe
- BreathePlain
- BreathePulse
- Disappear
- DisappearDown
- DisappearUp
- Pulse
- Rotate
- RotateClockwise
- RotateCounterClockwise
- Scale
- ScaleDown
- ScaleUp
- VariableColor
- Wiggle
- WiggleBackward
- WiggleClockwise
- WiggleCounterClockwise
- WiggleDown
- WiggleForward
- WiggleLeft
- WiggleRight
- WiggleUp
Type Aliases
Namespaces
CoreTypes
- AutocapitalizationInputType
- AutofillType
- BackgroundRepeatType
- DeviceOrientationType
- dip
- DockType
- HorizontalAlignmentType
- ImageStretchType
- KeyboardInputType
- LengthDipUnit
- LengthPercentUnit
- LengthPxUnit
- LengthType
- MaxLinesType
- OrientationType
- percent
- PercentLengthType
- px
- ReturnKeyButtonType
- TextAlignmentType
- TextDecorationType
- TextOverflowType
- TextTransformType
- UpdateTextTriggerType
- VerticalAlignmentTextType
- VerticalAlignmentType
- VisibilityType
- WhiteSpaceType
- zeroLength
IOSHelper
- expandBeyondSafeArea()
- getFrameFromPosition()
- getParentWithViewController()
- getPositionFromFrame()
- layoutView()
- shrinkToSafeArea()
- traitCollectionColorAppearanceChangedEvent
- UIAdaptivePresentationControllerDelegateImp
- UILayoutViewController
- UIPopoverPresentationControllerDelegateImp
- updateAutoAdjustScrollInsets()
- updateConstraints()
Utils
- ClassInfo
- clearInterval()
- clearTimeout()
- convertString()
- copyToClipboard()
- CORE_ANIMATION_DEFAULTS
- dataDeserialize()
- dataSerialize()
- debounce()
- debug
- dismissKeyboard()
- dismissSoftInput()
- dispatchToMainThread()
- dispatchToUIThread()
- eliminateDuplicates()
- escapeRegexSymbols()
- executeOnMainThread()
- executeOnUIThread()
- FILE_PREFIX
- GC()
- getBaseClasses()
- getClass()
- getClassInfo()
- getDurationWithDampingFromSpring()
- getFileExtension()
- getModuleName()
- hasDuplicates()
- isBoolean()
- isDataURI()
- isDefined()
- isEmoji()
- isFileOrResourcePath()
- isFontIconURI()
- isFunction()
- isMainThread()
- isNullOrUndefined()
- isNumber()
- isObject()
- isRealDevice()
- isString()
- isUndefined()
- mainThreadify()
- merge()
- mergeSort()
- numberHasDecimals()
- numberIs64Bit()
- openFile()
- openUrl()
- queueGC()
- queueMacrotask()
- releaseNativeObject()
- RESOURCE_PREFIX
- sanitizeModuleName()
- ScopeError
- SDK_VERSION
- setInterval()
- setTimeout()
- Source
- SourceError
- SYSTEM_PREFIX
- throttle()
- toUIString()
- verifyCallback()
Variables
variable addCss
const addCss: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.addCss()
variable android
const android: AndroidApplication;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.android
variable androidDynamicElevationOffsetProperty
const androidDynamicElevationOffsetProperty: CssProperty<Style, number>;
variable androidElevationProperty
const androidElevationProperty: CssProperty<Style, number>;
variable AnimationCurve
const AnimationCurve: typeof CoreTypes.AnimationCurve;
Deprecated
Use
CoreTypes.AnimationCurve
instead.
variable Application
const Application: ApplicationCommon;
variable autocapitalizationTypeProperty
const autocapitalizationTypeProperty: Property< EditableTextBase, CoreTypes.AutocapitalizationInputType>;
variable autocorrectProperty
const autocorrectProperty: Property<EditableTextBase, boolean>;
variable backgroundColorProperty
const backgroundColorProperty: CssAnimationProperty<Style, Color>;
variable backgroundEvent
const backgroundEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.backgroundEvent
variable backgroundImageProperty
const backgroundImageProperty: CssProperty<Style, string>;
variable backgroundInternalProperty
const backgroundInternalProperty: CssProperty<Style, Background>;
variable backgroundPositionProperty
const backgroundPositionProperty: CssProperty<Style, string>;
variable backgroundProperty
const backgroundProperty: ShorthandProperty<Style, string>;
variable backgroundRepeatProperty
const backgroundRepeatProperty: CssProperty<Style, CoreTypes.BackgroundRepeatType>;
variable backgroundSizeProperty
const backgroundSizeProperty: CssProperty<Style, string>;
variable borderBottomColorProperty
const borderBottomColorProperty: CssProperty<Style, Color>;
variable borderBottomLeftRadiusProperty
const borderBottomLeftRadiusProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderBottomRightRadiusProperty
const borderBottomRightRadiusProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderBottomWidthProperty
const borderBottomWidthProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderColorProperty
const borderColorProperty: ShorthandProperty<Style, string | Color>;
variable borderLeftColorProperty
const borderLeftColorProperty: CssProperty<Style, Color>;
variable borderLeftWidthProperty
const borderLeftWidthProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderRadiusProperty
const borderRadiusProperty: ShorthandProperty< Style, string | number | CoreTypes.LengthDipUnit | CoreTypes.LengthPxUnit>;
variable borderRightColorProperty
const borderRightColorProperty: CssProperty<Style, Color>;
variable borderRightWidthProperty
const borderRightWidthProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderTopColorProperty
const borderTopColorProperty: CssProperty<Style, Color>;
variable borderTopLeftRadiusProperty
const borderTopLeftRadiusProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderTopRightRadiusProperty
const borderTopRightRadiusProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderTopWidthProperty
const borderTopWidthProperty: CssProperty<Style, CoreTypes.LengthType>;
variable borderWidthProperty
const borderWidthProperty: ShorthandProperty< Style, string | number | CoreTypes.LengthDipUnit | CoreTypes.LengthPxUnit>;
variable clipPathProperty
const clipPathProperty: CssProperty<Style, string>;
variable colorProperty
const colorProperty: InheritedCssProperty<Style, Color>;
variable CSSHelper
const CSSHelper: { createSelector: typeof createSelector; SelectorCore: typeof SelectorCore; SimpleSelector: typeof SimpleSelector; InvalidSelector: typeof InvalidSelector; UniversalSelector: typeof UniversalSelector; TypeSelector: typeof TypeSelector; ClassSelector: typeof ClassSelector; AttributeSelector: typeof AttributeSelector; PseudoClassSelector: typeof PseudoClassSelector; SimpleSelectorSequence: typeof SimpleSelectorSequence; Selector: typeof Selector; RuleSet: typeof RuleSet; SelectorScope: typeof SelectorScope; MediaQuerySelectorScope: typeof MediaQuerySelectorScope; StyleSheetSelectorScope: typeof StyleSheetSelectorScope; fromAstNode: typeof fromAstNode; SelectorsMatch: typeof SelectorsMatch;};
variable Device
const Device: IDevice;
Gets the current device information.
variable Dialogs
const Dialogs: { alert: typeof alert; confirm: typeof confirm; prompt: typeof prompt; login: typeof login; action: typeof action;};
Singular rollup for convenience of all dialog methods
variable discardedErrorEvent
const discardedErrorEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.discardedErrorEvent
variable displayedEvent
const displayedEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.displayedEvent
variable editableProperty
const editableProperty: Property<EditableTextBase, boolean>;
variable Enums
const Enums: { Accuracy: typeof CoreTypes.Accuracy; AndroidActionBarIconVisibility: typeof CoreTypes.AndroidActionBarIconVisibility; AndroidActionItemPosition: typeof CoreTypes.AndroidActionItemPosition; AnimationCurve: typeof CoreTypes.AnimationCurve; AutocapitalizationType: typeof CoreTypes.AutocapitalizationType; BackgroundRepeat: typeof CoreTypes.BackgroundRepeat; DeviceOrientation: typeof CoreTypes.DeviceOrientation; DeviceType: typeof CoreTypes.DeviceType; Dock: typeof CoreTypes.Dock; FontAttributes: typeof CoreTypes.FontAttributes; FontStyle: typeof CoreTypes.FontStyle; FontWeight: typeof CoreTypes.FontWeight; HorizontalAlignment: typeof CoreTypes.HorizontalAlignment; IOSActionItemPosition: typeof CoreTypes.IOSActionItemPosition; ImageFormat: typeof CoreTypes.ImageFormat; KeyboardType: typeof CoreTypes.KeyboardType; NavigationBarVisibility: typeof CoreTypes.NavigationBarVisibility; Orientation: typeof CoreTypes.Orientation; ReturnKeyType: typeof CoreTypes.ReturnKeyType; StatusBarStyle: typeof CoreTypes.StatusBarStyle; Stretch: typeof CoreTypes.ImageStretch; SystemAppearance: typeof CoreTypes.SystemAppearance; TextAlignment: typeof CoreTypes.TextAlignment; TextDecoration: typeof CoreTypes.TextDecoration; TextTransform: typeof CoreTypes.TextTransform; UpdateTextTrigger: typeof CoreTypes.UpdateTextTrigger; VerticalAlignment: typeof CoreTypes.VerticalAlignment; Visibility: typeof CoreTypes.Visibility; WhiteSpace: typeof CoreTypes.WhiteSpace;};
Deprecated
Use
CoreTypes
instead. Enums will be removed in 9.0
variable exitEvent
const exitEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.exitEvent
variable fontFamilyProperty
const fontFamilyProperty: InheritedCssProperty<Style, string>;
variable fontInternalProperty
const fontInternalProperty: InheritedCssProperty<Style, Font>;
variable fontScaleChangedEvent
const fontScaleChangedEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.fontScaleChangedEvent
variable fontScaleInternalProperty
const fontScaleInternalProperty: InheritedCssProperty<Style, number>;
variable fontSizeProperty
const fontSizeProperty: InheritedCssProperty<Style, number>;
variable fontStyleProperty
const fontStyleProperty: InheritedCssProperty<Style, FontStyleType>;
variable fontVariationSettingsProperty
const fontVariationSettingsProperty: InheritedCssProperty< Style, FontVariationSettingsType[]>;
variable fontWeightProperty
const fontWeightProperty: InheritedCssProperty<Style, FontWeightType>;
variable foregroundEvent
const foregroundEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.foregroundEvent
variable getCssFileName
const getCssFileName: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.getCssFileName()
variable getMainEntry
const getMainEntry: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.getMainEntry()
variable getNativeApplication
const getNativeApplication: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.getNativeApplication()
variable getResources
const getResources: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.getResources()
variable getRootView
const getRootView: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.getRootView()
variable hasLaunched
const hasLaunched: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.hasLaunched()
variable hasListeners
const hasListeners: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.hasListeners()
variable heightProperty
const heightProperty: CssAnimationProperty<Style, CoreTypes.PercentLengthType>;
variable hintProperty
const hintProperty: Property<EditableTextBase, string>;
variable horizontalAlignmentProperty
const horizontalAlignmentProperty: CssProperty< Style, CoreTypes.HorizontalAlignmentType>;
variable inBackground
const inBackground: boolean;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.inBackground
variable ios
const ios: iOSApplication;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.ios
variable isAndroid
const isAndroid: boolean;
Gets a value indicating if the app is running on the Android platform.
variable isIOS
const isIOS: boolean;
Gets a value indicating if the app is running on the iOS platform.
variable isUserInteractionEnabledProperty
const isUserInteractionEnabledProperty: Property<View, boolean>;
variable keyboardTypeProperty
const keyboardTypeProperty: Property<EditableTextBase, CoreTypes.KeyboardInputType>;
variable launchEvent
const launchEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.launchEvent
variable letterSpacingProperty
const letterSpacingProperty: CssProperty<Style, number>;
variable lineHeightProperty
const lineHeightProperty: CssProperty<Style, number>;
variable loadAppCss
const loadAppCss: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.loadAppCss()
variable lowMemoryEvent
const lowMemoryEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.lowMemoryEvent
variable marginBottomProperty
const marginBottomProperty: CssProperty<Style, CoreTypes.PercentLengthType>;
variable marginLeftProperty
const marginLeftProperty: CssProperty<Style, CoreTypes.PercentLengthType>;
variable marginProperty
const marginProperty: ShorthandProperty< Style, | string | number | CoreTypes.LengthDipUnit | CoreTypes.LengthPxUnit | CoreTypes.LengthPercentUnit>;
variable marginRightProperty
const marginRightProperty: CssProperty<Style, CoreTypes.PercentLengthType>;
variable marginTopProperty
const marginTopProperty: CssProperty<Style, CoreTypes.PercentLengthType>;
variable maxLengthProperty
const maxLengthProperty: Property<EditableTextBase, number>;
variable minHeightProperty
const minHeightProperty: CssProperty< Style, number | CoreTypes.LengthDipUnit | CoreTypes.LengthPxUnit>;
variable minWidthProperty
const minWidthProperty: CssProperty< Style, number | CoreTypes.LengthDipUnit | CoreTypes.LengthPxUnit>;
variable notify
const notify: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.notify()
variable off
const off: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.off()
variable on
const on: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.on()
variable opacityProperty
const opacityProperty: CssAnimationProperty<Style, number>;
variable orientation
const orientation: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.orientation()
variable orientationChangedEvent
const orientationChangedEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.orientationChangedEvent
variable paddingBottomProperty
const paddingBottomProperty: CssProperty<Style, CoreTypes.LengthType>;
variable paddingLeftProperty
const paddingLeftProperty: CssProperty<Style, CoreTypes.LengthType>;
variable paddingProperty
const paddingProperty: ShorthandProperty< Style, string | number | CoreTypes.LengthDipUnit | CoreTypes.LengthPxUnit>;
variable paddingRightProperty
const paddingRightProperty: CssProperty<Style, CoreTypes.LengthType>;
variable paddingTopProperty
const paddingTopProperty: CssProperty<Style, CoreTypes.LengthType>;
variable placeholderColorProperty
const placeholderColorProperty: CssProperty<Style, Color>;
variable platformNames
const platformNames: { android: string; ios: string; visionos: string };
variable resetRootView
const resetRootView: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.resetRootView()
variable resumeEvent
const resumeEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.resumeEvent
variable returnKeyTypeProperty
const returnKeyTypeProperty: Property< EditableTextBase, CoreTypes.ReturnKeyButtonType>;
variable rotateProperty
const rotateProperty: CssAnimationProperty<Style, number>;
variable run
const run: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.run()
variable scaleXProperty
const scaleXProperty: CssAnimationProperty<Style, number>;
variable scaleYProperty
const scaleYProperty: CssAnimationProperty<Style, number>;
variable setAutoSystemAppearanceChanged
const setAutoSystemAppearanceChanged: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.setAutoSystemAppearanceChanged()
variable setCssFileName
const setCssFileName: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.setCssFileName()
variable setMaxRefreshRate
const setMaxRefreshRate: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.setMaxRefreshRate()
variable setResources
const setResources: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.setResources()
variable suspended
const suspended: boolean;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.suspended
variable suspendEvent
const suspendEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.suspendEvent
variable systemAppearance
const systemAppearance: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.systemAppearance()
variable systemAppearanceChanged
const systemAppearanceChanged: any;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.systemAppearanceChanged()
variable systemAppearanceChangedEvent
const systemAppearanceChangedEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.systemAppearanceChangedEvent
variable textAlignmentProperty
const textAlignmentProperty: InheritedCssProperty< Style, CoreTypes.TextAlignmentType>;
variable textDecorationProperty
const textDecorationProperty: CssProperty<Style, CoreTypes.TextDecorationType>;
variable textOverflowProperty
const textOverflowProperty: CssProperty<Style, CoreTypes.TextOverflowType>;
variable textShadowProperty
const textShadowProperty: CssProperty<Style, ShadowCSSValues>;
variable textStrokeProperty
const textStrokeProperty: CssProperty<Style, StrokeCSSValues>;
variable textTransformProperty
const textTransformProperty: CssProperty<Style, CoreTypes.TextTransformType>;
variable translateXProperty
const translateXProperty: CssAnimationProperty<Style, number>;
variable translateYProperty
const translateYProperty: CssAnimationProperty<Style, number>;
variable uncaughtErrorEvent
const uncaughtErrorEvent: string;
Deprecated
Deep imports into the Application module are deprecated and will be removed in a future release. Use the
Application
class imported from "@nativescript/core" instead:import { Application } from "@nativescript/core";Application.uncaughtErrorEvent
variable unsetValue
const unsetValue: any;
Value specifying that Property should be set to its initial value.
variable updateTextTriggerProperty
const updateTextTriggerProperty: Property< EditableTextBase, CoreTypes.UpdateTextTriggerType>;
variable verticalAlignmentProperty
const verticalAlignmentProperty: CssProperty<Style, CoreTypes.VerticalAlignmentType>;
variable visibilityProperty
const visibilityProperty: CssProperty<Style, CoreTypes.VisibilityType>;
variable whiteSpaceProperty
const whiteSpaceProperty: CssProperty<Style, CoreTypes.WhiteSpaceType>;
variable widthProperty
const widthProperty: CssAnimationProperty<Style, CoreTypes.PercentLengthType>;
variable zeroLength
const zeroLength: CoreTypes.LengthType;
variable zIndexProperty
const zIndexProperty: CssProperty<Style, number>;
Functions
function action
action: { ( message: string, cancelButtonText: string, actions: Array<string> ): Promise<string>; (options: ActionOptions): Promise<string>;};
The action() method displays a action box that prompts the visitor to choose some action.
Parameter message
The text to display in the dialog box.
Parameter cancelButtonText
The text to display in the cancel button.
Parameter actions
List of available actions.
The action() method displays a action box that prompts the visitor to choose some action.
Parameter options
The options for the dialog box.
function addTaggedAdditionalCSS
addTaggedAdditionalCSS: (cssText: string, tag?: string | Number) => boolean;
function addWeakEventListener
addWeakEventListener: ( source: Observable, eventName: string, handler: (eventData: EventData) => void, target: any) => void;
Attaches a WeakEventListener.
Parameter source
Observable class which emits the event.
Parameter eventName
The event name.
Parameter handler
The function which should be called when event occurs.
Parameter target
Subscriber (target) of the event listener. It will be used as a thisArg in the handler function.
function alert
alert: { (message: string | number | boolean): Promise<void>; (options: AlertOptions): Promise<void>;};
The alert() method displays an alert box with a specified message.
Parameter message
Specifies the text to display in the alert box.
The alert() method displays an alert box with a specified message.
Parameter options
Specifies the options for the alert box.
function animationTimingFunctionConverter
animationTimingFunctionConverter: (value: string) => any;
function booleanConverter
booleanConverter: (v: string | boolean) => boolean;
function confirm
confirm: { (message: string): Promise<boolean>; (options: ConfirmOptions): Promise<boolean>;};
The confirm() method displays a dialog box with a specified message.
Parameter message
Specifies the text to display in the confirm box.
The confirm() method displays a dialog box with a specified message.
Parameter options
Specifies the options for the confirm box.
function CSSType
CSSType: (type: string) => ClassDecorator;
Specifies the type name for the instances of this View class, that is used when matching CSS type selectors.
Usage:
@CSSType("Button")class Button extends View {}Internally the decorator set
Button.prototype.cssType = "Button"
.Parameter type
The type name, e. g. "Button", "Label", etc.
function eachDescendant
eachDescendant: ( view: ViewBaseDefinition, callback: (child: ViewBaseDefinition) => boolean) => void;
Iterates through all child views (via visual tree) and executes a function.
Parameter view
Starting view (parent container).
Parameter callback
A function to execute on every child. If function returns false it breaks the iteration.
function fromObject
fromObject: (source: any) => Observable;
Creates an Observable instance and sets its properties according to the supplied JavaScript object. param obj - A JavaScript object used to initialize nativescript Observable instance.
function fromObjectRecursive
fromObjectRecursive: (source: any) => Observable;
Creates an Observable instance and sets its properties according to the supplied JavaScript object. This function will create new Observable for each nested object (expect arrays and functions) from supplied JavaScript object. param obj - A JavaScript object used to initialize nativescript Observable instance.
function getAncestor
getAncestor: ( view: ViewBaseDefinition, criterion: string | { new (): any }) => ViewBaseDefinition;
Gets an ancestor from a given type.
Parameter view
Starting view (child view).
Parameter criterion
The type of ancestor view we are looking for. Could be a string containing a class name or an actual type. Returns an instance of a view (if found), otherwise undefined.
function getCurrentPage
getCurrentPage: () => Page;
function getFileAccess
getFileAccess: () => FileSystemAccess;
Returns FileSystemAccess, a shared singleton utility class to provide methods to access and work with the file system. This is used under the hood of all the file system apis in @nativescript/core and provided as a lower level convenience if needed.
Returns
FileSystemAccess
function getRootLayout
getRootLayout: () => RootLayout;
function getTransformedText
getTransformedText: ( text: string, textTransform: CoreTypes.TextTransformType) => string;
function getViewById
getViewById: (view: ViewBaseDefinition, id: string) => ViewBaseDefinition;
Gets a child view by id.
Parameter view
The parent (container) view of the view to look for.
Parameter id
The id of the view to look for. Returns an instance of a view (if found), otherwise undefined.
function isEmbedded
isEmbedded: () => boolean;
Whether the app is embedded into a host project or standalone project
function login
login: { ( message: string, userNameHint?: string, passwordHint?: string, userName?: string, password?: string ): Promise<LoginResult>; ( message: string, userNameHint?: string, passwordHint?: string ): Promise<LoginResult>; (options: LoginOptions): Promise<LoginResult>;};
The login() method displays a login dialog box that prompts the visitor for user name and password.
Parameter message
The text to display in the dialog box.
Parameter userNameHint
The default text to display as a hint in the username input. Optional.
Parameter passwordHint
The default text to display as a hint in the password input. Optional.
Parameter userName
The default text to display in the user name input box. Optional.
Parameter password
The default text to display in the password input box. Optional.
The login() method displays a login dialog box that prompts the visitor for user name and password.
Parameter message
The text to display in the dialog box.
Parameter userNameHint
The default text to display as a hint in the username input. Optional.
Parameter passwordHint
The default text to display as a hint in the password input. Optional.
The login() method displays a login dialog box that prompts the visitor for user name and password.
Parameter options
The options for the dialog box.
function makeParser
makeParser: <T>( isValid: (value: any) => boolean, allowNumbers?: boolean) => (value: any) => T;
function makeValidator
makeValidator: <T>(...values: T[]) => (value: any) => value is T;
function parseCSSShadow
parseCSSShadow: (value: string) => ShadowCSSValues;
Parse a string into ShadowCSSValues Supports any valid css box/text shadow combination.
inspired by https://github.com/jxnblk/css-box-shadow/blob/master/index.js (MIT License)
Parameter value
function parseKeyframeDeclarations
parseKeyframeDeclarations: ( unparsedKeyframeDeclarations: KeyframeDeclaration[]) => KeyframeDeclaration[];
function profile
profile: { (name?: string): MethodDecorator; <F extends Function>(fn: F): F; <F extends Function>(name: string, fn: F): F; <T>( target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T> ): void | TypedPropertyDescriptor<T>; (): any;};
Method decorator factory. It will intercept the method call and start and pause a timer before and after the method call. Works only if profiling is enabled.
Parameter name
Name of the timer which will be used for method calls. If not provided - the name of the method will be used.
Function factory. It will intercept the function call and start and pause a timer before and after the function call. Works only if profiling is enabled. Works only if profiling is enabled.
Parameter fn
The function to wrap. Uses the function name to track the times.
Function factory. It will intercept the function call and start and pause a timer before and after the function call. Works only if profiling is enabled.
Parameter name
The name used to track calls and times.
Parameter fn
The function to wrap.
Method decorator. It will intercept the method calls and start and pause a timer before and after the method call. Works only if profiling is enabled.
function profilingDisable
profilingDisable: () => void;
Disables profiling.
function profilingDumpProfiles
profilingDumpProfiles: () => void;
Prints the timer for all methods instrumented with profile decorator.
function profilingEnable
profilingEnable: (type?: InstrumentationMode) => void;
Enables profiling.
Upon loading of the module it will cache the package.json of the app and check if there is a "profiling" key set, its value can be one of the options available for InstrumentationMode, and if set, enable() will be called in pre app start with the value in the package.json.
An example for an
app/package.json
enabling the manual instrumentation profiling is:{"main": "main.js","profiling": "timeline"}Parameter type
Profiling mode to use. - "counters" - Accumulates method call counts and times until dumpProfiles is called and then prints aggregated statistic in the console. This is the default. - "timeline" - Outputs method names along start/end timestamps in the console on the go. - "lifecycle" - Outputs basic non-verbose times for startup, navigation, etc.
function profilingIsRunning
profilingIsRunning: (name: string) => boolean;
Returns true if a timer is currently running.
Parameter name
Name of the timer.
Returns
true is the timer is currently running.
function profilingResetProfiles
profilingResetProfiles: () => void;
Resets the timers for all methods instrumented with profile decorator.
function profilingStart
profilingStart: (name: string) => void;
Starts a timer with a specific name. Works only if profiling is enabled.
Parameter name
Name of the timer.
function profilingStartCPU
profilingStartCPU: (name: string) => void;
Starts android cpu profiling.
Parameter name
Name of the cpu profiling session.
function profilingStop
profilingStop: (name: string) => TimerInfo;
Pauses a timer with a specific name. This will increase call count and accumulate time. Works only if profiling is enabled.
Parameter name
Name of the timer.
Returns
TimerInfo for the paused timer.
function profilingStopCPU
profilingStopCPU: (name: string) => void;
Stops android cpu profiling.
Parameter name
Name of the cpu profiling session.
function profilingTime
profilingTime: () => number;
Gets accurate system timestamp in ms.
function profilingUptime
profilingUptime: () => number;
Gets the uptime of the current process in milliseconds.
function prompt
prompt: { (message: string, defaultText?: string): Promise<PromptResult>; (options: PromptOptions): Promise<PromptResult>;};
The prompt() method displays a dialog box that prompts the visitor for input.
Parameter message
The text to display in the dialog box.
Parameter defaultText
The default text to display in the input box. Optional.
The prompt() method displays a dialog box that prompts the visitor for input.
Parameter options
The options for the dialog box.
function PseudoClassHandler
PseudoClassHandler: (...pseudoClasses: string[]) => MethodDecorator;
function querySelectorAll
querySelectorAll: ( view: ViewBaseDefinition, selector: string) => Array<ViewBaseDefinition>;
Gets a child view by selector.
Parameter view
The parent (container) view of the view to look for.
Parameter selector
The selector of the view to look for. Returns an instance of a view (if found), otherwise undefined.
function removeTaggedAdditionalCSS
removeTaggedAdditionalCSS: (tag: String | Number) => boolean;
function removeWeakEventListener
removeWeakEventListener: ( source: Observable, eventName: string, handler: (eventData: EventData) => void, target: any) => void;
Removes a WeakEventListener.
Parameter source
Observable class which emits the event.
Parameter eventName
The event name.
Parameter handler
The function which should be called when event occurs.
Parameter target
Subscriber (target) of the event listener. It will be used as a thisArg in the handler function.
function resolveFileNameFromUrl
resolveFileNameFromUrl: ( url: string, appDirectory: string, fileExists: (filepath: string) => boolean, importSource?: string) => string;
function sanitizeModuleName
sanitizeModuleName: (moduleName: string, removeExtension?: boolean) => string;
Helps sanitize a module name if it is prefixed with '~/', '~' or '/'
Parameter moduleName
the name
Parameter removeExtension
whether to remove extension
function setActivityCallbacks
setActivityCallbacks: (activity: any) => void;
function timeConverter
timeConverter: (value: string) => number;
function transformConverter
transformConverter: (text: string) => TransformFunctionsInfo;
Classes
class AbsoluteLayout
class AbsoluteLayout extends LayoutBase {}
A layout that lets you specify exact locations (left/top coordinates) of its children.
method getLeft
static getLeft: (view: View) => CoreTypes.LengthType;
Gets the value of the Left property from a given View.
method getTop
static getTop: (view: View) => CoreTypes.LengthType;
Gets the value of the Top property from a given View.
method setLeft
static setLeft: (view: View, value: CoreTypes.LengthType) => void;
Sets the value of the Left property from a given View.
method setTop
static setTop: (view: View, value: CoreTypes.LengthType) => void;
Sets the value of the Top property from a given View.
class ActionBar
class ActionBar extends View {}
Provides an abstraction over the ActionBar (android) and NavigationBar (iOS).
property actionItems
actionItems: ActionItems;
Gets the collection of action items.
property android
android: AndroidActionBarSettings;
Gets the android specific options of the action bar.
property effectiveContentInsetLeft
effectiveContentInsetLeft: number;
property effectiveContentInsetRight
effectiveContentInsetRight: number;
property flat
flat: boolean;
Removes the shadow/border at the bottom of the ActionBar and removes translucency on iOS. Default false.
property ios
ios: any;
Gets the native iOS [UINavigationBar](https://developer.apple.com/documentation/uikit/uinavigationbar) that represents the user interface for this component. Valid only when running on iOS.
property iosIconRenderingMode
iosIconRenderingMode: 'automatic' | 'alwaysOriginal' | 'alwaysTemplate';
Gets or set the UIImageRenderingMode of the action bar icons in iOS. Defaults to "alwaysOriginal" Valid values are: - automatic - alwaysOriginal - alwaysTemplate
property navigationButton
navigationButton: NavigationButton;
Gets or sets the navigation button (a.k.a. the back button).
property title
title: string;
Gets or sets the action bar title.
property titleView
titleView: View;
Gets or sets the title view. When set - replaces the title with a custom view.
method update
update: () => any;
Updates the action bar.
class ActionItem
class ActionItem extends ViewBase {}
Represents an action item in the action bar.
property actionBar
actionBar: ActionBar;
Gets the action bar that contains the action item.
property actionView
actionView: View;
Gets or sets the custom action view of the action item.
property android
android: AndroidActionItemSettings;
Gets the Android specific options of the action item.
property icon
icon: string;
Gets or sets the icon of the action item.
property ios
ios: IOSActionItemSettings;
Gets the iOS specific options of the action item.
property text
text: string;
Gets or sets the text of the action item.
property visibility
visibility: string;
Gets or sets the visibility of the action item.
method on
on: { (eventName: string, callback: (data: EventData) => void): void; (event: 'tap', callback: (args: EventData) => void): void;};
Adds a listener for the specified event name.
Parameter eventName
The name of the event.
Parameter callback
The event listener to add. Will be called when an event of the given name is raised.
Parameter 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.Raised when a tap event occurs.
class ActionItems
class ActionItems {}
Represents a collection of ActionItems.
method addItem
addItem: (item: ActionItem) => void;
Adds an item to the collection.
Parameter item
the item to be added
method getItemAt
getItemAt: (index: number) => ActionItem;
Gets an item at a specified index.
Parameter index
The index.
method getItems
getItems: () => Array<ActionItem>;
Gets an array of the current action items in the collection.
method removeItem
removeItem: (item: ActionItem) => void;
Removes an item to the collection.
Parameter item
The item to be removed.
class ActivityIndicator
class ActivityIndicator extends View {}
Represents a UI widget which displays a progress indicator hinting the user for some background operation running.
property android
android: any;
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.
property busy
busy: boolean;
Gets or sets a value indicating whether the widget is currently displaying progress.
property ios
ios: any;
Gets the native iOS [UIActivityIndicatorView](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIActivityIndicatorView_Class/index.html) that represents the user interface for this component. Valid only when running on iOS.
class AndroidApplication
class AndroidApplication extends ApplicationCommon {}
property activityBackPressedEvent
static readonly activityBackPressedEvent: string;
Deprecated
Use
Application.android.activityBackPressedEvent
instead.
property activityBackPressedEvent
readonly activityBackPressedEvent: string;
property activityCreatedEvent
static readonly activityCreatedEvent: string;
Deprecated
Use
Application.android.activityCreatedEvent
instead.
property activityCreatedEvent
readonly activityCreatedEvent: string;
property activityDestroyedEvent
static readonly activityDestroyedEvent: string;
Deprecated
Use
Application.android.activityDestroyedEvent
instead.
property activityDestroyedEvent
readonly activityDestroyedEvent: string;
property activityNewIntentEvent
static readonly activityNewIntentEvent: string;
Deprecated
Use
Application.android.activityNewIntentEvent
instead.
property activityNewIntentEvent
readonly activityNewIntentEvent: string;
property activityPausedEvent
static readonly activityPausedEvent: string;
Deprecated
Use
Application.android.activityPausedEvent
instead.
property activityPausedEvent
readonly activityPausedEvent: string;
property activityRequestPermissionsEvent
static readonly activityRequestPermissionsEvent: string;
Deprecated
Use
Application.android.activityRequestPermissionsEvent
instead.
property activityRequestPermissionsEvent
readonly activityRequestPermissionsEvent: string;
property activityResultEvent
static readonly activityResultEvent: string;
Deprecated
Use
Application.android.activityResultEvent
instead.
property activityResultEvent
readonly activityResultEvent: string;
property activityResumedEvent
static readonly activityResumedEvent: string;
Deprecated
Use
Application.android.activityResumedEvent
instead.
property activityResumedEvent
readonly activityResumedEvent: string;
property activityStartedEvent
static readonly activityStartedEvent: string;
Deprecated
Use
Application.android.activityStartedEvent
instead.
property activityStartedEvent
readonly activityStartedEvent: string;
property activityStoppedEvent
static readonly activityStoppedEvent: string;
Deprecated
Use
Application.android.activityStoppedEvent
instead.
property activityStoppedEvent
readonly activityStoppedEvent: string;
property backgrounded
readonly backgrounded: boolean;
Deprecated
Use
Application.inBackground
instead.
property context
readonly context: android.content.Context;
Deprecated
Use
Utils.android.getApplicationContext()
instead.
property foregroundActivity
readonly foregroundActivity: androidx.appcompat.app.AppCompatActivity;
The currently active (loaded) [android Activity](http://developer.android.com/reference/android/app/Activity.html).
This property is automatically updated upon Activity events.
property nativeApp
readonly nativeApp: android.app.Application;
The [android Application](http://developer.android.com/reference/android/app/Application.html) object instance provided to the init of the module.
property packageName
readonly packageName: string;
Deprecated
Use
Utils.android.getPackageName()
instead.
property paused
readonly paused: boolean;
Deprecated
Use
Application.suspended
instead.
property saveActivityStateEvent
static readonly saveActivityStateEvent: string;
Deprecated
Use
Application.android.saveActivityStateEvent
instead.
property saveActivityStateEvent
readonly saveActivityStateEvent: string;
property startActivity
readonly startActivity: androidx.appcompat.app.AppCompatActivity;
The main (start) Activity for the application.
method getNativeApplication
getNativeApplication: () => android.app.Application;
method getRegisteredBroadcastReceiver
getRegisteredBroadcastReceiver: ( intentFilter: string) => android.content.BroadcastReceiver;
Get a registered BroadcastReceiver, then you can get the result code of BroadcastReceiver in onReceiveCallback method.
Parameter intentFilter
A string containing the intent filter.
method on
on: { ( event: 'activityCreated', callback: (args: AndroidActivityBundleEventData) => void, thisArg?: any ): void; ( event: 'activityDestroyed', callback: (args: AndroidActivityEventData) => void, thisArg?: any ): void; ( event: 'activityStarted', callback: (args: AndroidActivityEventData) => void, thisArg?: any ): void; ( event: 'activityPaused', callback: (args: AndroidActivityEventData) => void, thisArg?: any ): void; ( event: 'activityResumed', callback: (args: AndroidActivityEventData) => void, thisArg?: any ): void; ( event: 'activityStopped', callback: (args: AndroidActivityEventData) => void, thisArg?: any ): void; ( event: 'saveActivityState', callback: (args: AndroidActivityBundleEventData) => void, thisArg?: any ): void; ( event: 'activityResult', callback: (args: AndroidActivityResultEventData) => void, thisArg?: any ): void; ( event: 'activityBackPressed', callback: (args: AndroidActivityBackPressedEventData) => void, thisArg?: any ): void; ( event: 'activityNewIntent', callback: (args: AndroidActivityNewIntentEventData) => void, thisArg?: any ): void; ( event: 'activityRequestPermissions', callback: (args: AndroidActivityRequestPermissionsEventData) => void, thisArg?: any ): void;};
method registerBroadcastReceiver
registerBroadcastReceiver: ( intentFilter: string, onReceiveCallback: ( context: android.content.Context, intent: android.content.Intent ) => void) => void;
Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#registerReceiver%28android.content.BroadcastReceiver,%20android.content.IntentFilter%29'
Parameter intentFilter
A string containing the intent filter.
Parameter onReceiveCallback
A callback function that will be called each time the receiver receives a broadcast.
method unregisterBroadcastReceiver
unregisterBroadcastReceiver: (intentFilter: string) => void;
Unregister a previously registered BroadcastReceiver. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#unregisterReceiver(android.content.BroadcastReceiver)'
Parameter intentFilter
A string containing the intent filter with which the receiver was originally registered.
class Animation
class Animation {}
Defines a animation set.
constructor
constructor( animationDefinitions: AnimationDefinition[], playSequentially?: boolean);
property cancel
cancel: () => void;
property isPlaying
isPlaying: boolean;
property play
play: (resetOnFinish?: boolean) => AnimationPromise;
class ApplicationCommon
class ApplicationCommon {}
property android
readonly android: IAndroidApplication;
property AndroidApplication
readonly AndroidApplication: IAndroidApplication;
property autoSystemAppearanceChanged
autoSystemAppearanceChanged: boolean;
Boolean to enable/disable systemAppearanceChanged
property backgroundEvent
readonly backgroundEvent: string;
property cssChangedEvent
readonly cssChangedEvent: string;
property discardedErrorEvent
readonly discardedErrorEvent: string;
property displayedEvent
readonly displayedEvent: string;
property exitEvent
readonly exitEvent: string;
property fontScaleChangedEvent
readonly fontScaleChangedEvent: string;
property foregroundEvent
readonly foregroundEvent: string;
property hasListeners
static hasListeners: (eventName: string) => boolean;
Deprecated
Use
Application.android.hasListeners()
instead.
property hasListeners
hasListeners: (eventName: string) => boolean;
property inBackground
readonly inBackground: boolean;
property initRootViewEvent
readonly initRootViewEvent: string;
property ios
readonly ios: IiOSApplication;
property iOSApplication
readonly iOSApplication: IiOSApplication;
property launchEvent
readonly launchEvent: string;
property livesyncEvent
readonly livesyncEvent: string;
property loadAppCssEvent
readonly loadAppCssEvent: string;
property lowMemoryEvent
readonly lowMemoryEvent: string;
property mainEntry
protected mainEntry: NavigationEntry;
property notify
static notify: <T = ApplicationEventData>(eventData: T) => void;
Deprecated
Use
Application.android.notify()
instead.
property notify
notify: <T = ApplicationEventData>(eventData: T) => void;
property off
static off: (eventNames: string, callback?: any, thisArg?: any) => void;
Deprecated
Use
Application.android.off()
instead.
property off
off: (eventNames: string, callback?: any, thisArg?: any) => void;
property on
static on: { ( eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'cssChanged', callback: (args: CssChangedEventData) => void, thisArg?: any ): void; ( event: 'livesync', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'cssChanged', callback: (args: CssChangedEventData) => void, thisArg?: any ): void; ( event: 'launch', callback: (args: LaunchEventData) => void, thisArg?: any ): void; ( event: 'displayed', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'suspend', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'resume', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'exit', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'lowMemory', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'uncaughtError', callback: (args: UnhandledErrorEventData) => void, thisArg?: any ): void; ( event: 'discardedError', callback: (args: DiscardedErrorEventData) => void, thisArg?: any ): void; ( event: 'orientationChanged', callback: (args: OrientationChangedEventData) => void, thisArg?: any ): void; ( event: 'systemAppearanceChanged', callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any ): void; ( event: 'fontScaleChanged', callback: (args: FontScaleChangedEventData) => void, thisArg?: any ): void;};
Deprecated
Use
Application.android.on()
instead.
property on
on: { ( eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'cssChanged', callback: (args: CssChangedEventData) => void, thisArg?: any ): void; ( event: 'livesync', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'cssChanged', callback: (args: CssChangedEventData) => void, thisArg?: any ): void; ( event: 'launch', callback: (args: LaunchEventData) => void, thisArg?: any ): void; ( event: 'displayed', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'suspend', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'resume', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'exit', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'lowMemory', callback: (args: ApplicationEventData) => void, thisArg?: any ): void; ( event: 'uncaughtError', callback: (args: UnhandledErrorEventData) => void, thisArg?: any ): void; ( event: 'discardedError', callback: (args: DiscardedErrorEventData) => void, thisArg?: any ): void; ( event: 'orientationChanged', callback: (args: OrientationChangedEventData) => void, thisArg?: any ): void; ( event: 'systemAppearanceChanged', callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any ): void; ( event: 'fontScaleChanged', callback: (args: FontScaleChangedEventData) => void, thisArg?: any ): void;};