Class: ListTemplate

A hierarchical list of menu items can be displayed on the CarPlay screen using a list template.

The List Template allows navigation apps to present a hierarchical list of menu items. It includes a navigation bar and a list view.

The navigation bar includes a title, and up to two (2) leading buttons and two (2) trailing buttons. You can customize the appearance of these buttons with icons or text.

Each item in the list view may include an icon, title, subtitle, and an optional disclosure indicator indicating the presence of a submenu. The depth of the menu hierarchy may not exceed 5 levels. Note that some cars limit the total number of items that may be shown in a list.

Hierarchy

• Template<ListTemplateConfig>

  ↳ ListTemplate

Table of contents

Constructors

• constructor

Properties

• config
• id

Accessors

• eventMap
• type

Methods

• getMaximumListImageRowItemImageSize
• getMaximumListItemCount
• getMaximumListItemImageSize
• getMaximumListSectionCount
• getMaximumNumberOfGridImages
• parseConfig
• updateListTemplateItem
• updateSections
• updateTemplate

Constructors

constructor

• new ListTemplate(config): ListTemplate

Parameters

Returns

ListTemplate

Overrides

Template.constructor

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:128 (opens in a new tab)

Properties

config

• config: ListTemplateConfig

Inherited from

Template.config

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:128 (opens in a new tab)

id

• id: string

Inherited from

Template.id

Defined in

packages/react-native-carplay/src/templates/Template.ts:86 (opens in a new tab)

Accessors

eventMap

• get eventMap(): Object

Returns

Object

Overrides

Template.eventMap

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:122 (opens in a new tab)

type

• get type(): string

Returns

string

Overrides

Template.type

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:118 (opens in a new tab)

Methods

getMaximumListImageRowItemImageSize

▸ getMaximumListImageRowItemImageSize(): Promise<ImageSize>

Returns

Promise<ImageSize>

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:184 (opens in a new tab)

getMaximumListItemCount

▸ getMaximumListItemCount(): Promise<number>

Returns

Promise<number>

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:168 (opens in a new tab)

getMaximumListItemImageSize

▸ getMaximumListItemImageSize(): Promise<ImageSize>

Returns

Promise<ImageSize>

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:176 (opens in a new tab)

getMaximumListSectionCount

▸ getMaximumListSectionCount(): Promise<number>

Returns

Promise<number>

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:172 (opens in a new tab)

getMaximumNumberOfGridImages

▸ getMaximumNumberOfGridImages(): Promise<number>

Returns

Promise<number>

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:180 (opens in a new tab)

parseConfig

▸ parseConfig(config): any

Parameters

Returns

any

Inherited from

Template.parseConfig

Defined in

packages/react-native-carplay/src/templates/Template.ts:147 (opens in a new tab)

updateListTemplateItem

▸ updateListTemplateItem(config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:160 (opens in a new tab)

updateSections

▸ updateSections(sections): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/templates/ListTemplate.ts:155 (opens in a new tab)

updateTemplate

▸ updateTemplate(config): void

Parameters

Returns

void

Inherited from

Template.updateTemplate

Defined in

packages/react-native-carplay/src/templates/Template.ts:141 (opens in a new tab)