Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added more info to global header. Info about where to use the header #206

Merged
merged 1 commit into from
Nov 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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