UIKit · IOS API REFERENCE

UIBackgroundConfiguration

struct · iOS 14.0+ · SDK 27.1

struct UIBackgroundConfiguration

Members (45)

get · iOS 14.0+

customView

TypeScript

get customView(): (UIView) | null

Swift declaration

var customView: UIView? { get set }

set · iOS 14.0+

customView

TypeScript

set customView(value: (UIView) | null)

Swift declaration

var customView: UIView? { get set }

static · iOS 18.0+

listFooter

TypeScript

static listFooter(): UIBackgroundConfiguration

Swift declaration

static func listFooter() -> UIBackgroundConfiguration

static · iOS 18.0+

listHeader

TypeScript

static listHeader(): UIBackgroundConfiguration

Swift declaration

static func listHeader() -> UIBackgroundConfiguration

get · iOS 14.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 14.0+

strokeColor

TypeScript

get strokeColor(): (UIColor) | null

Swift declaration

var strokeColor: UIColor? { get set }

set · iOS 14.0+

strokeColor

TypeScript

set strokeColor(value: (UIColor) | null)

Swift declaration

var strokeColor: UIColor? { get set }

get · iOS 14.0+

strokeWidth

TypeScript

get strokeWidth(): number

Swift declaration

var strokeWidth: CGFloat { get set }

set · iOS 14.0+

strokeWidth

TypeScript

set strokeWidth(value: number)

Swift declaration

var strokeWidth: CGFloat { get set }

get · iOS 14.0+

cornerRadius

TypeScript

get cornerRadius(): number

Swift declaration

var cornerRadius: CGFloat { get set }

set · iOS 14.0+

cornerRadius

TypeScript

set cornerRadius(value: number)

Swift declaration

var cornerRadius: CGFloat { get set }

get · iOS 14.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

var customMirror: Mirror { get }

The custom mirror for this instance. If this type has value semantics, the mirror should be unaffected by subsequent mutations of the instance.

get · iOS 14.0+

strokeOutset

TypeScript

get strokeOutset(): number

Swift declaration

var strokeOutset: CGFloat { get set }

set · iOS 14.0+

strokeOutset

TypeScript

set strokeOutset(value: number)

Swift declaration

var strokeOutset: CGFloat { get set }

get · iOS 14.0+

visualEffect

TypeScript

get visualEffect(): (UIVisualEffect) | null

Swift declaration

var visualEffect: UIVisualEffect? { get set }

set · iOS 14.0+

visualEffect

TypeScript

set visualEffect(value: (UIVisualEffect) | null)

Swift declaration

var visualEffect: UIVisualEffect? { get set }

static · iOS 14.0+ · Deprecated in iOS 18.0

listPlainCell

TypeScript

static listPlainCell(): UIBackgroundConfiguration

Swift declaration

static func listPlainCell() -> UIBackgroundConfiguration

get · iOS 14.0+

backgroundColor

TypeScript

get backgroundColor(): (UIColor) | null

Swift declaration

var backgroundColor: UIColor? { get set }

set · iOS 14.0+

backgroundColor

TypeScript

set backgroundColor(value: (UIColor) | null)

Swift declaration

var backgroundColor: UIColor? { get set }

static · iOS 14.0+ · Deprecated in iOS 18.0

listGroupedCell

TypeScript

static listGroupedCell(): UIBackgroundConfiguration

Swift declaration

static func listGroupedCell() -> UIBackgroundConfiguration

static · iOS 14.0+ · Deprecated in iOS 18.0

listSidebarCell

TypeScript

static listSidebarCell(): UIBackgroundConfiguration

Swift declaration

static func listSidebarCell() -> UIBackgroundConfiguration

get · iOS 14.0+

backgroundInsets

TypeScript

get backgroundInsets(): { top: number; leading: number; bottom: number; trailing: number }

Swift declaration

var backgroundInsets: NSDirectionalEdgeInsets { get set }

set · iOS 14.0+

backgroundInsets

TypeScript

set backgroundInsets(value: { top: number; leading: number; bottom: number; trailing: number })

Swift declaration

var backgroundInsets: NSDirectionalEdgeInsets { get set }

get · iOS 14.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 15.0+

imageContentMode

TypeScript

get imageContentMode(): UIView_ContentMode

Swift declaration

var imageContentMode: UIView.ContentMode { get set }

set · iOS 15.0+

imageContentMode

TypeScript

set imageContentMode(value: UIView_ContentMode)

Swift declaration

var imageContentMode: UIView.ContentMode { get set }

get · iOS 18.0+

shadowProperties

TypeScript

get shadowProperties(): UIShadowProperties

Swift declaration

var shadowProperties: UIShadowProperties { get set }

set · iOS 18.0+

shadowProperties

TypeScript

set shadowProperties(value: UIShadowProperties)

Swift declaration

var shadowProperties: UIShadowProperties { get set }

static · iOS 14.0+ · Deprecated in iOS 18.0

listSidebarHeader

TypeScript

static listSidebarHeader(): UIBackgroundConfiguration

Swift declaration

static func listSidebarHeader() -> UIBackgroundConfiguration

method · iOS 14.0+

resolvedStrokeColor

TypeScript

resolvedStrokeColor(tintColor: UIColor): UIColor

Swift declaration

func resolvedStrokeColor(for tintColor: UIColor) -> UIColor

static · iOS 14.0+ · Deprecated in iOS 18.0

listPlainHeaderFooter

TypeScript

static listPlainHeaderFooter(): UIBackgroundConfiguration

Swift declaration

static func listPlainHeaderFooter() -> UIBackgroundConfiguration

get · iOS 14.0+

strokeColorTransformer

TypeScript

get strokeColorTransformer(): (UIConfigurationColorTransformer) | null

Swift declaration

var strokeColorTransformer: UIConfigurationColorTransformer? { get set }

set · iOS 14.0+

strokeColorTransformer

TypeScript

set strokeColorTransformer(value: (UIConfigurationColorTransformer) | null)

Swift declaration

var strokeColorTransformer: UIConfigurationColorTransformer? { get set }

static · iOS 14.0+ · Deprecated in iOS 18.0

listGroupedHeaderFooter

TypeScript

static listGroupedHeaderFooter(): UIBackgroundConfiguration

Swift declaration

static func listGroupedHeaderFooter() -> UIBackgroundConfiguration

method · iOS 14.0+

resolvedBackgroundColor

TypeScript

resolvedBackgroundColor(tintColor: UIColor): UIColor

Swift declaration

func resolvedBackgroundColor(for tintColor: UIColor) -> UIColor

get · iOS 14.0+

backgroundColorTransformer

TypeScript

get backgroundColorTransformer(): (UIConfigurationColorTransformer) | null

Swift declaration

var backgroundColorTransformer: UIConfigurationColorTransformer? { get set }

set · iOS 14.0+

backgroundColorTransformer

TypeScript

set backgroundColorTransformer(value: (UIConfigurationColorTransformer) | null)

Swift declaration

var backgroundColorTransformer: UIConfigurationColorTransformer? { get set }

static · iOS 14.0+

listAccompaniedSidebarCell

TypeScript

static listAccompaniedSidebarCell(): UIBackgroundConfiguration

Swift declaration

static func listAccompaniedSidebarCell() -> UIBackgroundConfiguration

get · iOS 14.0+

edgesAddingLayoutMarginsToBackgroundInsets

TypeScript

get edgesAddingLayoutMarginsToBackgroundInsets(): NSDirectionalRectEdge

Swift declaration

var edgesAddingLayoutMarginsToBackgroundInsets: NSDirectionalRectEdge { get set }

set · iOS 14.0+

edgesAddingLayoutMarginsToBackgroundInsets

TypeScript

set edgesAddingLayoutMarginsToBackgroundInsets(value: NSDirectionalRectEdge)

Swift declaration

var edgesAddingLayoutMarginsToBackgroundInsets: NSDirectionalRectEdge { get set }

static · iOS 14.0+

clear

TypeScript

static clear(): UIBackgroundConfiguration

Swift declaration

static func clear() -> UIBackgroundConfiguration

get · iOS 15.0+

image

TypeScript

get image(): (UIImage) | null

Swift declaration

var image: UIImage? { get set }

set · iOS 15.0+

image

TypeScript

set image(value: (UIImage) | null)

Swift declaration

var image: UIImage? { get set }

method · iOS 14.0+

updated

TypeScript

updated(state: SDKHandle): UIBackgroundConfiguration

Swift declaration

func updated(for state: any UIConfigurationState) -> UIBackgroundConfiguration

static · iOS 18.0+

listCell

TypeScript

static listCell(): UIBackgroundConfiguration

Swift declaration

static func listCell() -> UIBackgroundConfiguration

Skipped declarations

No declarations were skipped in this snapshot.

All UIKit types →