NavPanel

(esrith/amos/container/NavPanel)

NavPanel is a navigation panel. It is a collection of pages which will guide user from page to page.

Description
Type Description
currentPageIndex Number

Page index number that is currently displayed (index starts at 0). If no page is displayed, index will equal to null.

pages Array

Array of NavContent Objects which represent every page in navigation panel.

Return type Description
back() None

Go to previous page.

goTo(index) None

Jump to a specific page.

next() None

Go to next page.

pop() None

Destroy every page beyond current page, including itself, then go back to previous page.

push(newPage) None

Destroy every page beyond current page, then push a new page, and display it.

refresh() None

Refresh current page.

Description
page-changing (pageBefore, pageToShow)

Fires when page is changing

page-destory (page)

Fires when page is destroyed

page-show (page)

Fires when page is shown.

Constructors Detail
Properties Detail
<Number>
currentPageIndex

Page index number that is currently displayed (index starts at 0). If no page is displayed, index will equal to null.

<Array>
pages

Array of NavContent Objects which represent every page in navigation panel.

Methods Detail
back
()

Go to previous page.

goTo
(
  • index
)

Jump to a specific page.

Parameters
  • <Number> index Required

    page index you want to display (index start at 0)

next
()

Go to next page.

pop
()

Destroy every page beyond current page, including itself, then go back to previous page.

push
(
  • newPage
)

Destroy every page beyond current page, then push a new page, and display it.

Parameters
  • <NavContent Object> newPage Required

    new page you want to push.

refresh
()

Refresh current page.

Events Detail
page-changing (pageBefore, pageToShow)

Fires when page is changing

Event Payload:
  • <Object> pageBefore

    -NavContent JSON Object

  • <Object> pageToShow

    -NavContent JSON Object

page-destory (page)

Fires when page is destroyed

Event Payload:
  • <Object> page

    -NavContent JSON Object

page-show (page)

Fires when page is shown.

Event Payload:
  • <Object> page

    -NavContent JSON Object