One Logo Pool Ball
SwiftUI · IOS API REFERENCE

ToolbarCustomizationOptions

struct · iOS 16.0+ · SDK 27.1

struct ToolbarCustomizationOptions

Options that influence the default customization behavior of customizable toolbar content. Use this type in conjunction with the ``CustomizableToolbarContent/defaultCustomization(_:options:)`` modifier.

Members (4)

get · iOS 16.0+

alwaysAvailable

TypeScript
get alwaysAvailable(): ToolbarCustomizationOptions
Swift declaration
static var alwaysAvailable: ToolbarCustomizationOptions { get }

Configures default customizable toolbar content to always be present in the toolbar. In iOS, default customizable toolbar content have the option of always being available in the toolbar regardless of the customization status of the user. These items will always be in the overflow menu of the toolbar. Users can customize whether the items are present as controls in the toolbar itself but will still always be able to access the item if they remove it from the toolbar itself. Consider using this for items that users should always be able to access, but may not be important enough to always occupy space in the toolbar itself.

init · iOS 16.0+

init

TypeScript
init(rawValue: number): ToolbarCustomizationOptions
Swift declaration
init(rawValue: Int)

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 16.0+

rawValue

TypeScript
getRawValue($self: ToolbarCustomizationOptions): number
Swift declaration
var rawValue: Int

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"

set · iOS 16.0+

rawValue

TypeScript
setRawValue($self: ToolbarCustomizationOptions, value: number): void
Swift declaration
var rawValue: Int

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"

Skipped declarations

No declarations were skipped in this snapshot.

All SwiftUI types →