Explorer

component fbx.ui.page.Explorer

Explorer is a container object used to contain a stack of views in an application. Application may navigate through successive pages.

Explorer shows an optional companion view on the side of each page shown.

../../../_images/explorer.png

An explorer view using a fbx.ui.page.Breadcrumb.

property baseUrl

URL acting as a root of subsequent pushed URLs. After a page has beed pushed in the explorer, subsequent pushes will be relative to top page URL.

property duration

Duration (in milliseconds) of the transition animation between pages.

property canPopRoot

Whether calling pop() will also pop the last page in explorer, leaving the user with an empty explorer.

property depth

Count of pages currently in the explorer.

property initialPage

URL (absolute or relative to baseUrl) of the root page in explorer. This is optional. If not set, explorer will start empty.

method push(url, defaults)
Parameters

  • url (string) – An URL to add in the component cache

  • defaults (object) – Properties to assign to the new item

Adds an item to the end of the explorer.

method replace(url, defaults)
Parameters

  • url (string) – An URL to add in the component cache

  • defaults (object) – Properties to assign to the new item

Does an atomic pop() then push().

method replaceAt(index, url, defaults)
Parameters

  • index (int) – Index to replace

  • url (string) – An URL to add in the component cache

  • defaults (object) – Properties to assign to the new item

Does an atomic popTo() then push(). Pushed page will replace page at index index.

method pop()

Remove the current top of the explorer.

method popTo(index)
Parameters

index (int) –

Removes items at top of stack in order to make stack item index new stack top.

This example will pop to root of page stack:

popTo(0)
property titleList

Current page stack.

See fbx.ui.controller.ComponentListModel.