Files
yellowjacket/frontend
logan 3479ae8d39
CI / check (push) Skipped
CI / e2e (push) Skipped
CI / check (pull_request) Successful in 2m46s
CI / e2e (pull_request) Successful in 10m13s
feat(ui): warm album art ahead of the scroll
Scrolling the albums grid pops art in: the cards already draw the
smallest adequate tier and are already lazy, so what was left is *when*
the request happens. The grids are virtualized, so the `<img>` — and
therefore the fetch — does not exist until the virtualizer renders its
card, which is about 1000px past the viewport, or two screens on the
reference device.

The issue asks for a larger overscan and that is not available:
`_overhang` is a hard-coded `protected` field on `BaseLayout` with no
configuration surface. So the request is issued ahead of the element
instead. `utils/image-prefetch.ts` warms a bounded window either side
of the rendered range, from `rangeChanged` rather than
`visibilityChanged` — the two report different ranges, and a window
measured from what is *visible* is spent on cards that already exist.

Cover and artist URLs are served under `Cache-Control: immutable`
(content-hashed filenames), so a prefetched image is a cache hit by the
time its card is drawn. The bytes are the browser's; what this holds is
the set of URLs asked for, capped and reported to `__yjCacheStats()`.

Measured on the bulk seed (4 988 albums), ten 2 400px jumps, covers in
the viewport with `naturalWidth === 0`: 254 of 258 blank one frame
after the jump and 214 two frames after, against 117 and 77 with the
prefetch.

Closes #65
2026-08-25 13:55:43 -04:00
..
2025-03-28 11:43:14 -05:00

YellowJacket Frontend

This directory contains the frontend for YellowJacket.

Dependencies

There are a couple of tools that are required to build and use the frontend.

  • vite for
    • transpiling typescript
    • bundling the final "package" that is useb by the webview
    • running a dev server with hot-reloading
    • configured with the vite.config.ts file in this directory
  • pnpm for managing frontend dependency packages

There are a handful of dependency packages that we use directly in the frontend.

Lastly, there are some dependencies that only benefit development

  • tsserver comes bundled with vscode and can be used as an LSP with other editors using typescript-language-server
    • Used for autocomplete, syntax highlighting, etc.
    • This can be configured with the tsconfig.json file in the root of the project
      • NOTE: your configuration should align with the vite config so you get in-editor feedback that aligns with how the build will be done.

Development

Ideally, you would use the frontend in the wails app as the frontend depends on the Go bindings generated by Wails. You can do this by running wails dev in the root of the YellowJacket repo.

If you want to run the frontend standalone, make sure the Wails go bindings have been generated with wails generate modules. Then, you can run pnpm dev to run the vite dev server. For more information on what commands are available, refer to package.json.

Code

Web Components

Our frontend is based off of Web Components, a standard that provides native browser encapsulation of components that can include HTML, CSS and Javascript all together. Instead of writing these components manually in Javascript, we utilize lit as a wrapper library.

Typescript

To better integrate with our tooling and to provide a better developer experience with strong typing, we have written all functional frontend code in Typescript. Vite serves as our Typescript transpiler.

Important Files and Directories

NOTE: most of these directories have aliases defined in tsconfig.json and vite.config.ts so that we may refer to them by shorthand when importing.

  • index.html and index.js is the entrypoint for the frontend. The first page that loads.
  • wailsjs/go Go code bindings generated by wails reside here
  • wailsjs/runtime the Wails runtime code needed to use Wails features
  • src all app code resides here
  • src/assets static assets like fonts, images and icons
  • src/components lit components that are used to compose the application
  • src/pages pages that serve as other entrypoints for the application that can be navigated to