shelving 1.323.3 → 1.325.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/docs/guides/building-with-shelving.md +3 -3
  2. package/docs/llms-full.txt +412 -149
  3. package/docs/react/SequenceTransitionOptions.md +26 -0
  4. package/docs/react/useSequenceTransition.md +71 -0
  5. package/docs/react.md +2 -0
  6. package/docs/ui/BackButton.md +1 -1
  7. package/docs/ui/Head.md +1 -1
  8. package/docs/ui/HorizontalTransition.md +1 -1
  9. package/docs/ui/Meta.md +2 -0
  10. package/docs/ui/Navigation.md +19 -17
  11. package/docs/ui/NavigationContext.md +2 -2
  12. package/docs/ui/NavigationDirection.md +12 -0
  13. package/docs/ui/NavigationEntryState.md +3 -3
  14. package/docs/ui/NavigationEvent.md +28 -0
  15. package/docs/ui/{NavigationStore → NavigationSequence}/back.md +6 -5
  16. package/docs/ui/NavigationSequence/committed.md +13 -0
  17. package/docs/ui/NavigationSequence/current.md +13 -0
  18. package/docs/ui/{NavigationStore → NavigationSequence}/forward.md +4 -4
  19. package/docs/ui/{NavigationStore → NavigationSequence}/history.md +3 -3
  20. package/docs/ui/{NavigationStore → NavigationSequence}/listen.md +3 -3
  21. package/docs/ui/NavigationSequence/publish.md +14 -0
  22. package/docs/ui/{NavigationStore → NavigationSequence}/replace.md +4 -4
  23. package/docs/ui/NavigationSequence.md +187 -0
  24. package/docs/ui/RouteCache.md +16 -15
  25. package/docs/ui/RouteCacheProps.md +1 -1
  26. package/docs/ui/Router.md +2 -2
  27. package/docs/ui/Transition.md +1 -1
  28. package/docs/ui/VerticalTransition.md +1 -1
  29. package/docs/ui/isKeyboardOpen.md +27 -0
  30. package/docs/ui/mergeMeta.md +1 -0
  31. package/docs/ui/requireContext.md +1 -1
  32. package/docs/ui/requireNavigation.md +3 -3
  33. package/docs/ui/waitForKeyboard.md +29 -0
  34. package/docs/ui.md +8 -6
  35. package/package.json +1 -1
  36. package/react/index.d.ts +1 -0
  37. package/react/index.js +1 -0
  38. package/react/useSequenceTransition.d.ts +45 -0
  39. package/react/useSequenceTransition.js +56 -0
  40. package/ui/page/Head.d.ts +1 -1
  41. package/ui/page/Head.js +9 -4
  42. package/ui/page/Head.tsx +8 -4
  43. package/ui/router/BackButton.js +6 -3
  44. package/ui/router/BackButton.md +1 -1
  45. package/ui/router/BackButton.tsx +6 -3
  46. package/ui/router/Navigation.d.ts +6 -5
  47. package/ui/router/Navigation.js +36 -49
  48. package/ui/router/Navigation.md +13 -12
  49. package/ui/router/Navigation.tsx +37 -59
  50. package/ui/router/NavigationContext.d.ts +7 -15
  51. package/ui/router/NavigationContext.js +4 -13
  52. package/ui/router/NavigationContext.tsx +7 -17
  53. package/ui/router/{NavigationStore.d.ts → NavigationSequence.d.ts} +93 -51
  54. package/ui/router/{NavigationStore.js → NavigationSequence.js} +132 -80
  55. package/ui/router/NavigationSequence.md +129 -0
  56. package/ui/router/{NavigationStore.test.ts → NavigationSequence.test.ts} +126 -61
  57. package/ui/router/{NavigationStore.tsx → NavigationSequence.tsx} +160 -92
  58. package/ui/router/RouteCache.d.ts +8 -7
  59. package/ui/router/RouteCache.js +34 -29
  60. package/ui/router/RouteCache.md +9 -8
  61. package/ui/router/RouteCache.tsx +39 -36
  62. package/ui/router/Router.d.ts +2 -2
  63. package/ui/router/Router.js +3 -5
  64. package/ui/router/Router.md +1 -1
  65. package/ui/router/Router.tsx +4 -5
  66. package/ui/router/StackButton.d.ts +1 -1
  67. package/ui/router/StackButton.js +5 -7
  68. package/ui/router/StackButton.tsx +6 -7
  69. package/ui/router/index.d.ts +1 -1
  70. package/ui/router/index.js +1 -1
  71. package/ui/router/index.ts +1 -1
  72. package/ui/transition/HorizontalTransition.md +1 -1
  73. package/ui/transition/Transition.md +1 -1
  74. package/ui/transition/VerticalTransition.md +1 -1
  75. package/ui/util/index.d.ts +1 -0
  76. package/ui/util/index.js +1 -0
  77. package/ui/util/index.ts +1 -0
  78. package/ui/util/keyboard.d.ts +24 -0
  79. package/ui/util/keyboard.js +82 -0
  80. package/ui/util/keyboard.test.ts +12 -0
  81. package/ui/util/keyboard.ts +81 -0
  82. package/ui/util/meta.d.ts +2 -0
  83. package/ui/util/meta.ts +2 -0
  84. package/ui/util/requireContext.md +1 -1
  85. package/docs/ui/NavigationPosition.md +0 -24
  86. package/docs/ui/NavigationPositionContext.md +0 -8
  87. package/docs/ui/NavigationStore.md +0 -164
  88. package/ui/router/NavigationStore.md +0 -110
@@ -551,7 +551,7 @@ Each tab keeps its own stack of pages, and its back button goes back within that
551
551
  3. Put `<BackButton href="/home" />` in each page header. It goes back in the current tab, or to `href` when there is no page before.
552
552
  4. Use `<RouteCache>`, so each tab shows the page you left it on.
553
553
 
554
- Use `className="replace"` on in-page tab links (for example `/dave/posts` and `/dave/likes`), so they change the URL without a new page. See `<Navigation>`, `NavigationStore`, `<StackButton>` and `<BackButton>`.
554
+ Use `className="replace"` on in-page tab links (for example `/dave/posts` and `/dave/likes`), so they change the URL without a new page. See `<Navigation>`, `NavigationSequence`, `<StackButton>` and `<BackButton>`.
555
555
 
556
556
  #### Hide the tab bar on some pages
557
557
 
@@ -921,7 +921,7 @@ If every file in that list is in the right place, the client and server share on
921
921
  3. **Remove `<RouteConfig>`.** `<RouteConfig>` and `RouteContext` are removed.
922
922
  - `<RouteConfig path>` kept a page mounted for its tabs (for example `/dave/{tab}`). Instead, add `className="replace"` to each in-page tab link: `<Button href="/dave/posts" className="replace">Posts</Button>`. A replace keeps the same page mounted, with no slide and no new history entry.
923
923
  - `<RouteConfig cache={false}>` unmounted a create form when you left it. Instead, clear the form after a successful submit: change the `key` of the `<Form>`, or call `form.reset()` on a plain HTML form. See `<RouteCache>` for an example.
924
- 4. **Canonical URLs.** `<Head>` no longer writes browser history itself. When a page renders a `<Head>` with a `url` that is not the current URL, `<Head>` calls `NavigationStore.replace()`. You do not need to change anything, but do not also call `window.history.replaceState()` for it.
924
+ 4. **Canonical URLs.** `<Head>` no longer writes browser history itself. When a page renders a `<Head>` with a `url` that is not the current URL, `<Head>` calls `NavigationSequence.replace()`. You do not need to change anything, but do not also call `window.history.replaceState()` for it.
925
925
  5. **Add stacks (optional).** For an app with a tab bar, set `stacks` on `<Navigation>` to the root path of each tab, in tab order: `<Navigation stacks={["/home", "/discover", "/profile"]}>`. Each link then opens a new page in the current tab, wherever it points. Set `stack` on `<Navigation>` to the stack the app opens in. With no `stack`, the page floats (its stack is `null`): it is outside every tab, so no tab is selected until the user taps a tab, or the app names a stack. Deep links and login pages float. `/` is a normal stack root, so a Home tab can be `/`. A login page calls `nav.replace("/home", "/home")` to send the user into the Home tab.
926
926
  6. **Use the new buttons (optional).**
927
927
  - `<StackButton stack="/home">` is a tab bar button. It goes to the page you left in that tab, goes back to the tab's root when you are already in it, and scrolls to the top at the root.
@@ -936,7 +936,7 @@ What changes for users:
936
936
  - The browser back button walks the history as before, across tabs. The page slides the right way.
937
937
  - When you go back from a page, it leaves the cache. So the browser forward button then shows that page fresh, from the top.
938
938
 
939
- See `<Navigation>`, `NavigationStore`, `<RouteCache>`, `<StackButton>` and `<BackButton>` for the full details.
939
+ See `<Navigation>`, `NavigationSequence`, `<RouteCache>`, `<StackButton>` and `<BackButton>` for the full details.
940
940
 
941
941
  ### Layouts are frames
942
942