View Source API Reference Routex v1.1.0
Modules
Provides an interface to access and update Routex attributes.
use Routex.Backend
When use'd this module generates a Routex backend module and
a configuration struct using the configure/2 callbacks of
the extensions provided in opts.
Provides a function to build branched variants of macro's
Provides functions to aid during development
Specification for composable Routex extensions.
Creates helper functions to get a list of maps alternative slugs and their Routex.Attrs
by providing a binary url. Sets match?: true for the url matching record.
Creates alternative routes based on branches configured in a Routex backend
module. Branches can be nested and each branch can provide Routex.Attrs to be shared
with other extensions.
Struct for flattened branch
Struct for branch with optionally nested branches
Module to create and validate a Config struct
Raised when the custom attributes of branches do not have the same keys.
Raised when the branch map does not start with the root branch "/".
Extracts Routex.Attrs from a route and makes them available in components
and controllers with the assigns operator @ (optionally under a namespace).
Creates helper functions to get the Routex.Attrs given a binary url or a
list of path segments. Use this to lazy load attributes instead of adding them
upfront to assigns.
Adapter for projects using :ex_cldr. It generates the configuration
for Routex.Extension.Alternatives.
Transforms routes to be unrecognizable.
A route may be defined with a routes Routex.Attrs interpolated
into it. These interpolations are specified using the usual #{variable}
interpolation syntax. Unlike some other routing solutions, interpolation
is not restricted to the beginning of routes.
Raised when a list of routes contains routes with the same path and verb.
Provides route helpers with support for automatic selecting alternatives routes. The helpers can be used to override Phoenix' defaults as they are a drop-in replacements.
Enables users to enter URLs using localized terms which can enhance user engagement and content relevance.
Supports the use of original route paths in controllers and templates while rendering transformed route paths at runtime without performance impact.
Matchables are an essential part of Routex. They are used to match run time routes with compile time routes and enable reordered route segments.
This module provides everything needed to process Phoenix routes. It executes
the transform callbacks from extensions to transform Phoenix.Router.Route
structs and create_helpers callbacks to create one unified Helper module.
Function for working with Routex augmented Phoenix Routes
Provides macro (callbacks) to alter route definition before compilation.
Provides an interface to functions which can be used in extensions.