# Titanium.UI.Toolbar

A Toolbar can contain buttons, as well as certain other widgets, including text fields and labels.

Availability
6.2.0
6.2.0
9.2.0

# Overview

A Toolbar is created by the Titanium.UI.createToolbar factory method or <Toolbar> Alloy element.

To provide spacing between items in the toolbar, on iOS you can use the special system button types, Titanium.UI.iOS.SystemButton.FIXED_SPACE and Titanium.UI.iOS.SystemButton.FLEXIBLE_SPACE.

Note that toolbars are positioned like other views (using the top and bottom properties, for example), but the iOS Human Interface Guidelines (opens new window) have specific requirements for placing toolbars, specifically:

  • On the iPhone and Android, a toolbar should be at the bottom of the window.
  • On the iPad, a toolbar should appear at the top or bottom of a window.

Due to an iOS limitation, the buttons in the toolbar only support the click event. The native object underlying a toolbar button does not generate standard view events, such as touchstart and touchend.

On Android a toolbar can also be used as an ActionBar for Titanium.Android.Activity. This allows a toolbar to inherit Titanium.Android.ActionBar methods, properties and events as well as provide a better customization of this design element. For example you can provide your own images to be used as navigation button icon, overflow menu icon and logo. In order to do that, an application must use a theme without a title bar. For Titanium 9.3.0 and higher, set the theme to Theme.Titanium.NoTitleBar. For older Titanium versions, set the theme to Theme.AppCompat.NoTitleBar.

See also:

# Examples

# Simple Toolbar

The following code excerpt creates a simple toolbar, placed at the bottom of the window.

var win = Ti.UI.createWindow({
    backgroundColor: 'white'
});

var send = Ti.UI.createButton({
    title: 'Send'
});

var camera = Ti.UI.createButton({
    title: 'Camera'
});

var cancel = Ti.UI.createButton({
    title: 'Cancel'
});

var toolbar = Ti.UI.createToolbar({
    items: [send, camera, cancel],
    bottom: 0
});

win.add(toolbar);
win.open();

# Toolbar (iOS) with extended background

The following code excerpt creates a simple toolbar, placed at the top of the window which extends its background under the status bar.

var win = Ti.UI.createWindow({
    backgroundColor: 'white'
});

var send = Ti.UI.createButton({
    title: 'Send',
    style: Ti.UI.iOS.SystemButtonStyle.DONE,
});

var camera = Ti.UI.createButton({
    systemButton: Ti.UI.iOS.SystemButton.CAMERA,
});

var cancel = Ti.UI.createButton({
    systemButton: Ti.UI.iOS.SystemButton.CANCEL
});

flexSpace = Ti.UI.createButton({
    systemButton: Ti.UI.iOS.SystemButton.FLEXIBLE_SPACE
});

var toolbar = Ti.UI.createToolbar({
    items: [send, flexSpace, camera, flexSpace, cancel],
    top: 20,
    extendBackground: true
});

win.add(toolbar);
win.open();

Note the use of the flexible space for positioning the toolbar buttons -- the FLEXIBLE_SPACE button doesn't appear as a button, but a variable space between the controls on either side of it. Available space in the toolbar is divided between all of the flexible space buttons in the toolbar. Without the flexible spaces in this example, the toolbar buttons would be grouped tightly together on the left side of the toolbar.

# Alloy Example (simple Toolbar)

Simple Toolbar example as an Alloy view.

<Alloy>
    <Window>
        <Toolbar bottom="0">

            <!-- The Items tag sets the Toolbar.items property. -->
            <Items>
                <Button id="send" title="Send" />
                <Button id="camera" title="Camera" />
                <Button id="cancel" title="Cancel" />
            </Items>

        </Toolbar>
    </Window>
</Alloy>

# Alloy Example (Toolbar as ActionBar)

Example how to set up Toolbar as an ActionBar

<Alloy>
    <Window title="My Test App" backgroundColor="gray" customToolbar="toolbar">
        <Toolbar
            title="MyMenu"
            subtitle="Subtitle"
            width="Ti.UI.FILL"
            top="0"
            barColor="#639851"
            displayHomeAsUp="true"
            homeButtonEnabled="true"
            overflowIcon="logo.png">

            <!-- The Items tag sets the Toolbar.items property. -->
            <Items>
                <Button id="ok" title="OK"/>
                <Button id="cancel" title="Cancel"/>
            </Items>
        </Toolbar>

        <!-- The MenuItem's to be mapped to the toolbar -->
        <Menu>
            <MenuItem id="item1" title="Settings" showAsAction="Ti.Android.SHOW_AS_ACTION_NEVER"/>
            <MenuItem id="item2" title="Search" showAsAction="Ti.Android.SHOW_AS_ACTION_NEVER"/>
        </Menu>
    </Window>
</Alloy>

# Properties

# accessibilityDisableLongPress CREATION ONLY

Availability
12.4.0
accessibilityDisableLongPress :Boolean

Boolean value to remove the long press notification for the device's accessibility service.

Will disable the "double tap and hold for long press" message when selecting an item.

Default: true


# accessibilityHidden

Availability
6.2.0
6.2.0
9.2.0
accessibilityHidden :Boolean

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the UIAccessibility Protocol.

On Android, setting accessibilityHidden calls the native View.setImportantForAccessibility method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and later; if this property is specified on earlier versions of Android, it is ignored.

Default: false


# accessibilityHint

Availability
6.2.0
6.2.0
9.2.0
accessibilityHint :String

Briefly describes what performing an action (such as a click) on the view will do.

On iOS this is a direct analog of the accessibilityHint property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityValue in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default: null


# accessibilityLabel

Availability
6.2.0
6.2.0
9.2.0
accessibilityLabel :String

A succint label identifying the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityLabel property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityValue and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method. Defaults to Title or label of the control.


# accessibilityValue

Availability
6.2.0
6.2.0
9.2.0
accessibilityValue :String

A string describing the value (if any) of the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityValue property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method. Defaults to State or value of the control.


# anchorPoint

Availability
7.5.0
6.2.0
9.2.0
anchorPoint :Point

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use anchorPoint.

Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right corner.

See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration. The default is center of this view.


# animatedCenter READONLY

Availability
6.2.0
9.2.0
animatedCenter :Point

Current position of the view during an animation.


# apiName READONLY

Availability
6.2.0
6.2.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.


# backgroundGradient

Availability
6.2.0
6.2.0
9.2.0
backgroundGradient :Gradient

A background gradient for the view.

A gradient can be defined as either linear or radial. A linear gradient varies continuously along a line between the startPoint and endPoint.

A radial gradient is interpolated between two circles, defined by startPoint and startRadius and endPoint and endRadius respectively.

The start points, end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:

{ x: 30, y: 30 }

Or:

{ x: '50%', y: '50%' }

When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:

colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]

Android's linear gradients ignores backfillStart and backfillEnd, treating them as if they are true. Android's radial gradients ignore the endPoint property. Defaults to no gradient.


# backgroundImage

Availability
6.2.0
6.2.0
9.2.0
backgroundImage :String

Background image for the view, specified as a local file path or URL.

Default behavior when backgroundImage is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, textfields, and so on), platform-specific default images are used.


# barColor

Availability
6.2.0
6.2.0
9.2.0
barColor :String | Titanium.UI.Color

Background color for the toolbar, as a color name or hex triplet.

To use a background image on the toolbar, either barColor must be a fully or partially transparent color, or the translucent property must be true.

To use a background gradient on a toolbar, barColor must be 'transparent' and the the translucent property must be true.

For information about color values, see the "Colors" section of Titanium.UI.


# borderColor

Availability
6.2.0
6.2.0
9.2.0
borderColor :String | Titanium.UI.Color

Border color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Defaults to the normal background color of this view (Android), black (iOS).


# borderRadius

Availability
6.2.0
6.2.0
9.2.0
borderRadius :Number | String | Array<Number> | Array<String>

Radius for the rounded corners of the view's border.

Each corner is rounded using an arc of a circle. Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px. Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.

If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a backgroundColor with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)".

Default: 0


# borderWidth

Availability
6.2.0
6.2.0
9.2.0
borderWidth :Number

Border width of the view.

If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.

Default: 0


# bottom

Availability
6.2.0
6.2.0
9.2.0
bottom :Number | String

View's bottom position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.


# bubbleParent

Availability
6.2.0
6.2.0
9.2.0
bubbleParent :Boolean

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

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true


# center

Availability
6.2.0
6.2.0
9.2.0
center :Point

View's center position, in the parent view's coordinates.

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.


# clipMode

Availability
6.2.0
9.2.0
clipMode :Number

View's clipping behavior.

Setting this to CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.

Defaults to undefined. Behaves as if set to CLIP_MODE_DEFAULT.


# contentInsetEndWithActions

Availability
6.2.0
contentInsetEndWithActions :Number

Returns the margin after the toolbar's content when there are action buttons.


# contentInsetStartWithNavigation

Availability
6.2.0
contentInsetStartWithNavigation :Number

Returns the margin at the toolbar's content start when there is a navigation button.


# elevation

Availability
6.2.0
elevation :Number

Base elevation of the view relative to its parent in pixels.

The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.

Note: The elevation property only works on Titanium.UI.View objects. Many Android components have a default elevation that cannot be modified. For more information, see Google design guidelines: Elevation and shadows.


# extendBackground CREATION ONLY

Availability
6.2.0
6.2.0
9.2.0
extendBackground :Boolean

If true, the background of the toolbar extends upwards.

This property allows the user to specify that the toolbar's background show through the status bar. and is only intended to be used with toolbars hosted in windows with no navigation controllers. The toolbar must be placed at the top of the screen just below the status bar and used as an ActionBar on Android for this property to work as expected. This must be specified at creation.

Default: Undefined. Behaves as if set to false.


# filterTouchesWhenObscured

Availability
9.3.0
filterTouchesWhenObscured :Boolean

Discards touch related events if another app's system overlay covers the view.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

Setting this property to true causes touch related events (including "click") to not be fired if a system overlay overlaps the view.

Default: false


# focusable

Availability
6.2.0
focusable :Boolean

Whether view should be focusable while navigating with the trackball.

Default: false


# height

Availability
6.2.0
6.2.0
9.2.0
height :Number | String

View height, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • SIZE. The view should size itself to fit its contents.
  • FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

# hiddenBehavior

Availability
6.2.0
hiddenBehavior :Number

Sets the behavior when hiding an object to release or keep the free space

If setting hiddenBehavior to HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied. For example: in a vertical layout the views below the object will move up when you hide an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE.

Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.

This API can be assigned the following constants:

# horizontalMotionEffect

Availability
7.3.0
9.2.0
horizontalMotionEffect :MinMaxOptions

Adds a horizontal parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.


# horizontalWrap

Availability
6.2.0
6.2.0
9.2.0
horizontalWrap :Boolean

Determines whether the layout has wrapping behavior.

For more information, see the discussion of horizontal layout mode in the description of the layout property.

Default: true


# id

Availability
6.2.0
6.2.0
9.2.0
id :String

View's identifier.

The id property of the Ti.UI.View represents the view's identifier. The identifier string does not have to be unique. You can use this property with getViewById method.


# items

Availability
6.2.0
6.2.0
9.2.0
items :Array<Titanium.UI.View>

An array of buttons (or other widgets) contained in the toolbar.


# keepScreenOn

Availability
6.2.0
keepScreenOn :Boolean

Determines whether to keep the device screen on.

When true the screen will not power down. Note: enabling this feature will use more power, thereby adversely affecting run time when on battery. For iOS look at idleTimerDisabled.

Default: false


# left

Availability
6.2.0
6.2.0
9.2.0
left :Number | String

View's left position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.


# lifecycleContainer

Availability
6.2.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.


Image to be used as a logo in the Toolbar.

This property is used only when the Toolbar is used as an ActionBar.


navigationIcon :String | Titanium.Blob | Titanium.Filesystem.File

Image to be used for a navigation icon.

This property is used only when the Toolbar is used as an ActionBar.


navigationIconColor :String

Tint color of the navigation icon (e.g. home arrow)


# opacity

Availability
6.2.0
6.2.0
9.2.0
opacity :Number

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). Defaults to 1.0 (opaque).


# overflowIcon

Availability
6.2.0
overflowIcon :String | Titanium.Blob | Titanium.Filesystem.File

Image to be used for the overflow menu.

This property is used only when the Toolbar is used as an ActionBar.


# overrideCurrentAnimation CREATION ONLY

Availability
6.2.0
overrideCurrentAnimation :Boolean

When on, animate call overrides current animation if applicable.

If this property is set to false, the animate call is ignored if the view is currently being animated.

Defaults to undefined but behaves as false


# previewContext

Availability
6.2.0

The preview context used in the 3D-Touch feature "Peek and Pop".

Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.

Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using forceTouchSupported.


# pullBackgroundColor

Availability
6.2.0
9.2.0
pullBackgroundColor :String | Titanium.UI.Color

Background color of the wrapper view when this view is used as either pullView or headerPullView.

Defaults to undefined. Results in a light grey background color on the wrapper view.


# rect READONLY

Availability
6.2.0
6.2.0
9.2.0

The bounding box of the view relative to its parent, in system units.

The view's bounding box is defined by its size and position.

The view's size is rect.width x rect.height. The view's top-left position relative to its parent is (rect.x , rect.y).

On Android it will also return rect.absoluteX and 'rect.absoluteY' which are relative to the main window.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.


right :Number | String

View's right position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.


# rotation

Availability
6.2.0
12.3.0
rotation :Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.


# rotationX

Availability
6.2.0
rotationX :Number

Clockwise rotation of the view in degrees (x-axis).

Translation values are applied to the static post layout value.


# rotationY

Availability
6.2.0
rotationY :Number

Clockwise rotation of the view in degrees (y-axis).

Translation values are applied to the static post layout value.


# scaleX

Availability
6.2.0
scaleX :Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.


# scaleY

Availability
6.2.0
scaleY :Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.


# size READONLY

Availability
6.2.0
6.2.0
9.2.0
size :Dimension

The size of the view in system units.

Although property returns a Dimension dictionary, only the width and height properties are valid. The position properties--x and y--are always 0.

To find the position and size of the view, use the rect property instead.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.


# subtitle

Availability
6.2.0
subtitle :String

Text of the subtitle.


# subtitleTextColor

Availability
6.2.0
subtitleTextColor :String

Color for toolbar's subtitle


# tintColor

Availability
6.2.0
9.2.0
tintColor :String | Titanium.UI.Color

The view's tintColor

This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.

Default: null


# title

Availability
6.2.0
title :String

Text of the title.


# titleTextColor

Availability
6.2.0
titleTextColor :String

Color string with any Titanium supported format


# tooltip

Availability
12.1.0
12.1.0
12.1.0
tooltip :String

The default text to display in the control's tooltip.

Assigning a value to this property causes the tool tip to be displayed for the view. Setting the property to null cancels the display of the tool tip for the view. Note: This property is only used for apps targeting macOS Catalyst.


# top

Availability
6.2.0
6.2.0
9.2.0
top :Number | String

The view's top position.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.


# touchEnabled

Availability
6.2.0
6.2.0
9.2.0
touchEnabled :Boolean

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true


# touchFeedback

Availability
6.2.0
touchFeedback :Boolean

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Touch feedback is only applied to a view's background. It is never applied to the view's foreground content such as a Titanium.UI.ImageView's image.

For Titanium versions older than 9.1.0, touch feedback only works if you set the backgroundColor property to a non-transparent color.

Default: false


# touchFeedbackColor

Availability
6.2.0
touchFeedbackColor :String

Optional touch feedback ripple color. This has no effect unless touchFeedback is true.

Defaults to provided theme color.


# transform

Availability
6.2.0
6.2.0
9.2.0

Transformation matrix to apply to the view.

Android only supports Matrix2D transforms.

Default: Identity matrix


# transitionName

Availability
6.2.0
transitionName :String

A name to identify this view in activity transition.

Name should be unique in the View hierarchy.


# translationX

Availability
6.2.0
translationX :Number

Horizontal location of the view relative to its left position in pixels.

Translation values are applied to the static post layout value.


# translationY

Availability
6.2.0
translationY :Number

Vertical location of the view relative to its top position in pixels.

Translation values are applied to the static post layout value.


# translationZ

Availability
6.2.0
translationZ :Number

Depth of the view relative to its elevation in pixels.

Translation values are applied to the static post layout value.


# translucent

Availability
6.2.0
9.2.0
translucent :Boolean

If true, a translucent background color is used for the toolbar.

Note that if translucent is false, views under the toolbar are hidden, even if barColor is set to a semi-transparent or transparent color.

Default: true


# verticalMotionEffect

Availability
7.3.0
9.2.0
verticalMotionEffect :MinMaxOptions

Adds a vertical parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.


# viewShadowColor

Availability
11.1.0
6.2.0
9.2.0
viewShadowColor :String | Titanium.UI.Color

Determines the color of the shadow.

iOS Defaults to undefined. Behaves as if transparent. Android default is black. On Android you can set <item name="android:ambientShadowAlpha">0.5</item> and <item name="android:spotShadowAlpha">0.5</item> in your theme to change the opacity.


# viewShadowOffset

Availability
6.2.0
9.2.0
viewShadowOffset :Point

Determines the offset for the shadow of the view.

Defaults to undefined. Behaves as if set to (0,-3)


# viewShadowRadius

Availability
6.2.0
9.2.0
viewShadowRadius :Number | String

Determines the blur radius used to create the shadow.

Defaults to undefined. Behaves as if set to 3. Accepts density units as of 10.0.1.


# visible

Availability
6.2.0
6.2.0
9.2.0
visible :Boolean

Determines whether the view is visible.

Default: true


# width

Availability
6.2.0