SwiftUICore · IOS API REFERENCE

SafeAreaRegions

struct · iOS 14.0+ · SDK 27.1

@frozen struct SafeAreaRegions

A set of symbolic safe area regions.

Members (5)

get · iOS 14.0+

all

TypeScript

get all(): SafeAreaRegions

Swift declaration

static let all: SafeAreaRegions

All safe area regions.

get · iOS 14.0+

keyboard

TypeScript

get keyboard(): SafeAreaRegions

Swift declaration

static let keyboard: SafeAreaRegions

The safe area matching the current extent of any software keyboard displayed over the view content.

init · iOS 14.0+

init

TypeScript

init(rawValue: number): SafeAreaRegions

Swift declaration

init(rawValue: UInt)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 14.0+

rawValue

TypeScript

getRawValue($self: SafeAreaRegions): number

Swift declaration

let rawValue: UInt

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

get · iOS 14.0+

container

TypeScript

get container(): SafeAreaRegions

Swift declaration

static let container: SafeAreaRegions

The safe area defined by the device and containers within the user interface, including elements such as top and bottom bars.

Skipped declarations

No declarations were skipped in this snapshot.

All SwiftUICore types →