Sidebar QML Type | Fluid Reference Documentation

- Fluid Reference Documentation
- Fluid 1.2.0

# Sidebar QML Type

A sidebar component for use in adaptive layouts. More...

Import Statement: | import Fluid.Controls 1.1

- List of all members, including inherited members

## Properties

- autoFlick : bool
- edge : enumeration
- expanded : bool
- header : string

## Detailed Description

To use, simply add an instance to your code, and anchor other components to it.

To show or hide, set the expanded property.

By default, the sidebar has a flickable built in, and whatever contents are added will be placed in the flickable. When you want this disabled, or want to fill the entire sidebar, set the autoFill property to false.

Examples:

     Item {
         property bool wideAspect: width > Units.gu(80)

         Sidebar {
             expanded: wideAspect

             // Anchoring is automatic
         }
     }

For more information you can read the Material Design guidelines.

## Property Documentation

autoFlick : bool

This property holds whether the sidebar is flickable or not.

edge : enumeration

This property holds the edge of the window at which the sidebar will be attached to. The acceptable values are:

Constant | Description
--- | ---
`Qt.TopEdge` | The top edge of the window.
`Qt.LeftEdge` | The left edge of the window (default).
`Qt.RightEdge` | The right edge of the window.
`Qt.BottomEdge` | The bottom edge of the window.

expanded : bool

This property holds whether to show or hide the sidebar.

header : string

This property holds the text displayed as header.