CarPlay · IOS API REFERENCE

CPGridButton

class · iOS 12.0+ · SDK 27.1

class CPGridButton

Members (9)

init · iOS 12.0+

init

TypeScript

static initTitleVariantsImageHandler(titleVariants: Array<string>, image: _UIKit_UIImage, handler?: (((arg0: CPGridButton) => void)) | null): CPGridButton

Swift declaration

convenience init(titleVariants: [String], image: UIImage, handler: ((CPGridButton) -> Void)? = nil)

init · iOS 26.0+

init

TypeScript

static initTitleVariantsImageMessageConfigurationHandler(titleVariants: Array<string>, image: _UIKit_UIImage, messageConfiguration?: (CPMessageGridItemConfiguration) | null, handler?: (((arg0: CPGridButton) => void)) | null): CPGridButton

Swift declaration

init(titleVariants: [String], image: UIImage, messageConfiguration: CPMessageGridItemConfiguration?, handler: ((CPGridButton) -> Void)? = nil)

method · iOS 26.0+

updateImage

TypeScript

updateImage(image: _UIKit_UIImage): void

Swift declaration

func updateImage(_ image: UIImage)

method · iOS 26.0+

updateTitleVariants

TypeScript

updateTitleVariants(titleVariants: Array<string>): void

Swift declaration

func updateTitleVariants(_ titleVariants: [String])

get · iOS 12.0+

isEnabled

TypeScript

get isEnabled(): boolean

Swift declaration

var isEnabled: Bool { get set }

set · iOS 12.0+

isEnabled

TypeScript

set isEnabled(value: boolean)

Swift declaration

var isEnabled: Bool { get set }

get · iOS 12.0+

image

TypeScript

get image(): _UIKit_UIImage

Swift declaration

var image: UIImage { get }

get · iOS 26.0+

messageConfiguration

TypeScript

get messageConfiguration(): (CPMessageGridItemConfiguration) | null

Swift declaration

var messageConfiguration: CPMessageGridItemConfiguration? { get }

get · iOS 12.0+

titleVariants

TypeScript

get titleVariants(): Array<string>

Swift declaration

var titleVariants: [String] { get }

Skipped declarations

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

CPGridButton.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All CarPlay types →