API Reference Phoenix Routes Extension Framework v0.1.0-alpha.6

modules

Modules

use Routex

When use'd this module generates a Routext backend module and a configuration struct using the configure/2 callbacks of the extensions provided in opts.

Provides an interface to access and update Routex attributes.

Specification for composable Routex extensions.

Creates helper functions to get a list of alternative slugs and their routes attributes given a binary url or a list of path segments and a binary url.

Creates alternative routes based on scopes configured in a Routex backend module. Scopes can be nested and each scope can provide Routex.Attrs to be shared with other extensions.

Module to create and validate a Config struct

Raised when the custom attributes of scopes do not have the same keys.

Raised when the scope map does not start with the root scope "/".

Struct for flattened scope

Struct for scope with optionally nested scopes

Extracts Routex.Attrs from the 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. This way the attributes for route can be lazily loaded.

Transforms routes to be unrecognizable.

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.

Provides route generation with compile-time verification.

Provides utility funtions for extension development.

Provides functions that work with both a binary path and a list of segments; unless explicitly stated otherwise.

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 Phoenix Routes

Provides macro (callbacks) to alter route definition before compilation.