🗺 Optional Route Segments

[ryanflorence]

Allow route paths to include optional segments like /foo/:bar?.

Progress

• RFC - 🗺️ RFC: Optional Route Segments #9550
• Router PR - feat: optional params and static segments #9650
• Router PR (fixes feat: optional params and static segments #9650) - fix: explode optional segments for relative paths in nested routes #9684
• Remix PR - feat: remix optional segments remix#4706
• Changeset - chore: edit the optional segments changeset remix#4815

Related Issues

• V6: Optional parameters #7285
• [Feature]: Optional routing parameters in v6 #8381
• [v6] concerning optional URL params #8566
• Optional URL parameters #9208

Docs

• Update docs
• Update migration guides that mention manual writing out the routes
  • one in the docs
  • also this discussion Official v5 to v6 Migration Guide #8753
  • Go into both and just use optional segments instead of talking about v6 not supporting them anymore

[pcattori]

I've been working through some fixes to #9650 to account for nested <Route>s. @brophdawg11 and I have been coordinating and the decision is to add some tests for nested <Route>s and to explode each relative path (with 1+ optional path segment) encountered in flattenRoutes.

PR: #9684

[pcattori]

Just waiting for Remix to be on RR 6.5 before merging the last PR (#4706) and closing out this roadmap item.

All code PRs have been merged. We just need to wait for Remix to be on RR 6.5 to update the docs.

[ryanflorence]

awesome! we'll leave this issue open until we're on router 6.5 :)

[ryanflorence]

All of this is going out in the next Remix/Router releases.

[brophdawg11]

This is available for beta testing in Remix 1.9.0-pre.0 and React Router 6.5.0-pre.1 if anyone wants to give it a test! We're hoping to get the stable releases out later today or tomorrow.