This module provides route helpers that support the automatic selection of alternative routes. These helpers can serve as drop-in replacements for Phoenix's default route helpers.

Use this extension only if your application leverages extensions that generate alternative routes. Otherwise, the result will be identical to the official helpers provided by Phoenix.

Configuration

In versions of Phoenix prior to 1.7, an alias Routes was created by default. You can either replace this alias or add an alias for RoutexHelpers. Note that Phoenix 1.7 and later have deprecated these helpers in favor of Verified Routes.

In the example below, we override the default Routes alias to use Routex's Route Helpers as a drop-in replacement, while keeping the original helper functions available under the alias OriginalRoutes:

# file /lib/example_web.ex
defp routex_helpers do
+ alias ExampleWeb.Router.Helpers, as: OriginalRoutes
+ alias ExampleWeb.Router.RoutexHelpers, as: Routes
end

Pseudo Result

When alternative routes are created, auto-selection is used to keep the user within a specific branch.

Example in a (h)eex template:

<a href={Routes.product_index_path(@socket, :show, product)}>Product #1</a>

Result after compilation:

case alternative do
   nil ⇒  "/products/#{product}"
  "en" ⇒  "/products/#{product}"
  "nl" ⇒  "/europe/nl/products/#{product}"
  "be" ⇒  "/europe/be/products/#{product}"
end

Routex.Attrs

Requires:

• None

Sets:

• None