← Recipes

阅读中文版本

Show Skeleton Placeholders During Data Fetch

Render a skeleton that matches the layout so the user sees structure immediately and there is no layout shift when data arrives.

~15 minfrontendloadingskeleton

Task

Add { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } so the interface remains usable and accessible under the edge cases that manual testing skips.

When to use this

A screen reader user reports the page is unusable because { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } was never implemented, flagged in a support ticket.

Prerequisites

  • A frontend component or page in the codebase
  • A build with the relevant framework configured

Steps

1. Configure { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } in the project configuration file with the recommended defaults.

{ isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> }

Expected output: The configuration is accepted and { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } runs without errors on the first invocation.

2. Run the check locally to verify { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } blocks merge on failure.

- name: Run add skeleton loading placeholder
  run: pnpm test

Expected output: Pull requests with failing { isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> } are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Handle the edge case

Start by measuring the problem. Render a skeleton that matches the layout so the user sees structure immediately and there is no layout shift when data arrives. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run { isLoading ? : } against the current codebase and inspect the output before wiring it into CI.

{ isLoading ? <Skeleton rows={5} /> : <DataList items={data} /> }

Test with real tools

Once the gate is in place, make failures actionable. A failing { isLoading ? : } should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.