A UI element in an application.
SDK
Framework
class XCUIElement : NSObject
On macOS, XCUIElement provides keyboard- and mouse-like interactions such as typing, hovering, clicking, and scrolling. On iOS, XCUIElement provides gestural interactions such as tapping, pressing, swiping, pinching, and rotating.
func waitWaits the specified amount of time for the element’s exists property to become true.
var exists: BoolDetermines if the element exists.
var isDetermines if a hit point can be computed for the element.
var debugProvides debugging information about the element.
func children(matching: XCUIElementReturns a query for all direct children of the element matching the specified type.
func descendants(matching: XCUIElementReturns a query for all descendants of the element matching the specified type.
func typeTypes a string into the element.
Available on macOS only.
func typeTypes a single key with the specified modifier flags.
struct XCUIKeyboardConstants for use with type to represent keys that have no textual equivalent.
class func perform(withExecutes block with the given modifier keys held down.
struct XCUIElementFlags for keyboard modifiers such as shift, control, option, and command.
Available on macOS only.
func hover()Moves the cursor over the element.
Available on macOS only.
func click()Sends a click event to a hittable point computed for the element.
func click(forClicks and holds for a specified duration (generally long enough to start a drag operation) then drags to the other element.
func doubleSends a double click event to a hittable point computed for the element.
func rightSends a right click event to a hittable point computed for the element.
Available on macOS only.
func scroll(byScrolls the view by the specified number of x and y pixels.
Available on iOS, and on macOS for Touch Bar interactions.
func tap()Sends a tap event to a hittable point computed for the element.
func doubleSends a double tap event to a hittable point computed for the element.
func press(forSends a long press gesture to a hittable point computed for the element, holding for the specified duration.
func press(forInitiates a press-and-hold gesture, then drags to another element.
Available on iOS only.
func twoSends a two finger tap event to a hittable point computed for the element.
func tap(withSends one or more taps with one or more touch points.
Available on iOS only.
func swipeSends a swipe-left gesture.
func swipeSends a swipe-right gesture.
func swipeSends a swipe-up gesture.
func swipeSends a swipe-down gesture.
func pinch(withSends a pinching gesture with two touches.
func rotate(CGFloat, withSends a rotation gesture with two touches.
var normalizedReturns the position of the slider’s indicator as a normalized value, where 0 corresponds to the minimum value of the slider and 1 corresponds to its maximum value.
func adjust(toManipulates the UI to change the displayed value of the slider to a new value, based on a normalized position.
This method provides functionality for automating the picker wheels of UIPicker and UIDate controls.
func adjust(toChanges the displayed value for the picker wheel.
func coordinate(withCreates and returns a new coordinate with a normalized offset.
enum XCUIElementThe types of UI element that can be located.
enum XCUIElementDescribes the available user interface size classes.
protocol XCUIElementAttributes exposed by UI elements.
class XCUICoordinateA location on screen relative to some UI element.