Skip to content

Commit

Permalink
docs: added more info to global header. Info about where to use the h…
Browse files Browse the repository at this point in the history
…eader (#206)
  • Loading branch information
DE7924 authored Nov 11, 2024
1 parent 6e13502 commit c9c84c0
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions lib/src/components/global_header/global_header.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,36 @@ import 'package:flutter/rendering.dart';
import '../../../zeta_flutter.dart';

/// Global header component
/// This component should not be used as an appbar in a scaffold.
/// It can be used in custom scroll views and columns.
///
/// ```
/// SingleChildScrollView(
/// child: Column(children: [
/// ZetaGlobalHeader(
/// title: "Title",
/// tabItems: childrenOne,
/// searchBar: ZetaSearchBar(shape: ZetaWidgetBorder.full, size: ZetaWidgetSize.large),
/// onAppsButton: () {},
/// actionButtons: [
/// IconButton(
/// onPressed: () {},
/// icon: const ZetaIcon(
/// ZetaIcons.alert,
/// ),
/// ),
/// IconButton(
/// onPressed: () {},
/// icon: const ZetaIcon(
/// ZetaIcons.help,
/// ),
/// ),
/// ],
/// avatar: const ZetaAvatar(initials: 'PS'),
/// ),
/// ]),
/// ),
/// ```
/// {@category Components}
///
/// Figma: https://www.figma.com/design/JesXQFLaPJLc1BdBM4sisI/%F0%9F%A6%93-ZDS---Components?node-id=1120-26358&node-type=canvas&m=dev
Expand Down

0 comments on commit c9c84c0

Please sign in to comment.