Class

UIActionSheet

Important: UIActionSheet is deprecated in iOS 8. (Note that UIActionSheetDelegate is also deprecated.) To create and manage action sheets in iOS 8 and later, instead use UIAlertController with a preferredStyle of actionSheet.

Overview

In apps that target versions of iOS prior to iOS 8, use the UIActionSheet class to present the user with a set of alternatives for how to proceed with a given task. You can also use action sheets to prompt the user to confirm a potentially dangerous action. The action sheet contains an optional title and one or more buttons, each of which corresponds to an action to take.

Use the properties and methods of this class to configure the action sheet’s message, style, and buttons before presenting it. You should also assign a delegate to your action sheet. Your delegate object is responsible for performing the action associated with any buttons when they are tapped and should conform to the UIActionSheetDelegate protocol. For more information about implementing the methods of the delegate, see UIActionSheetDelegate.

You can present an action sheet from a toolbar, tab bar, button bar item, or from a view. This class takes the starting view and current platform into account when determining how to present the action sheet. For applications running on iPhone and iPod touch devices, the action sheet typically slides up from the bottom of the window that owns the view. For applications running on iPad devices, the action sheet is typically displayed in a popover that is anchored to the starting view in an appropriate way. Taps outside of the popover automatically dismiss the action sheet, as do taps within any custom buttons. You can also dismiss it programmatically.

When presenting an action sheet on an iPad, there are times when you should not include a cancel button. If you are presenting just the action sheet, the system displays the action sheet inside a popover without using an animation. Because taps outside the popover dismiss the action sheet without selecting an item, this results in a default way to cancel the sheet. Including a cancel button would therefore only cause confusion. However, if you have an existing popover and are displaying an action sheet on top of other content using an animation, a cancel button is still appropriate. For more information see iOS Human Interface Guidelines.

For more information about appearance and behavior configuration, see Action Sheets.

Subclassing Notes

UIActionSheet is not designed to be subclassed, nor should you add views to its hierarchy. If you need to present a sheet with more customization than provided by the UIActionSheet API, you can create your own and present it modally with present(_:animated:completion:).

Symbols

Creating Action Sheets

Setting Properties

var delegate: UIActionSheetDelegate?

The receiver’s delegate or nil if it doesn’t have a delegate.

var title: String

The string that appears in the receiver’s title bar.

var isVisible: Bool

A Boolean value that indicates whether the receiver is displayed.

var actionSheetStyle: UIActionSheetStyle

The receiver’s presentation style.

Configuring Buttons

func addButton(withTitle: String?)

Adds a custom button to the action sheet.

var numberOfButtons: Int

The number of buttons on the action sheet.

func buttonTitle(at: Int)

Returns the title of the button at the specified index.

var cancelButtonIndex: Int

The index number of the cancel button.

var destructiveButtonIndex: Int

The index number of the destructive button.

var firstOtherButtonIndex: Int

The index of the first custom button.

Presenting the Action Sheet

func show(from: UITabBar)

Displays an action sheet that originates from the specified tab bar.

func show(from: UIToolbar)

Displays an action sheet that originates from the specified toolbar.

func show(in: UIView)

Displays an action sheet that originates from the specified view.

func show(from: UIBarButtonItem, animated: Bool)

Displays an action sheet that originates from the specified bar button item.

func show(from: CGRect, in: UIView, animated: Bool)

Displays an action sheet that originates from the specified view.

Dismissing the Action Sheet

func dismiss(withClickedButtonIndex: Int, animated: Bool)

Dismisses the action sheet immediately using an optional animation.