Liri Fluid API

AppBar QML Type

Application tool bar. More...

Import Statement: import Fluid.Controls 1.1

Properties

Methods

Detailed Description

For more information you can read the Material Design guidelines.

Property Documentation

actions : list<Action>

A list of actions to show in the action bar. These actions will be shown anchored to the right, and will overflow if there are more than the maximum number of actions as defined in maxActionCount.

When used with a page, the actions will be set to the page's Page::actions property, so set that instead of changing this directly.


backgroundColor : color

The background color of the tool bar when the AppBar's page is active. By default this is the primary color defined in Material.primaryColor

This property was introduced in Fluid.Controls 1.1.


customContent : list<Item>

Custom content to show instead of the title.

This property was introduced in Fluid.Controls 1.1.


decorationColor : color

The background color of the window decoration when the AppBar's page is active, usually a darker version of backgroundColor. By default this is the primary color defined in Material.primaryColor with a shade of Material.Shade700.

This property was introduced in Fluid.Controls 1.1.


elevation : int

The elevation of the action bar. Set to 0 if you want have a header or some other view below the action bar that you want to appear as part of the action bar.


extendedContent : list<Item>

A custom view to show under the row containing the title and actions. Causes the action bar to be extend in height to contain this view.

This property was introduced in Fluid.Controls 1.1.


[read-only] extendedContentHeight : real

The height of the custom view shown under the row containing the title and actions.

This property was introduced in Fluid.Controls 1.1.


leftAction : Action

The back action to display to the left of the title in the action bar. When used with a page, this will pick up the page's back action, which by default is a back arrow when there is a page behind the current page on the page stack. However, you can customize this, for example, to show a navigation drawer at the root of your app.

When using an action bar in a page, set the Page::leftAction instead of directly setting this property.


leftKeyline : real

Keyline to align contents to the left to be visually appealing.


maxActionCount : int

The maximum number of actions that can be displayed before they spill over into a drop-down menu. When using an action bar with a page, this inherits from the global AppToolBar::maxActionCount. If you are using an action bar for custom purposes outside of a toolbar, this defaults to 3.

Set to 0 if you don't want to overflow actions.


[read-only] overflowMenuVisible : bool

Value indicates if overflow menu is open or not.

This property was introduced in Fluid.Controls 1.1.


title : string

The title displayed in the action bar. When used in a page, the title will be set to the title of the page, so set the Page::title property instead of changing this directly.


toolbar : AppToolBar

Tool bar.


Method Documentation

void toggleOverflowMenu()

Toggle the overflow menu if the number of actions is greater than AppBar::maxActionCount.

This method was introduced in Fluid.Controls 1.1.