80 lines
1.4 KiB
Markdown
80 lines
1.4 KiB
Markdown
**STRUCT**
|
|
|
|
# `HeaderBar`
|
|
|
|
A header bar widget.
|
|
|
|
## Properties
|
|
### `start`
|
|
|
|
The start content of the header bar.
|
|
|
|
### `end`
|
|
|
|
The end content of the header bar.
|
|
|
|
### `titleButtons`
|
|
|
|
Whether the title buttons are visible.
|
|
|
|
### `headerBarTitle`
|
|
|
|
The view acting as the title of the header bar.
|
|
|
|
### `startID`
|
|
|
|
The start content's id.
|
|
|
|
### `endID`
|
|
|
|
The end content's id.
|
|
|
|
### `titleID`
|
|
|
|
The title's id.
|
|
|
|
## Methods
|
|
### `init(titleButtons:start:end:)`
|
|
|
|
Initialize a header bar.
|
|
- Parameters:
|
|
- titleButtons: Whether the title buttons (e.g. close button) are visible.
|
|
- start: The start content.
|
|
- end: The end content.
|
|
|
|
### `empty()`
|
|
|
|
Initialize an empty header bar.
|
|
- Returns: The header bar.
|
|
|
|
### `start(start:)`
|
|
|
|
Initialize a header bar with only views at the start.
|
|
- Parameter start: The views.
|
|
- Returns: The header bar.
|
|
|
|
### `end(end:)`
|
|
|
|
Initialize a header bar with only views at the end.
|
|
- Parameter start: The views.
|
|
- Returns: The header bar.
|
|
|
|
### `update(_:modifiers:)`
|
|
|
|
Update a header bar's view storage.
|
|
- Parameters:
|
|
- storage: The view storage.
|
|
- modifiers: Modify views before being updated.
|
|
|
|
### `container(modifiers:)`
|
|
|
|
Get the container for a header bar.
|
|
- Parameter modifiers: Modify views before being updated.
|
|
- Returns: The view storage.
|
|
|
|
### `headerBarTitle(view:)`
|
|
|
|
Set the title widget for the header bar.
|
|
- Parameter view: The widget in the header bar.
|
|
- Returns: The header bar.
|