NavigationStack

Provides a stack of Pages with navigation. More...

Import Statement: import VPlayApps 1.0
Inherits:

Item

Properties

Signals

Methods

Detailed Description

The NavigationStack item manages the navigation of hierarchical content represented by a stack of Pages.

Basic Usage

The pages presented by a NavigationStack item typically represent a hierarchical organization of the displayed data. At each level of the hierarchy, a custom Page component represents the content of the currently displayed screen.

As an example a simple hierachical settings app can look like the following:

The first page (the root screen) displays a list of main setting groups. The individual detail pages with the settings for a setting group can be pushed by calling the push() method of the associated NavigationStack item.

As an example, to push the General page after selecting the according row you can call:

navigationStack.push(detailPage)

A third page in the stack and all other following can be pushed accordingly.

Note: If you plan to use the split view feature (which is enabled by default on tablets) you should use popAllExceptFirstAndPush() instead of push() for the first level page pushes within your navigation stack:

navigationStack.popAllExceptFirstAndPush(detailPage)

Note: This only applies to the first pages right after the initial page, for all other pushes you still use push().

You can also set additional properties for a newly pushed page, like in the following example for which an additional boolean property of the pushed detail page is set:

navigationStack.push(detailPage, { showAdvancedSettings: true })

Note: As seen in the previous two examples every Page item has a convenience property called navigationStack which is set to the parent NavigationStack item, if contained in any.

To navigate back to a previous page you can either use the provided back button in the NavigationBar. This back button is provided for all pages pushed to the stack except the root page. As an alternative (e.g. when you decided to hide the navigation bar on a specific page) you can also implement your own interaction element and call pop() on the NavigationStack item.

Split View on Tablets

The NavigationStack component supports a tablet optimized visualization that automatically uses a two pane layout on devices with a diameter of more than 5 inches. The previous settings example looks like the following on a tablet:

When splitView is enabled, the first page of your NavigationStack is shown in the left pane of the split layout, regardless of the currently pushed pages.

Note: As noted above make sure to use popAllExceptFirstAndPush() instead of push() for pushing the first level pages for the right pane.

For more details on how to enable and disable the split view feature have a look at splitView.

Property Documentation

read-onlycanNavigateBack : bool

Use this property to determine if one of either the currentPage or the leftColumnPage allow to navigate back. If it is true, Page::backNavigationEnabled is true for one of these pages and it is possible to open a previous page. The NavigationStack automatically shows a back button in the NavigationBar and allows to go back with the hardware back button if this is the case.

Calling pop() will always go to back to the previous page, even if the Page::backNavigationEnabled setting wouldn't allow it.

See also pop().


read-onlycurrentPage : Page

The currently shown page on top of the navigation stack.

See also currentTitle.


read-onlycurrentTitle : string

The title of the currently displayed page on top of the stack.

See also currentPage.


read-onlydepth : int

Use this readonly property to get the number of items currently pushed onto the stack. This property is if there is only the initial page on the stack.


initialPage : var

The first Page that is shown initially. Must be a QML item derived from Page.

If no initial page is set, the first Page item that is a child of the NavigationStack will be used as the initial page.

The following two definitions have the same effect:

NavigationStack {
  // initial page as child item
  Page { title: "initial page" }
}
NavigationStack {
  // initial page set via property
  initialPage: Page { title: "initial page" }
}

read-onlyleftColumnBar : NavigationBar

Use this readonly property to get a reference to the internal NavigationBar item for the left column when using splitView mode.

This QML property was introduced in V-Play 2.6.2.


leftColumnIndex : int

Usually the initial Page item within a NavigationStack is used as the left pane content when using the splitView layout.

There might be cases where you want to pin another page as the left content item. For that you can set this property to another index value of your page stack.

Note: This is an advanced setting, in most cases the default value of 0 is sufficient.


read-onlyleftColumnPage : var

The currently displayed page in the left column if using the splitView layout.


leftColumnWidth : real

Set this property to control the width of the left split view column when using the splitView layout.

By default this property is set to 300 dp or using at least one third of the width when below.


Use this readonly property to get a reference to the internal NavigationBar item used by this navigation stack.


Whether a drop shadow is shown below the NavigationBar of the navigation stack. The height of the shadow is customizable with the Theme.navigationBar.shadowHeight setting. By default, the shadow is automatically hidden if the currentPage contains a TabControl or AppTabBar, as they usually extend the top navigation and then add their own shadow.

This QML property was introduced in V-Play 2.10.0.


splitView : bool

Set this property to explicitely use or disable the split view feature of NavigationStack. In split view mode the NavigationStack uses a two column layout.

By default the split view feature is deactivated. To use the split view only on devices with a diameter of equally or greater than 5 inches, simply set:

NavigationStack {
  // Use splitview only on tablets
  splitView: tablet
}

You can also enable it for all devices by setting the property to true or disable it with false. It's also possible to use more advanced settings like in the following example:

NavigationStack {
  // Use splitview only in landscape mode on tablets
  splitView: tablet && landscape
}

See also splitViewActive and leftColumnWidth.


read-onlysplitViewActive : bool

You can use this readonly property to determine if the pages are currently shown with a split view layout.

Note: This property is only true if splitView is true, the navigation-stack is visible and the depth is greater than the leftColumnIndex.


read-onlytransitioning : bool

True, if a push or pop transition animation is currently running.


Signal Documentation

popped(Item page)

Emitted after a Page has been popped from the stack.


pushed(Item page)

Emitted after a Page has been pushed from the stack.


transitionFinished()

Emitted after the push or pop transition animation have finished.


Method Documentation

clearAndPush( source, options)

Clear the whole stack and show a new page.

Useful if a new top-level navigation is selected.


contains( page)

Returns true, if the passed page is inside the NavigationStack.


getPage( index, dontLoad)

Return the Page at the specified index of the stack. The index must be between 0 and depth - 1.

dontLoad is an optional argument, passed to StackView::get.


pop( options)

Pop from the NavigationStack.

options is an optional argument, passed to StackView::pop.


popAllExceptFirst()

Pop all pages except the first. Useful to remove all pages on the right side of a multi-column splitView layout.

Note: The page that at the position of the leftColumnIndex is considered the first page. Usually this is the page with index 0.


popAllExceptFirstAndPush( source, options)

Clears all pages except the first, then pushes a new one.

Note: The page that at the position of the leftColumnIndex is considered the first page. Usually this is the page with index 0.

Internally this function calls popAllExceptFirst() and then push(). This is useful if a navigation happens from the left column of a multi-column layout, as it pushes a page as top-level item in the right column.


push( source, options)

Push a Page onto the NavigationStack.

source can be either an URL to a QML file, a Component or a Page object. Note that it is not advised to directly push items.

options is any JS object used as properties for the created object, if source is an url or a Component.


Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support
Sign up for Free and start developing right away!
I want to make Games
I want to make Apps
Game Development
Cross-Platform, Any Resolution

Use one IDE to deploy to all supported platforms, including iOS and Android, from a single code base.

Support all screen resolutions, aspect ratios and sizes with auto-adapting UI elements, smart scene scaling and memory efficient asset selection.

Learn More

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Multiplayer

V-Play Multiplayer supports both real-time and turn-based gameplay, so you can use it to make many different types of cross-platform multiplayer games. It's perfect for making player-vs-player games like 'Words with Friends' or games for a large amount of players, such as 'Clash of Clans'.

Learn More Video

Highscores & Achievements

The V-Play Game Network is a cross-platform gaming service that allows players around the world to compare game highscores and achievements. Players can also challenge each other across multiple platforms and share their progress on Facebook.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code.

import QtQuick 2.0
import VPlay 2.0

GameWindow {
  Scene {
    
    SimpleButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Level Editor

The LevelEditor can be used during development to create and modify levels for your game, which you can then bundle in your final publishing build. Additionally, you can also integrate the in-game level editor to your published game and let your gamers create new levels.

Learn More Video

Card Game like UNO, Hearthstone or Poker

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/OneCard/OneCard.pro

Match-3 like Candy Crush Saga

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquash/JuicySquash.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquashAdvanced/JuicySquashAdvanced.pro

Puzzle like 2048 or Threes!

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/2048/2048.pro

Casino like Big Win Slots

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlaskOfRum/FlaskOfRum.pro

Side Scroller like Jetpack Joyride or Flappy Bird

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlappyBird/FlappyBird.pro

Tower Defense like Castle Defense or Bloons TD

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Squaby/Squaby.pro

Falldown & Jump like Doodle Jump or Mega Jump

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak/ChickenOutbreak.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak2/ChickenOutbreak2.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/DoodleJump/DoodleJump.pro

Platformer like Super Mario or Lep's World

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Platformer/Platformer.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Action like Angry Birds, Fruit Ninja, Cut the Rope

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/BalloonPop/BalloonPop.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/CarChallenge/CarChallenge.pro

Arcade like Arkanoid or Space Invaders

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ZombieBreak/ZombieBreak.pro

Community like Super Mario Maker or Minecraft

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/examples/Squaby/Squaby.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Any other Idea? let us know how we can help you

You are looking for another demo?

The V-Play SDK includes many open-source demos for different game genres. You can use their source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

If you do not find your game genre in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us

App Development
Better Apps, Less Effort

Develop feature-rich, cross-platform mobile apps from a single code base.

V-Play apps look, feel and perform exactly like native iOS, Android and Desktop apps. With less code & much faster development time.

Learn More Highlights Video

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Save Time, Code & Money

Save up to 90% source code with V-Play, compared to frameworks like Xamarin, Titanium, React Native and others.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code. QML also allows you to easily create smooth and complex animations.

import QtQuick 2.0
import VPlayApps 2.0

App {
  Page {
    
    AppButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Native Sensors & More

V-Play Apps harness the power of Qt, the leading cross-platform development framework used by over 1,000,000 developers.

This gives your access to native device features like sensors, camera, file system as well as multimedia, networking, localization and much more.

Learn More

Responsive Design

V-Play has built in responsive design capabilities, you can target phones and tablets with the same source code.

Learn More

Highly Extensible

You have existing JavaScript, C++ or native code? You want to add any 3rd party SDK that we do not offer already?

No worries, you can add any JS, C++, Java or Objective-C code to your project.

Learn More

Component Showcase App shows the most important V-Play features and components

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/showcase/Showcase.pro

Qt World Summit Conference App a full-featured conference management app made by V-Play

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/qtws2016/QtWS2016.pro

Twitter App how to build layouts like in the official Twitter app for iOS and Android

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/twitter/Twitter.pro

Maps App displays free bikes or boxes at bike stations for Vienna's bike sharing service Citybike Wien

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/maps/Maps.pro

Messaging App demonstrates how to create the UI of a Facebook Messenger like app

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/messaging/Messaging.pro

Weather App how to include powerful animations into your user interface

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/waether/Weather.pro

Any other Idea? let us know how we can help you

You are looking for another app demo?

The V-Play SDK includes many open-source demos for different app types. You can use their source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play..

If you do not find your app type in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us