<!--
{
  "availability" : [
    "iOS: 13.4.0 -",
    "iPadOS: 13.4.0 -",
    "macCatalyst: 13.4.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "CarPlay",
  "identifier" : "/documentation/CarPlay/CPDashboardButton",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "CarPlay"
    ],
    "preciseIdentifier" : "c:objc(cs)CPDashboardButton"
  },
  "title" : "CPDashboardButton"
}
-->

# CPDashboardButton

A shortcut button for placement on the CarPlay Dashboard.

```
class CPDashboardButton
```

## Topics

### Creating a Dashboard Button

[`init(titleVariants: [String], subtitleVariants: [String], image: UIImage, handler: ((CPDashboardButton) -> Void)?)`](/documentation/CarPlay/CPDashboardButton/init(titleVariants:subtitleVariants:image:handler:))

Creates a dashboard button that displays a title, an optional subtitle, and an image.

### Accessing the Button Configuration

[`var titleVariants: [String]`](/documentation/CarPlay/CPDashboardButton/titleVariants)

The array of title variants for the button.

[`var subtitleVariants: [String]`](/documentation/CarPlay/CPDashboardButton/subtitleVariants)

The array of subtitle variants for the button.

[`var image: UIImage`](/documentation/CarPlay/CPDashboardButton/image)

The image the button displays.

### Initializers

[`init?(coder: NSCoder)`](/documentation/CarPlay/CPDashboardButton/init(coder:))

## Relationships

### Conforms To

[`NSSecureCoding`](/documentation/Foundation/NSSecureCoding)

[`Hashable`](/documentation/Swift/Hashable)

[`Equatable`](/documentation/Swift/Equatable)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`NSCoding`](/documentation/Foundation/NSCoding)

[`CVarArg`](/documentation/Swift/CVarArg)

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

### Inherits From

[`NSObject-swift.class`](/documentation/ObjectiveC/NSObject-swift.class)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)