Skip to content
Oguzhan Atalay edited this page Jan 24, 2026 · 1 revision

Frequently Asked Questions

General

Do I need a CarPlay entitlement from Apple?

For development: No. You can test using the CarPlay Simulator in Xcode.

For App Store: Yes. You must request a CarPlay entitlement from Apple. Apply at Apple's CarPlay page.


Does this work with Android Auto?

Yes! Android Auto support was added in v1.2.0. Not all features are available yet, but basic templates work. See Android Auto Setup.


Can I test CarPlay without a real car?

Yes! Use the CarPlay Simulator:

  • Xcode: I/O → External Displays → CarPlay
  • Standalone: Xcode → Open Developer Tool → CarPlay Simulator

What iOS version is required?

iOS 14.0 or later. CarPlay templates were introduced in iOS 12, but this package requires iOS 14+.


Features

How do I show album art / images?

Use the image property on list items:

CPListItem(
  text: 'Song',
  image: 'assets/album.png',     // Asset
  // Or: image: 'https://...jpg',  // URL
)

For URLs, images are loaded in the background (v1.2.4+).


How do I update list items dynamically?

Use updateSections() instead of recreating the template:

listTemplate.updateSections([
  CPListSection(items: [...newItems]),
]);

Can I hide the A-Z section index?

Yes! Added in v1.2.4:

CPListTemplate(
  sections: [...],
  sectionIndexEnabled: false,  // Hides the index
)

How do I navigate to a new screen?

Use push and pop:

// Navigate forward
FlutterCarplay.push(template: detailTemplate, animated: true);

// Go back
FlutterCarplay.pop(animated: true);

// Back to root
FlutterCarplay.popToRoot(animated: true);

How do I show an alert/dialog?

FlutterCarplay.showAlert(
  template: CPAlertTemplate(
    titleVariants: ['Alert Title'],
    actions: [
      CPAlertAction(
        title: 'OK',
        onPress: () => FlutterCarplay.popModal(animated: true),
      ),
    ],
  ),
);

How do I launch Apple Maps for navigation?

This isn't built into the package, but you can use URL schemes:

import 'package:url_launcher/url_launcher.dart';

void launchMaps(double lat, double lng) {
  final url = 'maps://?daddr=$lat,$lng';
  launchUrl(Uri.parse(url));
}

Limitations

What templates are NOT supported yet?

  • Map Template: Planned for future release
  • Search Template: Planned (PR was open but needs update)
  • Voice Control: Planned

Can I display custom Flutter UI on CarPlay?

No. CarPlay uses Apple's template system, not Flutter rendering. You can only use the provided templates (List, Grid, etc.).

This is an Apple restriction, not a package limitation.


Can I play video on CarPlay?

No. Apple doesn't allow video playback on CarPlay for safety reasons.


Does CarPlay work when the app is in background?

Yes, if configured correctly with the shared Flutter engine. See iOS Setup.


Can I have more than 4 tabs?

The Tab Bar supports up to 4 custom tabs. If Now Playing is active, iOS adds it as a 5th tab automatically.


Troubleshooting

Why does my app show a blank screen on CarPlay?

See Troubleshooting.

Why does the loader spin forever?

You forgot to call complete(). See Troubleshooting.

More questions?

Clone this wiki locally