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.

Sign up for GitHub

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

Bottom navigation bar #76

Merged
merged 11 commits into from
Jul 16, 2024
Merged

Bottom navigation bar #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4ac489e
Boilerplate for bottom navigation bar
kawaijoe Jul 7, 2024
531dae7
Add bottom navigation bar item
kawaijoe Jul 14, 2024
9ba20ca
Boilerplate for bottom navigation bar
kawaijoe Jul 7, 2024
bbd4ab2
Add bottom navigation bar item
kawaijoe Jul 14, 2024
45c713c
Merge branch 'feature/bottom-navigation-bar' of https://github.com/fo…
kawaijoe Jul 14, 2024
db6f5a5
Complete implementation
kawaijoe Jul 16, 2024
6cb7f37
Merge branch 'main' into feature/bottom-navigation-bar
kawaijoe Jul 16, 2024
acf37b1
Commit from GitHub Actions (Forui Presubmit)
kawaijoe Jul 16, 2024
53f597d
Update changelog
kawaijoe Jul 16, 2024
c24e013
Commit from GitHub Actions (Forui Samples Presubmit)
kawaijoe Jul 16, 2024
0459bd5
Fix pr issues
kawaijoe Jul 16, 2024
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
77 changes: 77 additions & 0 deletions docs/pages/docs/bottom-navigation-bar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import {Callout} from "nextra/components";
import { Tabs } from 'nextra/components';
import { Widget } from "../../components/widget";

# Bottom Navigation Bar

A bottom navigation bar is usually present at the bottom of root pages.
It is used to navigate between a small number of views, typically between three and five.

<Tabs items={['Preview', 'Code']}>
<Tabs.Tab>
<Widget name='bottom-navigation-bar' query={{}}/>
</Tabs.Tab>
<Tabs.Tab>
```dart
class Application extends StatefulWidget {
const Application({super.key});

@override
State<Application> createState() => _ApplicationState();
}

class _ApplicationState extends State<Application> {
int index = 1;

@override
Widget build(BuildContext context) => FBottomNavigationBar(
index: index,
onChange: (index) => setState(() => this.index = index),
items: [
FBottomNavigationBarItem(
icon: FAssets.icons.home,
label: 'Home',
),
FBottomNavigationBarItem(
icon: FAssets.icons.layoutGrid,
label: 'Browse',
),
FBottomNavigationBarItem(
icon: FAssets.icons.radio,
label: 'Radio',
),
FBottomNavigationBarItem(
icon: FAssets.icons.libraryBig,
label: 'Library',
),
FBottomNavigationBarItem(
icon: FAssets.icons.search,
label: 'Search',
),
],
);
}
```
</Tabs.Tab>
</Tabs>

## Usage

<Callout type="info">
A bottom navigation bar is typically used with `FScaffold`. A working example can be found [here](/docs/scaffold).
</Callout>

### `FBottomNavigationBar(...)`

```dart
FBottomNavigationBar(
index: 0,
onChange: (index) => {},
items: [
FBottomNavigationBarItem(
icon: FAssets.icons.home,
label: 'Home',
),
],
)
```
6 changes: 5 additions & 1 deletion docs/pages/docs/header.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Tabs } from 'nextra/components';
import {Callout, Tabs} from 'nextra/components';
import { Widget } from "../../components/widget";

# Header
Expand Down Expand Up @@ -60,6 +60,10 @@ It is typically used on nested pages or sheets.

## Usage

<Callout type="info">
A header is typically used with `FScaffold`. A working example can be found [here](/docs/scaffold).
</Callout>

### `FHeader(...)`

```dart
Expand Down
68 changes: 63 additions & 5 deletions docs/pages/docs/scaffold.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@ Creates a visual scaffold for Forui widgets.
</Tabs.Tab>
<Tabs.Tab>
```dart
FScaffold(
header: FHeader(
final headers = [
const FHeader(title: Text('Home')),
const FHeader(title: Text('Categories')),
const FHeader(title: Text('Search')),
FHeader(
title: const Text('Settings'),
actions: [
FHeaderAction(
Expand All @@ -20,8 +23,24 @@ Creates a visual scaffold for Forui widgets.
),
],
),
content: ListView(
];

final contents = [
const Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [Text('Home Placeholder')],
),
const Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [Text('Categories Placeholder')],
),
const Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [Text('Search Placeholder')],
),
Column(
children: [
const SizedBox(height: 5),
FCard(
title: const Text('Account'),
subtitle: const Text('Make changes to your account here. Click save when you are done.'),
Expand All @@ -46,7 +65,46 @@ Creates a visual scaffold for Forui widgets.
),
],
),
);
];

class _Application extends StatefulWidget {
const _Application({super.key});

@override
State<_Application> createState() => _ApplicationState();
}

class _ApplicationState extends State<_Application> {
int index = 3;

@override
Widget build(BuildContext context) => FScaffold(
header: headers[index],
content: contents[index],
footer: FBottomNavigationBar(
index: index,
onChange: (index) => setState(() => this.index = index),
items: [
FBottomNavigationBarItem(
icon: FAssets.icons.home,
label: 'Home',
),
FBottomNavigationBarItem(
icon: FAssets.icons.layoutGrid,
label: 'Categories',
),
FBottomNavigationBarItem(
icon: FAssets.icons.search,
label: 'Search',
),
FBottomNavigationBarItem(
icon: FAssets.icons.settings,
label: 'Settings',
),
],
),
);
}
```
</Tabs.Tab>
</Tabs>
Expand Down Expand Up @@ -76,6 +134,6 @@ FScaffold(
),
],
),
footer: const Text('Created by Forus Labs'),
footer: FBottomNavigationBar(items: const []),
);
```
1 change: 1 addition & 0 deletions forui/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

### Additions
* Add `FCalendar`
* Add `FBottomNavigationBar`

### Enhancements
* **Breaking** Change `FSwitch` to be usable in `Form`s.
Expand Down
35 changes: 31 additions & 4 deletions forui/example/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,23 @@ void main() {
runApp(const Application());
}

/// The application widget.
class Application extends StatelessWidget {
/// Creates an application widget.
class Application extends StatefulWidget {
const Application({super.key});

@override
State<Application> createState() => _ApplicationState();
}

class _ApplicationState extends State<Application> {
int index = 1;

@override
Widget build(BuildContext context) => MaterialApp(
builder: (context, child) => FTheme(
data: FThemes.zinc.light,
child: FScaffold(
header: FHeader(
title: const Text('Example Example Example Example'),
title: const Text('Example'),
actions: [
FHeaderAction(
icon: FAssets.icons.plus,
Expand All @@ -28,6 +33,28 @@ class Application extends StatelessWidget {
],
),
content: child ?? const SizedBox(),
footer: FBottomNavigationBar(
index: index,
onChange: (index) => setState(() => this.index = index),
items: [
FBottomNavigationBarItem(
icon: FAssets.icons.home,
label: 'Home',
),
FBottomNavigationBarItem(
icon: FAssets.icons.layoutGrid,
label: 'Categories',
),
FBottomNavigationBarItem(
icon: FAssets.icons.search,
label: 'Search',
),
FBottomNavigationBarItem(
icon: FAssets.icons.settings,
label: 'Settings',
),
],
),
),
),
home: const Example(),
Expand Down
10 changes: 10 additions & 0 deletions forui/lib/src/theme/theme_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ final class FThemeData with Diagnosticable {
/// The badge styles.
final FBadgeStyles badgeStyles;

/// The bottom navigation bar style.
final FBottomNavigationBarStyle bottomNavigationBarStyle;

/// The button styles.
final FButtonStyles buttonStyles;

Expand Down Expand Up @@ -73,6 +76,7 @@ final class FThemeData with Diagnosticable {
FThemeData({
required this.colorScheme,
required this.badgeStyles,
required this.bottomNavigationBarStyle,
required this.buttonStyles,
required this.calendarStyle,
required this.cardStyle,
Expand Down Expand Up @@ -102,6 +106,7 @@ final class FThemeData with Diagnosticable {
typography: typography,
style: style,
badgeStyles: FBadgeStyles.inherit(colorScheme: colorScheme, typography: typography, style: style),
bottomNavigationBarStyle: FBottomNavigationBarStyle.inherit(colorScheme: colorScheme, typography: typography),
buttonStyles: FButtonStyles.inherit(colorScheme: colorScheme, typography: typography, style: style),
calendarStyle: FCalendarStyle.inherit(colorScheme: colorScheme, typography: typography, style: style),
cardStyle: FCardStyle.inherit(colorScheme: colorScheme, typography: typography, style: style),
Expand Down Expand Up @@ -139,6 +144,7 @@ final class FThemeData with Diagnosticable {
FTypography? typography,
FStyle? style,
FBadgeStyles? badgeStyles,
FBottomNavigationBarStyle? bottomNavigationBarStyle,
FButtonStyles? buttonStyles,
FCalendarStyle? calendarStyle,
FCardStyle? cardStyle,
Expand All @@ -157,6 +163,7 @@ final class FThemeData with Diagnosticable {
typography: typography ?? this.typography,
style: style ?? this.style,
badgeStyles: badgeStyles ?? this.badgeStyles,
bottomNavigationBarStyle: bottomNavigationBarStyle ?? this.bottomNavigationBarStyle,
buttonStyles: buttonStyles ?? this.buttonStyles,
calendarStyle: calendarStyle ?? this.calendarStyle,
cardStyle: cardStyle ?? this.cardStyle,
Expand All @@ -179,6 +186,7 @@ final class FThemeData with Diagnosticable {
..add(DiagnosticsProperty('typography', typography, level: DiagnosticLevel.debug))
..add(DiagnosticsProperty('style', style, level: DiagnosticLevel.debug))
..add(DiagnosticsProperty('badgeStyles', badgeStyles, level: DiagnosticLevel.debug))
..add(DiagnosticsProperty('bottomNavigationBarStyle', bottomNavigationBarStyle, level: DiagnosticLevel.debug))
..add(DiagnosticsProperty('buttonStyles', buttonStyles, level: DiagnosticLevel.debug))
..add(DiagnosticsProperty('calendarStyle', calendarStyle, level: DiagnosticLevel.debug))
..add(DiagnosticsProperty('cardStyle', cardStyle, level: DiagnosticLevel.debug))
Expand All @@ -202,6 +210,7 @@ final class FThemeData with Diagnosticable {
typography == other.typography &&
style == other.style &&
badgeStyles == other.badgeStyles &&
bottomNavigationBarStyle == other.bottomNavigationBarStyle &&
buttonStyles == other.buttonStyles &&
calendarStyle == other.calendarStyle &&
cardStyle == other.cardStyle &&
Expand All @@ -221,6 +230,7 @@ final class FThemeData with Diagnosticable {
typography.hashCode ^
style.hashCode ^
badgeStyles.hashCode ^
bottomNavigationBarStyle.hashCode ^
buttonStyles.hashCode ^
calendarStyle.hashCode ^
cardStyle.hashCode ^
Expand Down
Loading
Loading