Skip to content

HACKING.md

Latest commit

 

History

History
49 lines (32 loc) · 2.3 KB

HACKING.md

File metadata and controls

49 lines (32 loc) · 2.3 KB

Testing

There are a number of subtle features that need to be tested manually on each release (or we need to come up with unit tests that can test them).

Settling

zero-virtual supports the concept of settling. The scroller "settles" when there's been no scrolling OR change in the listContext (what list is being displayed) for settleTime ms.

  • load the demo app and wait 2s, you should see 'settled' in the console
  • load the demo app and immediately scroll slowly for 5s, then stop. you should see 'settled' 2s after you stop.
  • load the demo app and immediately list queries with await __zero.inspector.client.queries(). you should see one query with ttl:none.
  • load the demo app and wait 2s. then list queries. you should see one query with ttl:5m.
  • load the demo app and wait 2s. slowly scroll down for 5s then stop. wait for 'settled' in console. list queries. you should see only two queries, both ttl:5m.

Scroll State

zero-virtual has the ability to save and restore scroll state via the scrollState and onScrollStateChange params. The demo app exercises this feature using the built-in useHistoryScrollState hook.

When you scroll down the list and reload, the list should be reloaded exactly where you were, even if you scroll down quite far.

If you look at open queries after reload you should see only two, it shouldn't load a bunch of queries to get back to the scroll state.

If you type a new URL into the tab while looking at the demo to navigate away, then press 'back' to go back to the demo, it should load scrolled where you were.

Permalinks

zero-virtual supports permalinks.

Note: This part is currently a little broken, see #21.

  • Click on any of the items in the demo.
  • Reload.
  • It should load with that item at the top of list and highlighted.
  • This should work even if the item you loaded was far down the list.
  • When you check queries after load you should only see three: one to find the item and two for the prev/next pages.

Releasing

Releases are published to npm automatically via CI when a version tag is pushed. To cut a new patch release:

git checkout main
git reset --hard origin/main
pnpm version patch
git push
git push --tags

Use pnpm version minor or pnpm version major for larger releases.