Skip to content
Titanium SDK
Version13.1.1

You are reading 13.1.1. See this page in 13.4.1.

Titanium.UI.iOS

moduleiPhoneiPadmacOSsince iPhone 1.4.0, iPad 1.4.0, macOS 9.2.0

Extends Titanium.ModuleTitanium.Proxy

Apple iOS specific UI capabilities. All properties, methods and events in this namespace will only work on Apple iOS devices.

Properties 141

ALERT_SEVERITY_CRITICAL

Numbersince 12.0.0read-onlyiOS 16.0+

Indicates that the system should present the alert using the critical, or caution, style.

Use with <Titanium.UI.iOS.createAlertDialog> to specify the alert dialog severity on macOS Catalyst.

ALERT_SEVERITY_DEFAULT

Numbersince 12.0.0read-onlyiOS 16.0+

Indicates that the system should present the alert using the standard alert style.

Use with <Titanium.UI.iOS.createAlertDialog> to specify the alert dialog severity on macOS Catalyst.

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

appBadge

Numbersince 5.4.0

Value of the badge for the application's springboard icon.

In order to change the app icon badge number you will need to register for notifications. Normally this is done by using local notifications or a push service like Firebase Cloud Messaging (FCM).

Ti.App.iOS.registerUserNotificationSettings({
  types: [
        Ti.App.iOS.USER_NOTIFICATION_TYPE_BADGE
    ]
});

appSupportsShakeToEdit

Booleansince 5.4.0

Determines whether the shake to edit system-wide capability is enabled.

BLUR_EFFECT_STYLE_DARK

Numbersince 5.4.0read-only

Use with BlurView.effect to specify a blur effect.

Creates a blurring effect in the view. The area of the view is darker in hue than the underlying view.

BLUR_EFFECT_STYLE_LIGHT

Numbersince 5.4.0read-only

Use with BlurView.effect to specify a blur effect.

Creates a blurring effect in the view. The area of the view is the same approximate hue of the underlying view.

BLUR_EFFECT_STYLE_PROMINENT

Numbersince 6.0.0read-only

Use with BlurView.effect to specify a blur effect.

Creates a blurring effect in the view. The area of the view is presented more prominent than the underlying view.

BLUR_EFFECT_STYLE_REGULAR

Numbersince 6.0.0read-only

Use with BlurView.effect to specify a blur effect.

Creates a blurring effect in the view. The blurring effect is the default one specified in iOS 10.

BLUR_EFFECT_STYLE_SYSTEM_MATERIAL

Numbersince 8.2.0read-onlyiOS 13.0+

Use with BlurView.effect to specify a blur effect.

Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material with normal thickness.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

Specifies that the existing cache data should be used to satisfy a request, regardless of its age or expiration date.

Use with Titanium.UI.WebView.cachePolicy. If there is no existing data in the cache corresponding to a URL load request, no attempt is made to load the data from the originating source, and the load is considered to have failed. This constant specifies a behavior that is similar to an offline mode.

forceTouchSupported

Booleansince 5.1.0read-only

Determines if the 3D-Touch capability "Force Touch" is supported (true) or not (false) by the device.

Returns true if the device supports 3D-Touch (iPhone 6S / iPhone 6S Plus and later) or false if not.

GLASS_EFFECT_STYLE_CLEAR

Numbersince 13.0.0read-onlyiOS 26.0+

Use with BlurView.glassEffect to specify a clear glass effect style.

Creates a glass effect with higher translucency and lighter blur intensity compared to the regular style. This style provides a more transparent appearance while still maintaining the glass effect characteristics.

GLASS_EFFECT_STYLE_REGULAR

Numbersince 13.0.0read-onlyiOS 26.0+

Use with BlurView.glassEffect to specify a regular glass effect style.

Creates a standard glass effect with regular translucency and blur intensity. This is the default style for glass effects and provides a balanced appearance suitable for most use cases.

LARGE_TITLE_DISPLAY_MODE_AUTOMATIC

Numbersince 6.3.0read-only

Automatically use the large out-of-line title based on the state of the p revious item in the navigation bar.

Use with Titanium.UI.Window.largeTitleDisplayMode. An item with this constant will show or hide the large title based on the request of the previous navigation item. If the first item pushed is set to Automatic, then it will show the large title if the navigation bar has the property Titanium.UI.Window.largeTitleEnabled set to true.

LIVEPHOTO_PLAYBACK_STYLE_FULL

Numbersince 5.2.0read-onlyiOS 9.1+

Plays back the entire motion and sound content of the Live Photo, including transition effects at the start and end.

This style matches the effect seen when pressing on a photo in the Photos app.

LIVEPHOTO_PLAYBACK_STYLE_HINT

Numbersince 5.2.0read-onlyiOS 9.1+

Plays back only a brief section of the motion content of the Live Photo, without sound.

This style matches the effect seen in various iOS interface elements for hinting to the user when an asset contains Live Photo content.

SHORTCUT_ICON_TYPE_ADD

Numbersince 5.1.0read-only

Number that represents the icon used for the application shortcut

An icon for a quick action that adds an item.

SHORTCUT_ICON_TYPE_ALARM

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers creation of an alarm.

SHORTCUT_ICON_TYPE_AUDIO

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers use of audio.

SHORTCUT_ICON_TYPE_BOOKMARK

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers creation of a bookmark.

SHORTCUT_ICON_TYPE_CAPTURE_PHOTO

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers photo capture.

SHORTCUT_ICON_TYPE_CAPTURE_VIDEO

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers video capture.

SHORTCUT_ICON_TYPE_CLOUD

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers cloud access.

SHORTCUT_ICON_TYPE_COMPOSE

Numbersince 5.1.0read-only

Number that represents the icon used for the application shortcut

An icon for a quick action that lets a user compose new content.

SHORTCUT_ICON_TYPE_CONFIRMATION

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that indicates confirmation.

SHORTCUT_ICON_TYPE_CONTACT

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that chooses a generic contact.

SHORTCUT_ICON_TYPE_DATE

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers use of a calendar.

SHORTCUT_ICON_TYPE_FAVORITE

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that lets a user designate a favorite item.

SHORTCUT_ICON_TYPE_HOME

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that indicates home.

SHORTCUT_ICON_TYPE_INVITATION

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that indicates an invitation.

SHORTCUT_ICON_TYPE_LOCATION

Numbersince 5.1.0read-only

Number that represents the icon used for the application shortcut

Will cause a magnifying glass icon to be displayed at that location in the index. This should generally only be used as the first title in the index.

SHORTCUT_ICON_TYPE_LOVE

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that lets a user designate a loved item.

SHORTCUT_ICON_TYPE_MAIL

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers use of mail.

SHORTCUT_ICON_TYPE_MARK_LOCATION

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that lets a user mark a location.

SHORTCUT_ICON_TYPE_MESSAGE

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers use of messaging.

SHORTCUT_ICON_TYPE_PAUSE

Numbersince 5.1.0read-only

Number that represents the icon used for the application shortcut

An icon for a quick action that pauses media playback.

SHORTCUT_ICON_TYPE_PLAY

Numbersince 5.1.0read-only

Number that represents the icon used for the application shortcut

An icon for a quick action that plays media.

SHORTCUT_ICON_TYPE_PROHIBIT

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that disallows something.

SHORTCUT_ICON_TYPE_SHARE

Numbersince 5.1.0read-only

Number that represents the icon used for the application shortcut

An icon for a quick action that offers content sharing.

SHORTCUT_ICON_TYPE_SHUFFLE

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers shuffle mode.

SHORTCUT_ICON_TYPE_TASK

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers task creation.

SHORTCUT_ICON_TYPE_TASK_COMPLETED

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers task completion.

SHORTCUT_ICON_TYPE_TIME

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers use of a clock or timer.

SHORTCUT_ICON_TYPE_UPDATE

Numbersince 5.1.0read-onlyiOS 9.1+

Number that represents the icon used for the application shortcut

An icon for a quick action that offers updating.

Methods 35

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to invoke when the event is fired.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
ParametersTypeDescription
nameString

Name of the event.

event?Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

systemImage

since 8.2.0iOS 13.0+

Get image from SF Symbols provided by Apple.

More details on SF Symbols can be found here. One can download SF Symbols app from here and use it to lookup the built-in SF Symbol name. Example:

const win = Ti.UI.createWindow({ backgroundColor: '#fff' });

const imageView = Ti.UI.createImageView({
  image:  Ti.UI.iOS.systemImage('folder'), // folder icon
  height: Ti.UI.FILL
});

// iOS 17+ symbol effect
imageView.addSymbolEffect({
  symbolEffect: 'bounce',
  animated: true,
  options: { repeatCount: 4 }
});

win.add(imageView);
win.open();
Parameters
ParametersTypeDescription
nameString

Name of SF Symbol.

parameters?SystemImageParameters

Additional parameters to pass to the SF Symbol. Available in Titanium SDK 10.1.0 and later

2 fields
size Number

The symbol point size to use for the SF Symbol

weight String

The symbol weight to use for the SF Symbol. Can be one of ultralight, light, thin, normal, semibold, bold, heavy or black.