@trackunit/react-router-components 0.0.0-stage → 1.0.3

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 (60) hide show
  1. package/README.md +40 -2
  2. package/index.cjs.js +1102 -0
  3. package/index.d.ts +1 -0
  4. package/index.esm.js +1094 -0
  5. package/migrations/entry.js +3 -0
  6. package/migrations/entry.js.map +1 -0
  7. package/migrations.json +3 -0
  8. package/package.json +23 -3
  9. package/src/Breadcrumb/Breadcrumb.d.ts +39 -0
  10. package/src/Breadcrumb/Breadcrumb.variant.d.ts +45 -0
  11. package/src/Breadcrumb/BreadcrumbContainer.d.ts +8 -0
  12. package/src/Breadcrumb/BreadcrumbForLargeScreen.d.ts +6 -0
  13. package/src/Breadcrumb/BreadcrumbForMediumScreen.d.ts +6 -0
  14. package/src/Breadcrumb/BreadcrumbForSmallScreen.d.ts +6 -0
  15. package/src/Breadcrumb/BreadcrumbItem.d.ts +6 -0
  16. package/src/Breadcrumb/utils/types.d.ts +26 -0
  17. package/src/Breadcrumb/utils/useBreadcrumbItemsToRender.d.ts +6 -0
  18. package/src/RouteLink/RouteLink.d.ts +17 -0
  19. package/src/index.d.ts +6 -0
  20. package/src/persistence/readPrimitiveSearchParam.d.ts +8 -0
  21. package/src/persistence/usePersistedState.d.ts +117 -0
  22. package/src/persistence/useSearchParamSync.d.ts +17 -0
  23. package/src/persistence/useUrlParamSync.d.ts +71 -0
  24. package/src/translation.d.ts +30 -0
  25. package/src/useCursorUrlSync/useCursorUrlSync.d.ts +23 -0
  26. package/src/useRouterDrawer/useRouterDrawer.d.ts +100 -0
  27. package/translation.cjs.js +8 -0
  28. package/translation.esm.js +6 -0
  29. package/translation10.cjs.js +8 -0
  30. package/translation10.esm.js +6 -0
  31. package/translation11.cjs.js +8 -0
  32. package/translation11.esm.js +6 -0
  33. package/translation12.cjs.js +8 -0
  34. package/translation12.esm.js +6 -0
  35. package/translation13.cjs.js +8 -0
  36. package/translation13.esm.js +6 -0
  37. package/translation14.cjs.js +8 -0
  38. package/translation14.esm.js +6 -0
  39. package/translation15.cjs.js +8 -0
  40. package/translation15.esm.js +6 -0
  41. package/translation16.cjs.js +8 -0
  42. package/translation16.esm.js +6 -0
  43. package/translation17.cjs.js +8 -0
  44. package/translation17.esm.js +6 -0
  45. package/translation2.cjs.js +8 -0
  46. package/translation2.esm.js +6 -0
  47. package/translation3.cjs.js +8 -0
  48. package/translation3.esm.js +6 -0
  49. package/translation4.cjs.js +8 -0
  50. package/translation4.esm.js +6 -0
  51. package/translation5.cjs.js +8 -0
  52. package/translation5.esm.js +6 -0
  53. package/translation6.cjs.js +8 -0
  54. package/translation6.esm.js +6 -0
  55. package/translation7.cjs.js +8 -0
  56. package/translation7.esm.js +6 -0
  57. package/translation8.cjs.js +8 -0
  58. package/translation8.esm.js +6 -0
  59. package/translation9.cjs.js +8 -0
  60. package/translation9.esm.js +6 -0
package/README.md CHANGED
@@ -1,3 +1,41 @@
1
- # Temporary Holding Version
1
+ This package depends on [TanStack Router](https://tanstack.com/router): `@tanstack/react-router` is a required peer dependency.
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ # Trackunit react-router-components
4
+
5
+ The `@trackunit/react-router-components` package is the home of Trackunits public react components and hooks that are coupled to `@tanstack/react-router` (routing and URL state).
6
+ Other published `@trackunit/*` packages do not import `@tanstack/react-router` directly; router-aware code lives here.
7
+
8
+ This library is exposed publicly for use in the the Trackunit [Iris App SDK](https://www.npmjs.com/package/@trackunit/iris-app).
9
+
10
+ To browse all avaliable components visit the [Design System](https://design.iris.trackunit.com/).
11
+
12
+ AI agents should use the machine-readable index at [`/llms.txt`](https://design.iris.trackunit.com/llms.txt) instead of the Storybook HTML; it links to per-component docs at `/ai?storyId=<id>`.
13
+
14
+ For more info and a full guide on Iris App SDK Development, please visit our [Developer Hub](https://developers.trackunit.com/).
15
+
16
+ ## Router-coupled code in other packages
17
+
18
+ Published `@trackunit/*` packages are linted against direct `@tanstack/react-router` imports, including type-only imports. New router-aware components and hooks belong in this package. A few files are still exempt:
19
+
20
+ | Package | Files | Status |
21
+ | --- | --- | --- |
22
+ | `@trackunit/react-components` | `Prompt` | Temporary: moving to this package |
23
+ | `@trackunit/react-components` | `EmptyState`, `PageHeader` | Temporary: links will be passed in by the consumer |
24
+ | `@trackunit/react-table` | `ActionButton` | Temporary: links will be passed in by the consumer |
25
+ | `@trackunit/react-form-wizard` | all | Permanent |
26
+ | `@trackunit/react-core-contexts-test` | all | Permanent |
27
+ | `@trackunit/filters-filter-bar` | `useSearchUtils` | Permanent for now |
28
+
29
+ Internal (unpublished) libraries in the Trackunit monorepo are not required to follow this rule. See [Router-coupled code](https://github.com/Trackunit/manager/blob/master/docs/architecture/PUBLIC-PACKAGES.md#router-coupled-code) for the full rules.
30
+
31
+ ## Development
32
+
33
+ At this point this library is only developed by Trackunit Employees.
34
+ For development related information see the [development readme](https://github.com/Trackunit/manager/blob/master/libs/react/components/DEVELOPMENT.md).
35
+
36
+ ## Trackunit
37
+
38
+ This package was developed by Trackunit ApS.
39
+ Trackunit is the leading SaaS-based IoT solution for the construction industry, offering an ecosystem of hardware, fleet management software & telematics.
40
+
41
+ ![The Trackunit logo](https://trackunit.com/wp-content/uploads/2022/03/top-logo.svg)