TipKit · IOS API REFERENCE

TipUIView

class · iOS 17.0+ · SDK 27.1

@MainActor @objc @preconcurrency final class TipUIView

A user interface element that represents a tip.

Members (13)

get · iOS 17.0+

backgroundColor

TypeScript

get backgroundColor(): Promise<(_UIKit_UIColor) | null>

Swift declaration

@MainActor @preconcurrency override final var backgroundColor: UIColor? { get set }

The background color to use for the tip view.

set · iOS 17.0+

backgroundColor

TypeScript

setBackgroundColor(value?: (_UIKit_UIColor) | null): Promise<void>

Swift declaration

@MainActor @preconcurrency override final var backgroundColor: UIColor? { get set }

The background color to use for the tip view.

get · iOS 18.0+

imageStyle

TypeScript

get imageStyle(): Promise<(SDKHandle) | null>

Swift declaration

@MainActor @preconcurrency final var imageStyle: (any ShapeStyle)? { get set }

Foreground style for the tip's image.

set · iOS 18.0+

imageStyle

TypeScript

setImageStyle(value?: (SDKHandle) | null): Promise<void>

Swift declaration

@MainActor @preconcurrency final var imageStyle: (any ShapeStyle)? { get set }

Foreground style for the tip's image.

get · iOS 17.0+

cornerRadius

TypeScript

get cornerRadius(): Promise<number>

Swift declaration

@MainActor @preconcurrency final var cornerRadius: CGFloat { get set }

Corner radius for the tip view.

set · iOS 17.0+

cornerRadius

TypeScript

setCornerRadius(value: number): Promise<void>

Swift declaration

@MainActor @preconcurrency final var cornerRadius: CGFloat { get set }

Corner radius for the tip view.

get · iOS 26.0+

backgroundStyle

TypeScript

get backgroundStyle(): Promise<SDKHandle>

Swift declaration

@MainActor @preconcurrency final var backgroundStyle: any ShapeStyle { get set }

The background style to use for the tip view.

set · iOS 26.0+

backgroundStyle

TypeScript

setBackgroundStyle(value: SDKHandle): Promise<void>

Swift declaration

@MainActor @preconcurrency final var backgroundStyle: any ShapeStyle { get set }

The background style to use for the tip view.

get · iOS 17.0+

imageSize

TypeScript

get imageSize(): Promise<{ width: number; height: number }>

Swift declaration

@MainActor @preconcurrency final var imageSize: CGSize { get set }

Size of the image displayed in the tip view.

set · iOS 17.0+

imageSize

TypeScript

setImageSize(value: { width: number; height: number }): Promise<void>

Swift declaration

@MainActor @preconcurrency final var imageSize: CGSize { get set }

Size of the image displayed in the tip view.

get · iOS 17.0+

viewStyle

TypeScript

get viewStyle(): Promise<SDKHandle>

Swift declaration

@MainActor @preconcurrency final var viewStyle: any TipViewStyle { get set }

The given style for TipView within the view hierarchy.

set · iOS 17.0+

viewStyle

TypeScript

setViewStyle(value: SDKHandle): Promise<void>

Swift declaration

@MainActor @preconcurrency final var viewStyle: any TipViewStyle { get set }

The given style for TipView within the view hierarchy.

init · iOS 18.0+

init

TypeScript

static init(tip: SDKHandle, arrowEdge?: (_SwiftUICore_Edge) | null, actionHandler?: ((arg0: Tips_Action) => void)): Promise<TipUIView>

Swift declaration

@MainActor @preconcurrency init(_ tip: any Tip, arrowEdge: Edge? = nil, actionHandler: @escaping @MainActor @Sendable (Tips.Action) -> Void = { _ in })

Creates a tip view with an optional arrow edge and action handler. Use a `TipUIView` when you want to indicate the UI element to which the tip applies, but do not want to directly anchor the tip view to that element. - Parameters: - tip: The tip to display. - arrowEdge: The edge of the tip view that displays the arrow. - actionHandler: The closure to perform when the user triggers a tip's action.

Skipped declarations

No declarations were skipped in this snapshot.

All TipKit types →