generouted - npm Package Compare versions

Comparing version 1.7.0 to 1.7.1

package.json

 {
   "name": "generouted",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "description": "Generated client-side file-based routes for Vite",
@@ -5,0 +5,0 @@ "author": "Omar Elhawary <[e-mail]> (https://omarelhawary.me)",

readme.md

@@ -53,2 +53,6 @@ <br>
 
+### React Router plugin with navigation type-safety 🆕
+
+[Check out the docs here](./plugins/react-router)
+
 ### React Location
@@ -207,2 +211,41 @@
 
+### Pathless layout groups 🆕
+
+By wrapping a directory name with `()`: `src/pages/(app)/...`
+
+```shell
+src/pages/
+├── (app)/
+│   ├── _layout.tsx
+│   ├── dashboard.tsx      →  /dashboard      wrapped by (app)/_layout.tsx
+│   └── item.tsx           →  /item           wrapped by (app)/_layout.tsx
+├── (marketing)/
+│   ├── _layout.tsx
+│   ├── about.tsx          →  /about          wrapped by (marketing)/_layout.tsx
+│   └── testimonials.tsx   →  /testimonials   wrapped by (marketing)/_layout.tsx
+└── admin/
+    ├── _layout.tsx
+    └── index.tsx          →  /admin          wrapped by admin/_layout.tsx
+```
+
+### Optional route segments 🆕
+
+By prefixing a minus sign `-` to a segment; meaning this segment can be subtracted/removed from route url:
+
+- `src/pages/-some/thing.tsx` → `/some?/thing`
+- `src/pages/-[param]/another.tsx` → `/:param?/another`
+
+React Router [v6.5.0+](https://github.com/remix-run/react-router/releases/tag/react-router@6.5.0) supports regular and dynamic optional route segments:
+
+```shell
+src/pages/-en/about.tsx  →  /en?/about            /en/about and /about
+src/pages/-[lang]/about.tsx  →  /:lang?/about     /en/about, /fr/about, /about
+```
+
+However other integration might only support optional dynamic segments:
+
+```shell
+src/pages/-[lang]/about.tsx  →  /:lang?/about     /en/about, /fr/about, /about
+```
+
 ### Ignored routes - co-locating non-pages files inside the pages directory
@@ -242,3 +285,3 @@
 
-### TanStack React Router
+### TanStack React Router 🆕
 
@@ -258,2 +301,3 @@ - [Basic](./examples/tanstack-react-router/basic)
 - [Nested layouts](./examples/react-router/nested-layouts)
+- [Plugin](./examples/react-router/plugin) 🆕
 
@@ -260,0 +304,0 @@ ### Solid Router

No alert changes

Improved metrics

Total package byte prevSize

18404

increased by9.5%

Number of lines in readme file

309

increased by16.6%

No dependency changes