flutter_web_preloader - GitLite

KO | EN

gitlite — search

#python #react #ai #go #golang #android #rust #deep-learning #linux #macos #kubernetes #vue #awesome-list #open-source

flutter_web_preloader

(★ 76)

A brick that creates a smart web entrypoint for Flutter and preloads any type of asset before starting an app.

File Explorer

Download Latest Version (.zip)

- - bug_report.yaml
  - build.yaml
  - chore.yaml
  - ci.yaml
  - config.yml
  - documentation.yaml
  - feature_request.yaml
  - performance.yaml
  - refactor.yaml
  - revert.yaml
  - style.yaml
  - test.yaml
- - ci.yaml
  - hooks.yaml
  - publish_flutter_web_preloader.yaml
  - sync_labels.yaml
- CODEOWNERS
- cspell.json
- dependabot.yaml
- PULL_REQUEST_TEMPLATE.md
- - flutter_bootstrap.js
  - index.html
- - pre_gen_test.dart
- analysis_options.yaml
- pre_gen.dart
- pubspec.yaml
- release_ready.sh
.gitignore
brick.yaml
CHANGELOG.md
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# flutter_web_preloader

[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
[![Available on Brickhub][brickhub_badge]][brickhub_link]

> **DEPRECATED:** This brick has been discontinued. The web preloading functionality has been moved into the [`flame_game`][flame_game_template] template in [very_good_templates][very_good_templates]. New projects should use `very_good create flame_game` instead.
>
> If you already generated your `web/index.html` using this brick, it will continue to work — no migration is needed. This repository will no longer receive updates.

---

A brick that creates a smart web entrypoint for Flutter and preloads any type of asset before starting an app.

_Generated by [mason][1] 🧱_

## Flutter Web Preloader

This brick will override the default `web/index.html` that is created with a web Flutter project.

The `index.html` file generated by this brick will add additional JavaScript code
in order to preload assets used by the Flutter app. Ensuring that when the app is
presented to the user, the assets are already cached by the browser. Doing so prevents
the application from loading piece by piece.

While the assets are being preloaded, a progress bar will be presented
to the user.

## Variables

| Name                  | Description                                     | Default value                                 |
| --------------------- | ----------------------------------------------- | --------------------------------------------- |
| `project_title`       | The title of the project                        | `name` attribute in the `pubspec.yaml`        |
| `project_description` | The project description                         | `description` attribute in the `pubspec.yaml` |
| `batch_size`          | How many assets will be loaded at the same time | `20`                                          |

## FAQ

### Can I customize the progress bar?

Yes, the progress bar can be customized. The generated `web/index.html` has a content division element (`div`) with an identifier of `progress-indicator`. This element can be styled using Cascading Style Sheets (CSS).
For example, we can change the `background-color` to red by doing:

```html
<div
  id="progress-bar"
  style="border: 1px solid blue; width: 250px; height: 50px;"
>
  <div
    id="progress-indicator"
    style="background-color: red; height: 100%; width: 0%;"
  ></div>
</div>
```

### What would be the optimal `batch_size`?

The `batch_size` depends on the number and average size of your assets.

The `batch_size` can be increased when the average size of the assets is small, since the requests will finish sooner. However, keep in mind that a large `batch_size` may trigger too many requests at the same time and it may cause unexpected issues in the browser.
On the other hand, the `batch_size` should be decreased when the size of the assets are large.

The default `batch_size` is `20`, this should be a good number for most projects. It is not too high to cause unexpected browser issues, but also not low enough to cause the loading to take too much time.

In any case, we advise on testing when changing this value to make sure that it
won't break your app.

[1]: https://github.com/felangel/mason
[brickhub_badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fbit.ly%2Fflutter-web-preloader
[brickhub_link]: https://brickhub.dev/bricks/flutter_web_preloader/
[flame_game_template]: https://github.com/VeryGoodOpenSource/very_good_templates/tree/main/flame_game
[very_good_templates]: https://github.com/VeryGoodOpenSource/very_good_templates