One Logo Pool Ball
UIKit · IOS API REFERENCE

UIWritingToolsCoordinator

class · iOS 18.2+ · SDK 27.1

@MainActor class UIWritingToolsCoordinator

Members (22)

get · iOS 18.2+

isWritingToolsAvailable

TypeScript
static get isWritingToolsAvailable(): Promise<boolean>
Swift declaration
class var isWritingToolsAvailable: Bool { get }
method · iOS 27.0+

cancelTextAnimations

TypeScript
cancelTextAnimations(identifiers: Array<string>): Promise<void>
Swift declaration
func cancelTextAnimations(identifiers: [UUID])
init · iOS 18.2+

init

TypeScript
static init(delegate?: (SDKHandle) | null): Promise<UIWritingToolsCoordinator>
Swift declaration
init(delegate: (any UIWritingToolsCoordinator.Delegate)?)
method · iOS 27.0+

showGrammarPresentation

TypeScript
showGrammarPresentation(range: SDKHandle, context: UIWritingToolsCoordinator_Context): Promise<boolean>
Swift declaration
func showGrammarPresentation(for range: NSRange, in context: UIWritingToolsCoordinator.Context) -> Bool
method · iOS 27.0+

startTextAnimation

TypeScript
startTextAnimation(textAnimation: UIWritingToolsCoordinator_TextAnimation, range: SDKHandle, context: UIWritingToolsCoordinator_Context, writingDirection: NSWritingDirection): Promise<(string) | null>
Swift declaration
func startTextAnimation(_ textAnimation: UIWritingToolsCoordinator.TextAnimation, for range: NSRange, in context: UIWritingToolsCoordinator.Context, writingDirection: NSWritingDirection) -> UUID?
method · iOS 18.2+

stopWritingTools

TypeScript
stopWritingTools(): Promise<void>
Swift declaration
func stopWritingTools()
method · iOS 18.2+

updateForReflowedTextInContextWithIdentifier

TypeScript
updateForReflowedTextInContextWithIdentifier(contextID: string): Promise<void>
Swift declaration
func updateForReflowedTextInContextWithIdentifier(_ contextID: UUID)
method · iOS 18.2+

updateRange

TypeScript
updateRange(range: SDKHandle, replacementText: _Foundation_NSAttributedString, reason: UIWritingToolsCoordinator_TextUpdateReason, contextID: string): Promise<void>
Swift declaration
func updateRange(_ range: NSRange, with replacementText: NSAttributedString, reason: UIWritingToolsCoordinator.TextUpdateReason, forContextWithIdentifier contextID: UUID)
get · iOS 18.2+

behavior

TypeScript
get behavior(): Promise<UIWritingToolsBehavior>
Swift declaration
var behavior: UIWritingToolsBehavior { get }
get · iOS 18.2+

decorationContainerView

TypeScript
get decorationContainerView(): Promise<(UIView) | null>
Swift declaration
weak var decorationContainerView: UIView? { get set }
set · iOS 18.2+

decorationContainerView

TypeScript
setDecorationContainerView(value?: (UIView) | null): Promise<void>
Swift declaration
weak var decorationContainerView: UIView? { get set }
get · iOS 18.2+

delegate

TypeScript
get delegate(): Promise<(SDKHandle) | null>
Swift declaration
weak var delegate: (any UIWritingToolsCoordinator.Delegate)? { get }
get · iOS 18.2+

effectContainerView

TypeScript
get effectContainerView(): Promise<(UIView) | null>
Swift declaration
weak var effectContainerView: UIView? { get set }
set · iOS 18.2+

effectContainerView

TypeScript
setEffectContainerView(value?: (UIView) | null): Promise<void>
Swift declaration
weak var effectContainerView: UIView? { get set }
get · iOS 26.0+

includesTextListMarkers

TypeScript
get includesTextListMarkers(): Promise<boolean>
Swift declaration
var includesTextListMarkers: Bool { get set }
set · iOS 26.0+

includesTextListMarkers

TypeScript
setIncludesTextListMarkers(value: boolean): Promise<void>
Swift declaration
var includesTextListMarkers: Bool { get set }
get · iOS 18.2+

preferredBehavior

TypeScript
get preferredBehavior(): Promise<UIWritingToolsBehavior>
Swift declaration
var preferredBehavior: UIWritingToolsBehavior { get set }
set · iOS 18.2+

preferredBehavior

TypeScript
setPreferredBehavior(value: UIWritingToolsBehavior): Promise<void>
Swift declaration
var preferredBehavior: UIWritingToolsBehavior { get set }
get · iOS 18.2+

preferredResultOptions

TypeScript
get preferredResultOptions(): Promise<UIWritingToolsResultOptions>
Swift declaration
var preferredResultOptions: UIWritingToolsResultOptions { get set }
set · iOS 18.2+

preferredResultOptions

TypeScript
setPreferredResultOptions(value: UIWritingToolsResultOptions): Promise<void>
Swift declaration
var preferredResultOptions: UIWritingToolsResultOptions { get set }
get · iOS 18.2+

resultOptions

TypeScript
get resultOptions(): Promise<UIWritingToolsResultOptions>
Swift declaration
var resultOptions: UIWritingToolsResultOptions { get }
get · iOS 18.2+

state

TypeScript
get state(): Promise<UIWritingToolsCoordinator_State>
Swift declaration
var state: UIWritingToolsCoordinator.State { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

UIWritingToolsCoordinator.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All UIKit types →