Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TabBarTemplateConfig

Hierarchy

  • TemplateConfig
    • TabBarTemplateConfig

Index

Properties

Methods

Properties

Optional id

id: string

Give the template your own ID. Must be unique.

Optional leadingNavigationBarButtons

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.

Optional tabImage

tabImage: null

Name of system image for tab

Optional tabSystemImg

tabSystemImg: string

Name of system image for tab

Optional tabSystemItem

tabSystemItem: number

UITabBarSystemItem

templates

templates: TabBarTemplates[]

The templates to show as tabs.

Optional title

title: string

The title displayed in the navigation bar while the tab bar template is visible.

Optional trailingNavigationBarButtons

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.

Methods

Optional onBarButtonPressed

  • onBarButtonPressed(e: BarButtonEvent): void

  • Fired when bar button is pressed

    Parameters

    • e: BarButtonEvent

      Event

    Returns void

Optional onDidAppear

  • onDidAppear(e: BaseEvent): void

  • Fired after template appears

    Parameters

    • e: BaseEvent

      Event

    Returns void

Optional onDidDisappear

  • onDidDisappear(e: BaseEvent): void

  • Fired after template disappears

    Parameters

    • e: BaseEvent

      Event

    Returns void

onTemplateSelect

  • onTemplateSelect(template: TabBarTemplates, e: { selectedTemplateId: string; templateId: string }): void

  • Parameters

    • template: TabBarTemplates
    • e: { selectedTemplateId: string; templateId: string }
      • selectedTemplateId: string
      • templateId: string

    Returns void

Optional onWillAppear

  • onWillAppear(e: BaseEvent): void

  • Fired before template appears

    Parameters

    • e: BaseEvent

      Event

    Returns void

Optional onWillDisappear

  • onWillDisappear(e: BaseEvent): void

  • Fired before template disappears

    Parameters

    • e: BaseEvent

      Event

    Returns void

Generated using TypeDoc