TypeScript API
Nowplayingtemplateconfig

Interface: NowPlayingTemplateConfig

Hierarchy

Table of contents

Properties

Methods

Properties

albumArtistButtonEnabled

Optional albumArtistButtonEnabled: boolean

Defined in

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


buttons

Optional buttons: NowPlayingButton[]

Defined in

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


id

Optional id: string

Give the template your own ID. Must be unique.

Inherited from

TemplateConfig.id

Defined in

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


leadingNavigationBarButtons

Optional leadingNavigationBarButtons: BarButton[]

An array of bar buttons to display on the leading side of the navigation bar.

The navigation bar displays up to two buttons in the leading space. When including more than two buttons in the array, the system displays only the first two buttons. iOS

Inherited from

TemplateConfig.leadingNavigationBarButtons

Defined in

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


tabImage

Optional tabImage: ImageSourcePropType

Image source for tab

Inherited from

TemplateConfig.tabImage

Defined in

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


tabSystemImageName

Optional tabSystemImageName: string

Name of system image for tab

Inherited from

TemplateConfig.tabSystemImageName

Defined in

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


tabSystemItem

Optional tabSystemItem: number

UITabBarSystemItem

Inherited from

TemplateConfig.tabSystemItem

Defined in

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


tabTitle

Optional tabTitle: string

Set tab title

Inherited from

TemplateConfig.tabTitle

Defined in

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


trailingNavigationBarButtons

Optional trailingNavigationBarButtons: BarButton[]

An array of bar buttons to display on the trailing side of the navigation bar.

The navigation bar displays up to two buttons in the trailing space. When including more than two buttons in the array, the system displays only the first two buttons. iOS

Inherited from

TemplateConfig.trailingNavigationBarButtons

Defined in

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


upNextButtonEnabled

Optional upNextButtonEnabled: boolean

Defined in

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


upNextButtonTitle

Optional upNextButtonTitle: string

Defined in

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

Methods

onAlbumArtistButtonPressed

onAlbumArtistButtonPressed(): void

Returns

void

Defined in

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


onBarButtonPressed

onBarButtonPressed(e): void

Fired when bar button is pressed

Parameters

NameTypeDescription
eBarButtonEventEvent

Returns

void

Inherited from

TemplateConfig.onBarButtonPressed

Defined in

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


onButtonPressed

onButtonPressed(e): void

Parameters

NameType
eObject
e.idstring
e.templateIdstring

Returns

void

Defined in

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


onDidAppear

onDidAppear(e): void

Fired after template appears

Parameters

NameTypeDescription
eBaseEventEvent

Returns

void

Inherited from

TemplateConfig.onDidAppear

Defined in

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


onDidDisappear

onDidDisappear(e): void

Fired after template disappears

Parameters

NameTypeDescription
eBaseEventEvent

Returns

void

Inherited from

TemplateConfig.onDidDisappear

Defined in

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


onUpNextButtonPressed

onUpNextButtonPressed(): void

Returns

void

Defined in

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


onWillAppear

onWillAppear(e): void

Fired before template appears

Parameters

NameTypeDescription
eBaseEventEvent

Returns

void

Inherited from

TemplateConfig.onWillAppear

Defined in

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


onWillDisappear

onWillDisappear(e): void

Fired before template disappears

Parameters

NameTypeDescription
eBaseEventEvent

Returns

void

Inherited from

TemplateConfig.onWillDisappear

Defined in

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