SwiftUICore · IOS API REFERENCE

AccessibilityTraits

struct · iOS 13.0+ · SDK 27.1

struct AccessibilityTraits

A set of accessibility traits that describe how an element behaves.

Members (28)

get · iOS 13.0+

isSelected

TypeScript

static get isSelected(): AccessibilityTraits

Swift declaration

static let isSelected: AccessibilityTraits

The accessibility element is currently selected.

get · iOS 13.0+

playsSound

TypeScript

static get playsSound(): AccessibilityTraits

Swift declaration

static let playsSound: AccessibilityTraits

The accessibility element plays its own sound when activated.

method · iOS 13.0+

intersection

TypeScript

intersection(other: AccessibilityTraits): AccessibilityTraits

Swift declaration

func intersection(_ other: AccessibilityTraits) -> AccessibilityTraits

Returns a new set with the elements that are common to both this set and the given set. In the following example, the `bothNeighborsAndEmployees` set is made up of the elements that are in *both* the `employees` and `neighbors` sets. Elements that are in only one or the other are left out of the result of the intersection. let employees: Set = ["Alicia", "Bethany", "Chris", "Diana", "Eric"] let neighbors: Set = ["Bethany", "Eric", "Forlani", "Greta"] let bothNeighborsAndEmployees = employees.intersection(neighbors) print(bothNeighborsAndEmployees) // Prints "["Bethany", "Eric"]" - Parameter other: A set of the same type as the current set. - Returns: A new set. - Note: if this set and `other` contain elements that are equal but distinguishable (e.g. via `===`), which of these elements is present in the result is unspecified.

get · iOS 13.0+

isStaticText

TypeScript

static get isStaticText(): AccessibilityTraits

Swift declaration

static let isStaticText: AccessibilityTraits

The accessibility element is a static text that cannot be modified by the user.

get · iOS 13.0+

isKeyboardKey

TypeScript

static get isKeyboardKey(): AccessibilityTraits

Swift declaration

static let isKeyboardKey: AccessibilityTraits

The accessibility element behaves as a keyboard key.

get · iOS 13.0+

isSearchField

TypeScript

static get isSearchField(): AccessibilityTraits

Swift declaration

static let isSearchField: AccessibilityTraits

The accessibility element is a search field.

get · iOS 13.0+

causesPageTurn

TypeScript

static get causesPageTurn(): AccessibilityTraits

Swift declaration

static let causesPageTurn: AccessibilityTraits

The accessibility element causes an automatic page turn when VoiceOver finishes reading the text within it.

method · iOS 13.0+

formIntersection

TypeScript

formIntersection(other: AccessibilityTraits): void

Swift declaration

mutating func formIntersection(_ other: AccessibilityTraits)

Removes the elements of this set that aren't also in the given set. In the following example, the elements of the `employees` set that are not also members of the `neighbors` set are removed. In particular, the names `"Alicia"`, `"Chris"`, and `"Diana"` are removed. var employees: Set = ["Alicia", "Bethany", "Chris", "Diana", "Eric"] let neighbors: Set = ["Bethany", "Eric", "Forlani", "Greta"] employees.formIntersection(neighbors) print(employees) // Prints "["Bethany", "Eric"]" - Parameter other: A set of the same type as the current set.

get · iOS 13.0+

isSummaryElement

TypeScript

static get isSummaryElement(): AccessibilityTraits

Swift declaration

static let isSummaryElement: AccessibilityTraits

The accessibility element provides summary information when the application starts. Use this trait to characterize an accessibility element that provides a summary of current conditions, settings, or state, like the temperature in the Weather app.

get · iOS 13.0+

updatesFrequently

TypeScript

static get updatesFrequently(): AccessibilityTraits

Swift declaration

static let updatesFrequently: AccessibilityTraits

The accessibility element frequently updates its label or value. Use this trait when you want an assistive technology to poll for changes when it needs updated information. For example, you might use this trait to characterize the readout of a stopwatch.

get · iOS 13.0+

startsMediaSession

TypeScript

static get startsMediaSession(): AccessibilityTraits

Swift declaration

static let startsMediaSession: AccessibilityTraits

The accessibility element starts a media session when it is activated. Use this trait to silence the audio output of an assistive technology, such as VoiceOver, during a media session that should not be interrupted. For example, you might use this trait to silence VoiceOver speech while the user is recording audio.

method · iOS 13.0+

symmetricDifference

TypeScript

symmetricDifference(other: AccessibilityTraits): AccessibilityTraits

Swift declaration

func symmetricDifference(_ other: AccessibilityTraits) -> AccessibilityTraits

Returns a new set with the elements that are either in this set or in the given set, but not in both. In the following example, the `eitherNeighborsOrEmployees` set is made up of the elements of the `employees` and `neighbors` sets that are not in both `employees` *and* `neighbors`. In particular, the names `"Bethany"` and `"Eric"` do not appear in `eitherNeighborsOrEmployees`. let employees: Set = ["Alicia", "Bethany", "Diana", "Eric"] let neighbors: Set = ["Bethany", "Eric", "Forlani"] let eitherNeighborsOrEmployees = employees.symmetricDifference(neighbors) print(eitherNeighborsOrEmployees) // Prints "["Diana", "Forlani", "Alicia"]" - Parameter other: A set of the same type as the current set. - Returns: A new set.

get · iOS 13.0+

allowsDirectInteraction

TypeScript

static get allowsDirectInteraction(): AccessibilityTraits

Swift declaration

static let allowsDirectInteraction: AccessibilityTraits

The accessibility element allows direct touch interaction for VoiceOver users.

method · iOS 13.0+

formSymmetricDifference

TypeScript

formSymmetricDifference(other: AccessibilityTraits): void

Swift declaration

mutating func formSymmetricDifference(_ other: AccessibilityTraits)

Removes the elements of the set that are also in the given set and adds the members of the given set that are not already in the set. In the following example, the elements of the `employees` set that are also members of `neighbors` are removed from `employees`, while the elements of `neighbors` that are not members of `employees` are added to `employees`. In particular, the names `"Bethany"` and `"Eric"` are removed from `employees` while the name `"Forlani"` is added. var employees: Set = ["Alicia", "Bethany", "Diana", "Eric"] let neighbors: Set = ["Bethany", "Eric", "Forlani"] employees.formSymmetricDifference(neighbors) print(employees) // Prints "["Diana", "Forlani", "Alicia"]" - Parameter other: A set of the same type.

method · iOS 13.0+

union

TypeScript

union(other: AccessibilityTraits): AccessibilityTraits

Swift declaration

func union(_ other: AccessibilityTraits) -> AccessibilityTraits

Returns a new set with the elements of both this and the given set. In the following example, the `attendeesAndVisitors` set is made up of the elements of the `attendees` and `visitors` sets: let attendees: Set = ["Alicia", "Bethany", "Diana"] let visitors = ["Marcia", "Nathaniel"] let attendeesAndVisitors = attendees.union(visitors) print(attendeesAndVisitors) // Prints "["Diana", "Nathaniel", "Bethany", "Alicia", "Marcia"]" If the set already contains one or more elements that are also in `other`, the existing members are kept. let initialIndices = Set(0..<5) let expandedIndices = initialIndices.union([2, 3, 6, 7]) print(expandedIndices) // Prints "[2, 4, 6, 7, 0, 1, 3]" - Parameter other: A set of the same type as the current set. - Returns: A new set with the unique elements of this set and `other`. - Note: if this set and `other` contain elements that are equal but distinguishable (e.g. via `===`), which of these elements is present in the result is unspecified.

method · iOS 13.0+

insert

TypeScript

insert(newMember: AccessibilityTraits): { "inserted": boolean; "memberAfterInsert": AccessibilityTraits }

Swift declaration

mutating func insert(_ newMember: AccessibilityTraits) -> (inserted: Bool, memberAfterInsert: AccessibilityTraits)

Inserts the given element in the set if it is not already present. If an element equal to `newMember` is already contained in the set, this method has no effect. In this example, a new element is inserted into `classDays`, a set of days of the week. When an existing element is inserted, the `classDays` set does not change. enum DayOfTheWeek: Int { case sunday, monday, tuesday, wednesday, thursday, friday, saturday } var classDays: Set<DayOfTheWeek> = [.wednesday, .friday] print(classDays.insert(.monday)) // Prints "(true, .monday)" print(classDays) // Prints "[.friday, .wednesday, .monday]" print(classDays.insert(.friday)) // Prints "(false, .friday)" print(classDays) // Prints "[.friday, .wednesday, .monday]" - Parameter newMember: An element to insert into the set. - Returns: `(true, newMember)` if `newMember` was not contained in the set. If an element equal to `newMember` was already contained in the set, the method returns `(false, oldMember)`, where `oldMember` is the element that was equal to `newMember`. In some cases, `oldMember` may be distinguishable from `newMember` by identity comparison or some other means.

get · iOS 13.0+

isLink

TypeScript

static get isLink(): AccessibilityTraits

Swift declaration

static let isLink: AccessibilityTraits

The accessibility element is a link.

method · iOS 13.0+

remove

TypeScript

remove(member: AccessibilityTraits): (AccessibilityTraits) | null

Swift declaration

mutating func remove(_ member: AccessibilityTraits) -> AccessibilityTraits?

Removes the given element and any elements subsumed by the given element. - Parameter member: The element of the set to remove. - Returns: For ordinary sets, an element equal to `member` if `member` is contained in the set; otherwise, `nil`. In some cases, a returned element may be distinguishable from `member` by identity comparison or some other means. For sets where the set type and element type are the same, like `OptionSet` types, this method returns any intersection between the set and `[member]`, or `nil` if the intersection is empty.

method · iOS 13.0+

update

TypeScript

update(newMember: AccessibilityTraits): (AccessibilityTraits) | null

Swift declaration

mutating func update(with newMember: AccessibilityTraits) -> AccessibilityTraits?

Inserts the given element into the set unconditionally. If an element equal to `newMember` is already contained in the set, `newMember` replaces the existing element. In this example, an existing element is inserted into `classDays`, a set of days of the week. enum DayOfTheWeek: Int { case sunday, monday, tuesday, wednesday, thursday, friday, saturday } var classDays: Set<DayOfTheWeek> = [.monday, .wednesday, .friday] print(classDays.update(with: .monday)) // Prints "Optional(.monday)" - Parameter newMember: An element to insert into the set. - Returns: For ordinary sets, an element equal to `newMember` if the set already contained such a member; otherwise, `nil`. In some cases, the returned element may be distinguishable from `newMember` by identity comparison or some other means. For sets where the set type and element type are the same, like `OptionSet` types, this method returns any intersection between the set and `[newMember]`, or `nil` if the intersection is empty.

get · iOS 13.0+

isImage

TypeScript

static get isImage(): AccessibilityTraits

Swift declaration

static let isImage: AccessibilityTraits

The accessibility element is an image.

get · iOS 13.0+

isModal

TypeScript

static get isModal(): AccessibilityTraits

Swift declaration

static let isModal: AccessibilityTraits

The accessibility element is modal. Use this trait to restrict which accessibility elements an assistive technology can navigate. When a modal accessibility element is visible, sibling accessibility elements that are not modal are ignored.

method · iOS 13.0+

contains

TypeScript

contains(member: AccessibilityTraits): boolean

Swift declaration

func contains(_ member: AccessibilityTraits) -> Bool

Returns a Boolean value that indicates whether the given element exists in the set. This example uses the `contains(_:)` method to test whether an integer is a member of a set of prime numbers. let primes: Set = [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37] let x = 5 if primes.contains(x) { print("\(x) is prime!") } else { print("\(x). Not prime.") } // Prints "5 is prime!" - Parameter member: An element to look for in the set. - Returns: `true` if `member` exists in the set; otherwise, `false`.

get · iOS 13.0+

isButton

TypeScript

static get isButton(): AccessibilityTraits

Swift declaration

static let isButton: AccessibilityTraits

The accessibility element is a button.

get · iOS 13.0+

isHeader

TypeScript

static get isHeader(): AccessibilityTraits

Swift declaration

static let isHeader: AccessibilityTraits

The accessibility element is a header that divides content into sections, like the title of a navigation bar.

get · iOS 17.0+

isTabBar

TypeScript

static get isTabBar(): AccessibilityTraits

Swift declaration

static let isTabBar: AccessibilityTraits

The accessibility element is a tab bar.

get · iOS 17.0+

isToggle

TypeScript

static get isToggle(): AccessibilityTraits

Swift declaration

static let isToggle: AccessibilityTraits

The accessibility element is a toggle.

method · iOS 13.0+

formUnion

TypeScript

formUnion(other: AccessibilityTraits): void

Swift declaration

mutating func formUnion(_ other: AccessibilityTraits)

Adds the elements of the given set to the set. In the following example, the elements of the `visitors` set are added to the `attendees` set: var attendees: Set = ["Alicia", "Bethany", "Diana"] let visitors: Set = ["Diana", "Marcia", "Nathaniel"] attendees.formUnion(visitors) print(attendees) // Prints "["Diana", "Nathaniel", "Bethany", "Alicia", "Marcia"]" If the set already contains one or more elements that are also in `other`, the existing members are kept. var initialIndices = Set(0..<5) initialIndices.formUnion([2, 3, 6, 7]) print(initialIndices) // Prints "[2, 4, 6, 7, 0, 1, 3]" - Parameter other: A set of the same type as the current set.

init · iOS 13.0+

init

TypeScript

static init(): AccessibilityTraits

Swift declaration

init()

Creates an empty set. This initializer is equivalent to initializing with an empty array literal. For example, you create an empty `Set` instance with either this initializer or with an empty array literal. var emptySet = Set<Int>() print(emptySet.isEmpty) // Prints "true" emptySet = [] print(emptySet.isEmpty) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All SwiftUICore types →