Skip to content

Commit

Permalink
Merge pull request #45 from VGVentures/fix/links
Browse files Browse the repository at this point in the history
fix: links and formatting
  • Loading branch information
jolexxa authored Aug 14, 2024
2 parents bccb5d5 + 426c086 commit 5fb41a1
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 15 deletions.
32 changes: 23 additions & 9 deletions src/content/docs/examples/airplane_entertainment_system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@ title: 🛫 Airplane Entertainment System
description: A sample project that simulates an airplane entertainment system.
---

import { Image, Picture } from 'astro:assets';
import airplaneEntertainmentSystemScreenshot from './images/airplane_entertainment_system.png';
import flightTrackers from './images/flight_tracker.png';
import transitionAnimation from './images/transition_animation.gif';
import { Image, Picture } from "astro:assets";
import airplaneEntertainmentSystemScreenshot from "./images/airplane_entertainment_system.png";
import flightTrackers from "./images/flight_tracker.png";
import transitionAnimation from "./images/transition_animation.gif";

The Airplane Entertainment System simulates an in-flight entertainment system that provides mock flight progress updates, weather, and an audio player.

<Image src={airplaneEntertainmentSystemScreenshot} alt="Screenshot of the Airplane Entertainment FileSystem." />
<Image
src={airplaneEntertainmentSystemScreenshot}
alt="Screenshot of the Airplane Entertainment FileSystem."
/>

The source code for this project is available on [GitHub](https://github.com/VGVentures/airplane_entertainment_system). To view the live demo, click [here](https://cuddly-doodle-kgvmnp1.pages.github.io/).

Expand All @@ -20,7 +23,11 @@ The Airplane Entertainment System was built using [layered architecture](../../a

### Flight Tracker

<Image src={flightTrackers} alt="Screenshot of the flight tracker." width="500" />
<Image
src={flightTrackers}
alt="Screenshot of the flight tracker."
width="500"
/>

The flight tracker simulates a flight between Newark and New York City, providing updates on the flight's progress every minute. The flight is scheduled to take off at 1:00 PM and is estimated to take 45 minutes, but the simulated delays can change the arrival time. For simplicity, a timestamp is included in the API response that begins at 1:00 PM and is incremented by one minute for each update.

Expand All @@ -47,7 +54,7 @@ The [Flight Information Repository](https://github.com/VGVentures/airplane_enter
return _flightController!.stream;
}
```
```

:::tip
Notice that we are using a [BehaviorSubject](https://pub.dev/documentation/rxdart/latest/rx/BehaviorSubject-class.html) here from the [rxdart](https://pub.dev/packages/rxdart) package as a stream controller. Since the repository could be used to cache the data, the BehaviorSubject is used to provide the last emitted value to any new listeners.
Expand Down Expand Up @@ -83,6 +90,7 @@ The Airplane Entertainment System uses bottom and side navigation bars to switch
],
)
```

The `HomeScreenRouteData` class is the route to our [AirplaneEntertainmentSystemScreen](https://github.com/VGVentures/airplane_entertainment_system/blob/main/lib/airplane_entertainment_system/view/airplane_entertainment_system_screen.dart) widget, which is the container for our navigation bars and content.

```dart
Expand Down Expand Up @@ -110,6 +118,7 @@ class HomeScreenRouteData extends StatefulShellRouteData {
}
}
```

:::note
The `routes.dart` file is used to create the generated routing code. Notice that the `static` `$navigatorContainerBuilder` function is added here so it can be provided to the `StatefulShellRoute` when the code is generated. More information about the `navigatorContainerBuilder` can be found in the [StatefulShellRoute Transition Animations](#statefulshellroute-transition-animations) section below.
:::
Expand Down Expand Up @@ -148,7 +157,11 @@ class MusicPlayerPageRouteData extends GoRouteData {

### StatefulShellRoute Transition Animations

<Image src={transitionAnimation} alt="Transition animation when switching between tabs." width="300" />
<Image
src={transitionAnimation}
alt="Transition animation when switching between tabs."
width="300"
/>

To add custom transition animations to your routes that are in the same navigation stack, override the `GoRouteData`'s `pageBuilder` method. Your custom animation will then be used anytime you navigate to that route.

Expand Down Expand Up @@ -220,6 +233,7 @@ navigationShell.goBranch(
index == navigationShell.currentIndex,
);
```

:::note
Setting the `initialLocation` parameter to `true` will set the route to the initial location. This is sometimes the desired behavior when the user selects the tab that is already active.
:::
:::
2 changes: 1 addition & 1 deletion src/content/docs/examples/financial_dashboard.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: 📈 Financial Dashboard
description: A sample project that simulates a financial dashboard.
---
---
2 changes: 1 addition & 1 deletion src/content/docs/examples/vehicle_cockpit.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: 🏎 Vehicle Cockpit
description: A sample project that simulates a vehicle cockpit.
---
---
8 changes: 4 additions & 4 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ hero:
link: /architecture
icon: right-arrow
variant: primary
- text: Read the Starlight docs
link: https://starlight.astro.build
- text: Learn more about Very Good Ventures
link: https://verygood.ventures
icon: external
---

Expand All @@ -31,7 +31,7 @@ import { Card, CardGrid } from "@astrojs/starlight/components";
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
<Card title="Visit Our Website" icon="open-book">
Learn more about [Very Good Ventures](https://verygood.ventures/).
</Card>
</CardGrid>

0 comments on commit 5fb41a1

Please sign in to comment.